@sheetxl/io-xlsx 0.8.0-beta.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +8 -7
- package/browser/esm/7rZlWcm56hn3Jmnk.mjs +7021 -0
- package/browser/esm/AZus_5slvoIVhf1u.mjs +10323 -0
- package/browser/esm/B9QfzGvsvg-V3utu.mjs +4632 -0
- package/browser/esm/{CX3yVwe-BnhCk4FY.mjs → BIR_Si489gIkGOnc.mjs} +194 -144
- package/browser/esm/BJFvc-i40R4rPZ5y.mjs +2433 -0
- package/browser/esm/{CGXxwkCRWLc0gcRQ.mjs → BX8Ebx4NC5zp7_3J.mjs} +3 -3
- package/browser/esm/{B4eKxNwxJjHLN126.mjs → Bnxw38IvtA04zXEE.mjs} +2 -2
- package/browser/esm/{DwcLXqv8-6Tl1zLO.mjs → CfVhYH77KdrR3fEK.mjs} +3 -3
- package/browser/esm/index.mjs +3 -4
- package/browser/esm/jIQks3Crw6jehdDU.mjs +2474 -0
- package/browser/esm/{DUi-V-E_AJwTIqlO.mjs → qc9hnuR2z-whY8YO.mjs} +3 -3
- package/browser/esm/wZGpmkMUubNjClhG.mjs +104 -0
- package/licenses/dependencies.txt +2 -2
- package/node/esm/{C51yFT2l-6il_xXO.mjs → BNLHWJHyy5eB0P_4.mjs} +2 -2
- package/node/esm/CVtsY2F9A9NzEGLk.mjs +2478 -0
- package/node/esm/CoeQ0LO-nNXiowwv.mjs +7284 -0
- package/node/esm/CxY3iIYLXVhCebeV.mjs +4746 -0
- package/node/esm/D2CZy9TQM9h2uqBh.mjs +2562 -0
- package/node/esm/{CMq7eF1vxibUumqT.mjs → Dm0hvKcR4xb0TV_N.mjs} +3 -3
- package/node/esm/_IA1gQ-zFQYQSZSs.mjs +6957 -0
- package/node/esm/index.mjs +65 -28
- package/node/esm/{DLBm8l0jyL2fVlxg.mjs → zZFe3mW0xjmobowq.mjs} +3 -3
- package/package.json +9 -10
- package/types/src/AutoFilterRules.d.ts +85 -22
- package/types/src/ConditionalFormatRules.d.ts +2 -2
- package/types/src/DataTableFormula.d.ts +26 -0
- package/types/src/DataValidationRules.d.ts +0 -5
- package/types/src/DefinedNameAttributes.d.ts +8 -0
- package/types/src/ExcelCalcStamp.d.ts +0 -36
- package/types/src/ExcelCompat.d.ts +15 -143
- package/types/src/ExcelFunctionFacts.d.ts +0 -272
- package/types/src/ExcelReservedNames.d.ts +0 -65
- package/types/src/KnownFonts.d.ts +37 -0
- package/types/src/LegacyFormula.d.ts +1 -46
- package/types/src/OOXMLExtensions.d.ts +30 -2
- package/types/src/PageLayoutAttributes.d.ts +8 -0
- package/types/src/Plugin.d.ts +15 -3
- package/types/src/ProtectionAttributes.d.ts +2 -2
- package/types/src/SheetKinds.d.ts +42 -0
- package/types/src/SheetViewAttributes.d.ts +4 -0
- package/types/src/SortExtent.d.ts +16 -0
- package/types/src/SourcePackage.d.ts +0 -44
- package/types/src/SparklineGroups.d.ts +52 -0
- package/types/src/Types.d.ts +13 -3
- package/types/src/XlsxHeader.d.ts +19 -0
- package/types/src/chart/ChartExXml.d.ts +38 -0
- package/types/src/chart/ChartPartXml.d.ts +47 -0
- package/types/src/chart/ChartSpaceXml.d.ts +37 -0
- package/types/src/chart/_XmlTree.d.ts +34 -0
- package/types/src/chart/_chartCodecs.d.ts +12 -0
- package/types/src/chart/_chartExCodecs.d.ts +7 -0
- package/types/src/chart/_chartExFold.d.ts +14 -0
- package/types/src/chart/_chartExMarkup.d.ts +236 -0
- package/types/src/chart/_chartExStyle.d.ts +13 -0
- package/types/src/chart/_codec.d.ts +78 -0
- package/types/src/chart/_drawingml.d.ts +10 -0
- package/types/src/chart/_xml.d.ts +70 -0
- package/types/src/pivot/PivotArea.d.ts +20 -0
- package/types/src/pivot/PivotCacheRead.d.ts +30 -0
- package/types/src/pivot/PivotCacheWrite.d.ts +23 -0
- package/types/src/pivot/PivotFilters.d.ts +29 -0
- package/types/src/pivot/PivotFormats.d.ts +60 -0
- package/types/src/pivot/PivotTableRead.d.ts +44 -0
- package/types/src/pivot/PivotTableWrite.d.ts +13 -0
- package/types/src/pivot/_PivotCacheXml.d.ts +48 -0
- package/types/src/pivot/_PivotTableXml.d.ts +23 -0
- package/types/src/reader/CellControls.d.ts +18 -0
- package/types/src/reader/DocumentPropertiesRead.d.ts +16 -0
- package/types/src/reader/DummyFunctionUnwrap.d.ts +43 -23
- package/types/src/reader/HeaderStyles.d.ts +15 -0
- package/types/src/reader/IsoDateCell.d.ts +20 -0
- package/types/src/reader/LibreOfficeDataTable.d.ts +12 -0
- package/types/src/reader/PivotButtons.d.ts +14 -0
- package/types/src/reader/PivotCellFormats.d.ts +22 -0
- package/types/src/reader/SlicerJoin.d.ts +26 -0
- package/types/src/reader/ZipReader.d.ts +1 -1
- package/types/src/reader/_SlicerRecord.d.ts +59 -0
- package/types/src/reader/dom/CustGeomUtils.d.ts +7 -0
- package/types/src/reader/dom/DOMTransformer.d.ts +2 -2
- package/types/src/reader/domVisitors/AppPropertiesVisitor.d.ts +13 -1
- package/types/src/reader/domVisitors/AutoFilterVisitor.d.ts +8 -3
- package/types/src/reader/domVisitors/ColorContainerVisitor.d.ts +15 -2
- package/types/src/reader/domVisitors/CommentVisitor.d.ts +2 -2
- package/types/src/reader/domVisitors/DrawingCxnSpVisitor.d.ts +1 -0
- package/types/src/reader/domVisitors/DrawingElementVisitor.d.ts +30 -1
- package/types/src/reader/domVisitors/DrawingGraphicFrameVisitor.d.ts +9 -0
- package/types/src/reader/domVisitors/DrawingGrpSpVisitor.d.ts +14 -2
- package/types/src/reader/domVisitors/DrawingPicVisitor.d.ts +30 -2
- package/types/src/reader/domVisitors/DrawingSpVisitor.d.ts +20 -1
- package/types/src/reader/domVisitors/DrawingVisitor.d.ts +10 -0
- package/types/src/reader/domVisitors/ExternalLinkVisitor.d.ts +1 -11
- package/types/src/reader/domVisitors/FeaturePropertyBagVisitor.d.ts +18 -0
- package/types/src/reader/domVisitors/FmtSchemeVisitor.d.ts +0 -11
- package/types/src/reader/domVisitors/FontSchemeVisitor.d.ts +3 -2
- package/types/src/reader/domVisitors/FormControlPrVisitor.d.ts +9 -0
- package/types/src/reader/domVisitors/ObjectDefaultsVisitor.d.ts +11 -0
- package/types/src/reader/domVisitors/ShapeTextVisitor.d.ts +44 -0
- package/types/src/reader/domVisitors/SheetColorContainerVisitor.d.ts +2 -2
- package/types/src/reader/domVisitors/SheetStyleVisitor.d.ts +26 -5
- package/types/src/reader/domVisitors/SlicerCacheDefinitionVisitor.d.ts +11 -2
- package/types/src/reader/domVisitors/SlicersVisitor.d.ts +9 -3
- package/types/src/reader/domVisitors/SortStateVisitor.d.ts +2 -2
- package/types/src/reader/domVisitors/TextPropertiesVisitor.d.ts +13 -1
- package/types/src/reader/domVisitors/ThreadedCommentsVisitor.d.ts +2 -2
- package/types/src/reader/domVisitors/TimelinesVisitor.d.ts +13 -0
- package/types/src/reader/domVisitors/WorkbookVisitor.d.ts +0 -9
- package/types/src/reader/domVisitors/_Dxfs.d.ts +10 -0
- package/types/src/reader/domVisitors/index.d.ts +10 -36
- package/types/src/reader/saxVisitors/ContentTypesVisitor.d.ts +1 -0
- package/types/src/reader/saxVisitors/SharedStringsVisitor.d.ts +31 -6
- package/types/src/reader/saxVisitors/WorksheetVisitor.d.ts +26 -8
- package/types/src/richValue/ErrorRichValueHandler.d.ts +22 -0
- package/types/src/richValue/IRichValueHandler.d.ts +109 -0
- package/types/src/richValue/LocalImageRichValueHandler.d.ts +18 -0
- package/types/src/richValue/RichDataParts.d.ts +69 -0
- package/types/src/richValue/RichRecordWriter.d.ts +61 -0
- package/types/src/richValue/RichValueHandlers.d.ts +25 -0
- package/types/src/richValue/RichValueResolver.d.ts +54 -0
- package/types/src/richValue/WebImageRichValueHandler.d.ts +37 -0
- package/types/src/richValue/index.d.ts +7 -0
- package/types/src/utils/DrawingMLText.d.ts +39 -0
- package/types/src/utils/FormControls.d.ts +170 -0
- package/types/src/utils/SharedNames.d.ts +13 -0
- package/types/src/utils/SpreadsheetFont.d.ts +38 -0
- package/types/src/utils/VmlNoteShapes.d.ts +25 -32
- package/types/src/utils/VmlNoteStyle.d.ts +25 -0
- package/types/src/utils/VmlPrefixes.d.ts +24 -0
- package/types/src/vba/VBAProject.d.ts +0 -19
- package/types/src/writer/EvaluationSheet.d.ts +5 -0
- package/types/src/writer/builder/Emitter.d.ts +5 -0
- package/types/src/writer/builder/OpcXmlUtils.d.ts +0 -8
- package/types/src/writer/builder/PackageBuilder.d.ts +4 -41
- package/types/src/writer/builder/Types.d.ts +28 -28
- package/types/src/writer/emitters/CommentsEmitter.d.ts +3 -3
- package/types/src/writer/emitters/DrawingEmitter.d.ts +2 -2
- package/types/src/writer/emitters/ExternalLinkEmitter.d.ts +0 -11
- package/types/src/writer/emitters/FeaturePropertyBagEmitter.d.ts +8 -0
- package/types/src/writer/emitters/LegacyDrawingEmitter.d.ts +4 -4
- package/types/src/writer/emitters/PivotTableEmitter.d.ts +30 -1
- package/types/src/writer/emitters/PropsCoreEmitter.d.ts +7 -2
- package/types/src/writer/emitters/PropsCustomEmitter.d.ts +15 -0
- package/types/src/writer/emitters/RichValuePartsEmitters.d.ts +36 -0
- package/types/src/writer/emitters/RichValueRelEmitter.d.ts +12 -0
- package/types/src/writer/emitters/RichValueStructureEmitter.d.ts +4 -3
- package/types/src/writer/emitters/RichValueTypesEmitter.d.ts +3 -2
- package/types/src/writer/emitters/RichValueWebImageEmitter.d.ts +24 -0
- package/types/src/writer/emitters/SharedStringsEmitter.d.ts +6 -3
- package/types/src/writer/emitters/SlicerEmitter.d.ts +132 -0
- package/types/src/writer/emitters/StylesEmitter.d.ts +35 -2
- package/types/src/writer/emitters/TableEmitter.d.ts +14 -0
- package/types/src/writer/emitters/WorkbookEmitter.d.ts +24 -2
- package/types/src/writer/emitters/WorksheetEmitter.d.ts +4 -3
- package/types/src/writer/utils/AutoFilter.d.ts +3 -3
- package/types/src/writer/utils/CellControlComplements.d.ts +29 -0
- package/types/src/writer/utils/CustGeomUtils.d.ts +5 -0
- package/types/src/writer/utils/DateSystem.d.ts +6 -0
- package/types/src/writer/utils/DefaultRows.d.ts +22 -0
- package/types/src/writer/utils/DrawMLUtils.d.ts +42 -3
- package/types/src/writer/utils/DummyFunction.d.ts +0 -25
- package/types/src/writer/utils/DxfCollector.d.ts +14 -11
- package/types/src/writer/utils/PrstGeomUtils.d.ts +14 -0
- package/types/src/writer/utils/RichValueCollector.d.ts +81 -129
- package/types/src/writer/utils/SheetStyleLayout.d.ts +86 -0
- package/types/src/writer/utils/TextUtils.d.ts +26 -2
- package/types/src/writer/utils/UnsupportedFunctions.d.ts +2 -2
- package/types/src/writer/utils/XfVariants.d.ts +61 -0
- package/browser/cjs/17tMBnuyu4YIxixh.cjs +0 -1
- package/browser/cjs/B6sirGz6w-Bm7Ofo.cjs +0 -1
- package/browser/cjs/B7_pDFYCVzt-3hUs.cjs +0 -1
- package/browser/cjs/BxU-OlZIQViQl7gX.cjs +0 -1
- package/browser/cjs/CDs8etXnw0kbBKKv.cjs +0 -1
- package/browser/cjs/CIpMN7SDVREKQUQE.cjs +0 -6
- package/browser/cjs/CycnxkfuKrDdwoJN.cjs +0 -5
- package/browser/cjs/D3EWCPfCu-qMOIGd.cjs +0 -1
- package/browser/cjs/DHKWtqZ0vQfXrbq1.cjs +0 -2
- package/browser/cjs/MqKQ_B5qRARrRbO4.cjs +0 -24
- package/browser/cjs/index.cjs +0 -1
- package/browser/cjs/xQ6-wbTw5UzZUM1Y.cjs +0 -1
- package/browser/esm/9n64lXAgZUe3aThr.mjs +0 -159
- package/browser/esm/BsNoW41d6hdpxTTS.mjs +0 -67
- package/browser/esm/BvAptAMpZVyBCx6-.mjs +0 -2402
- package/browser/esm/CjKioy-GzeSf08f8.mjs +0 -3326
- package/browser/esm/cJxidonaVNZHAXiZ.mjs +0 -4532
- package/browser/esm/dsVZVtt5w_yLb967.mjs +0 -5300
- package/node/esm/BRQYaMYO4UfhjJHw.mjs +0 -170
- package/node/esm/BlbtH3EvAf3K4foF.mjs +0 -2450
- package/node/esm/DhSPOg9wN0kD87Tb.mjs +0 -3051
- package/node/esm/KeV-N47eTyh5YE70.mjs +0 -4642
- package/node/esm/s_yVG0m9KB14YKeN.mjs +0 -3412
- package/types/src/legacyChart/OOXMLMappings.d.ts +0 -8
- package/types/src/legacyChart/OOXMLUtils.d.ts +0 -78
- package/types/src/legacyChart/ToOOXMLConverter.d.ts +0 -30
- package/types/src/reader/domVisitors/AxisVisitor.d.ts +0 -12
- package/types/src/reader/domVisitors/BarChartTypeVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/ChartSpaceVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/ChartTypeVisitor.d.ts +0 -7
- package/types/src/reader/domVisitors/ChartVisitor.d.ts +0 -7
- package/types/src/reader/domVisitors/DataLabelsVisitor.d.ts +0 -8
- package/types/src/reader/domVisitors/DataPointVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/HyperlinkVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/LayoutVisitor.d.ts +0 -5
- package/types/src/reader/domVisitors/LegendEntryVisitor.d.ts +0 -5
- package/types/src/reader/domVisitors/LegendVisitor.d.ts +0 -5
- package/types/src/reader/domVisitors/MarkerVisitor.d.ts +0 -5
- package/types/src/reader/domVisitors/NegativeShapeVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/PlotAreaVisitor.d.ts +0 -5
- package/types/src/reader/domVisitors/RichValueDataVisitor.d.ts +0 -7
- package/types/src/reader/domVisitors/RichValueStructureVisitor.d.ts +0 -6
- package/types/src/reader/domVisitors/SeriesVisitor.d.ts +0 -8
- package/types/src/reader/domVisitors/TitleVisitor.d.ts +0 -9
- package/types/src/writer/emitters/ChartColorsEmitter.d.ts +0 -7
- package/types/src/writer/emitters/ChartEmitter.d.ts +0 -14
- package/types/src/writer/emitters/ChartStyleEmitter.d.ts +0 -46
- package/types/src/writer/utils/HiddenFormulaXfs.d.ts +0 -28
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ICellStyle, IFill, ITheme, IStyleCollection, IFontStyle, IBorders } from '@sheetxl/sdk';
|
|
2
2
|
import { Emitter, IXmlWriter, EmitContext } from '../builder';
|
|
3
3
|
/**
|
|
4
4
|
* Emits the styles.xml part.
|
|
@@ -8,6 +8,27 @@ export declare class StylesEmitter extends Emitter<ModelHandle> {
|
|
|
8
8
|
/** @inheritdoc IEmitter.emit */
|
|
9
9
|
emit(handle: ModelHandle, ctx: EmitContext): Promise<void>;
|
|
10
10
|
}
|
|
11
|
+
/** Shared-states key under which `WorkbookEmitter` leaves the save's {@link StylesLayout}. */
|
|
12
|
+
export declare const STYLES_LAYOUT_SHARED_STATE = "stylesLayout";
|
|
13
|
+
/**
|
|
14
|
+
* The save's styles as the styles part writes them: the direct xfs and the indexes into its
|
|
15
|
+
* fonts, fills, borders and number formats. Laid out once, before any part that cites a number
|
|
16
|
+
* format by id, so that id is final when that part is written.
|
|
17
|
+
*/
|
|
18
|
+
export interface StylesLayout {
|
|
19
|
+
readonly styles: IStyleCollection;
|
|
20
|
+
readonly directXfs: ICellStyle.JSON[];
|
|
21
|
+
readonly denormalized: DenormalizedStyles;
|
|
22
|
+
}
|
|
23
|
+
/** Lays out the save's styles ({@link StylesLayout}). */
|
|
24
|
+
export declare const layOutStyles: (styles: IStyleCollection, json: IStyleCollection.JSON) => StylesLayout;
|
|
25
|
+
/**
|
|
26
|
+
* The `numFmtId` a number format is written with: a built-in's own id, or the custom id this
|
|
27
|
+
* save gives its code, added to the styles part's `<numFmts>` when no cell uses it.
|
|
28
|
+
*/
|
|
29
|
+
export declare const numFmtIdOf: (layout: StylesLayout, format: string | number) => number;
|
|
30
|
+
/** The namespace of the feature property bags and the xf complement. */
|
|
31
|
+
export declare const NS_FEATURE_PROPERTY_BAG = "http://schemas.microsoft.com/office/spreadsheetml/2022/featurepropertybag";
|
|
11
32
|
/**
|
|
12
33
|
* Writes ONE differential format.
|
|
13
34
|
*
|
|
@@ -18,7 +39,19 @@ export declare class StylesEmitter extends Emitter<ModelHandle> {
|
|
|
18
39
|
*
|
|
19
40
|
* @returns `numFmtId`, advanced if this dxf consumed one.
|
|
20
41
|
*/
|
|
21
|
-
export declare function writeDxf(ctx: EmitContext, xml: IXmlWriter, dxf:
|
|
42
|
+
export declare function writeDxf(ctx: EmitContext, xml: IXmlWriter, dxf: ICellStyle.Properties, styles: IStyleCollection, theme: ITheme, tag?: string, numFmtId?: number): number;
|
|
43
|
+
export interface DenormalizedStyles {
|
|
44
|
+
fontMap: Map<string, string>;
|
|
45
|
+
fonts: IFontStyle.Properties[];
|
|
46
|
+
fillMap: Map<string, string>;
|
|
47
|
+
fills: (IFill.NoneProperties | IFill.SolidProperties | IFill.PatternProperties | IFill.GradientProperties)[];
|
|
48
|
+
borderMap: Map<string, string>;
|
|
49
|
+
borders: IBorders.Properties[];
|
|
50
|
+
numFmtMap: Map<string | number, string>;
|
|
51
|
+
numFmtsCustom: string[];
|
|
52
|
+
namedStyleMap: Map<string, string>;
|
|
53
|
+
namedStyles: ICellStyle.NamedJSON[];
|
|
54
|
+
}
|
|
22
55
|
type ModelHandle = {
|
|
23
56
|
json: IStyleCollection.JSON;
|
|
24
57
|
styles: IStyleCollection;
|
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
import { ITable, IRange } from '@sheetxl/sdk';
|
|
2
2
|
import { Emitter, EmitContext } from '../builder';
|
|
3
|
+
/**
|
|
4
|
+
* Shared-states key under which the `table/@id` each table is written with is left, by table, for
|
|
5
|
+
* whatever names a table by that id (a slicer cache's `tableSlicerCache`).
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* The id is minted when the sheet schedules the table part ({@link mintTableId}), not when the
|
|
9
|
+
* part emits: the workbook writes the slicer caches once every sheet has emitted, and a sheet's
|
|
10
|
+
* children may still be queued then.
|
|
11
|
+
*/
|
|
12
|
+
export declare const SHARED_STATE_TABLE_IDS = "tableIds";
|
|
13
|
+
/** The ids the tables are written with, by table. */
|
|
14
|
+
export declare const tableIdsOf: (ctx: EmitContext) => Map<ITable, number>;
|
|
15
|
+
/** The `table/@id` a table is written with: unique in the package, minted once per table. */
|
|
16
|
+
export declare const mintTableId: (ctx: EmitContext, table: ITable) => number;
|
|
3
17
|
export declare class TableEmitter extends Emitter<ModelHandle> {
|
|
4
18
|
constructor();
|
|
5
19
|
/** @inheritdoc IEmitter.emit */
|
|
@@ -9,13 +9,35 @@ export declare class WorkbookEmitter extends Emitter<IWorkbook> {
|
|
|
9
9
|
export declare const SHARED_STATE_FILE_VERSION = "fileVersion";
|
|
10
10
|
/** Shared-states key under which `XLSXWriter` leaves the source's `calcPr@calcId`, verbatim. */
|
|
11
11
|
export declare const SHARED_STATE_CALC_ID = "calcId";
|
|
12
|
-
/**
|
|
13
|
-
export
|
|
12
|
+
/** One `<ext>` of the source workbook's `<extLst>`, as `XLSXWriter` reads it from the retained bytes. */
|
|
13
|
+
export interface SourceWorkbookExt {
|
|
14
|
+
/** The `uri` attribute, as written. */
|
|
15
|
+
readonly uri: string;
|
|
16
|
+
/** The whole `<ext>` element, verbatim. */
|
|
17
|
+
readonly xml: string;
|
|
18
|
+
/**
|
|
19
|
+
* The source relationship behind each `r:id` the element cites, once per id. `target` is the
|
|
20
|
+
* resolved part path (or URL, when `external`), `null` when the source's rels do not define the id.
|
|
21
|
+
*/
|
|
22
|
+
readonly rels: readonly {
|
|
23
|
+
id: string;
|
|
24
|
+
type: string;
|
|
25
|
+
target: string | null;
|
|
26
|
+
external: boolean;
|
|
27
|
+
}[];
|
|
28
|
+
}
|
|
29
|
+
/** Shared-states key under which `XLSXWriter` leaves the source's workbook `<ext>` elements, as {@link SourceWorkbookExt}s. */
|
|
30
|
+
export declare const SHARED_STATE_WORKBOOK_EXTS = "workbookExts";
|
|
14
31
|
/**
|
|
15
32
|
* Shared-states key under which `XLSXWriter` leaves the source package's worksheet part path per
|
|
16
33
|
* `sheetId`. See {@link resolveSheetPaths}.
|
|
17
34
|
*/
|
|
18
35
|
export declare const SHARED_STATE_SHEET_PARTS = "sheetParts";
|
|
36
|
+
/**
|
|
37
|
+
* Shared-states key under which `XLSXWriter` leaves whether the package being written can hold
|
|
38
|
+
* macros. See {@link writeOpaqueSheet}.
|
|
39
|
+
*/
|
|
40
|
+
export declare const SHARED_STATE_MACRO_ENABLED = "macroEnabled";
|
|
19
41
|
/**
|
|
20
42
|
* Shared-states key under which `XLSXWriter` leaves the source package's external-link part paths,
|
|
21
43
|
* in `[n]` order. See {@link writeExternalReferences}.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
import { Emitter, EmitContext } from '../builder';
|
|
3
|
+
import { XlsxWorksheetJSON } from '../utils/SheetStyleLayout';
|
|
3
4
|
export declare const WorksheetKind = "worksheet";
|
|
4
5
|
/**
|
|
5
6
|
* Emits the worksheet.xml part.
|
|
@@ -10,9 +11,9 @@ export declare class WorksheetEmitter extends Emitter<ModelHandle> {
|
|
|
10
11
|
emit(handle: ModelHandle, ctx: EmitContext): Promise<void>;
|
|
11
12
|
}
|
|
12
13
|
type ModelHandle = {
|
|
13
|
-
model:
|
|
14
|
+
model: IWorksheet;
|
|
14
15
|
isSelected: boolean;
|
|
15
|
-
json:
|
|
16
|
+
json: XlsxWorksheetJSON;
|
|
16
17
|
};
|
|
17
18
|
export {};
|
|
18
19
|
//# sourceMappingURL=WorksheetEmitter.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ICondition, IRange, ITable, ISort, ICellRange } from '@sheetxl/sdk';
|
|
1
|
+
import { ICondition, IRange, ITable, ISort, ICellRange, IFilter } from '@sheetxl/sdk';
|
|
2
2
|
import { EmitContext, IXmlWriter } from '../builder';
|
|
3
|
-
export declare const writeSortState: (ctx: EmitContext, xml: IXmlWriter, model: ITable, json: ISort.JSON, range: ICellRange, coords: IRange.Coords) => void;
|
|
3
|
+
export declare const writeSortState: (ctx: EmitContext, xml: IXmlWriter, model: ITable, json: ISort.JSON, range: ICellRange, coords: IRange.Coords, headerRows: number) => void;
|
|
4
4
|
export declare const writeAutoFilter: (ctx: EmitContext, xml: IXmlWriter, model: ITable, json: ITable.JSON, isAutoTable?: boolean) => void;
|
|
5
5
|
/** Writes one `customFilter`, taking its OOXML spelling from the border. */
|
|
6
6
|
export declare const writeCustomFilter: (ctx: EmitContext, xml: IXmlWriter, condition: ICondition.JSON) => void;
|
|
@@ -12,5 +12,5 @@ export declare const writeCustomFilter: (ctx: EmitContext, xml: IXmlWriter, cond
|
|
|
12
12
|
* TODO - Ensure we only write out valid OOXML support conditions
|
|
13
13
|
* TODO - What to do with custom validations?
|
|
14
14
|
*/
|
|
15
|
-
export declare const writeFilter: (ctx: EmitContext, xml: IXmlWriter, condition: ICondition.JSON) => void;
|
|
15
|
+
export declare const writeFilter: (ctx: EmitContext, xml: IXmlWriter, condition: ICondition.JSON, filter?: IFilter | null) => void;
|
|
16
16
|
//# sourceMappingURL=AutoFilter.d.ts.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { ICellControl } from '@sheetxl/sdk';
|
|
2
|
+
export declare const CELL_CONTROL_COMPLEMENTS_SHARED_STATE = "cellControlComplements";
|
|
3
|
+
/**
|
|
4
|
+
* The cell controls a workbook's xfs carry.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* The model keeps a cell control apart from the cell's style (`ICellControl`); xlsx keeps it on the
|
|
8
|
+
* cell's xf as an `xfComplement`. So the writer's xf is a pair, a style and a control, and the two
|
|
9
|
+
* meet only there: the style layout mints an xf per pair, and this records which complement each xf
|
|
10
|
+
* carries and which control each complement stands for (what the `featurePropertyBag` part lists).
|
|
11
|
+
*/
|
|
12
|
+
export declare class CellControlComplements {
|
|
13
|
+
private _controls;
|
|
14
|
+
private _xfComplements;
|
|
15
|
+
/**
|
|
16
|
+
* The complement index for `control`, or `null` when xlsx cannot carry it.
|
|
17
|
+
*
|
|
18
|
+
* @remarks
|
|
19
|
+
* Only Excel's checkbox has a file form; another type is dropped (the caller warns).
|
|
20
|
+
*/
|
|
21
|
+
getComplement(control: ICellControl.JSON): number | null;
|
|
22
|
+
/** The controls the complements stand for, by complement index. */
|
|
23
|
+
getControls(): readonly ICellControl.JSON[];
|
|
24
|
+
/** Records the complement each direct xf carries, by xf index, once the layout has minted them. */
|
|
25
|
+
setXfComplements(complements: readonly (number | undefined)[]): void;
|
|
26
|
+
/** The complement direct xf `xf` carries, or `null`. */
|
|
27
|
+
getXfComplement(xf: number): number | null;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=CellControlComplements.d.ts.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { IGeometry } from '@sheetxl/sdk';
|
|
2
|
+
import { IXmlWriter } from '../builder';
|
|
3
|
+
/** The `custGeom` element for a definition; the lists are written in the schema's order. */
|
|
4
|
+
export declare const writeCustGeom: (xml: IXmlWriter, def: IGeometry.Def) => void;
|
|
5
|
+
//# sourceMappingURL=CustGeomUtils.d.ts.map
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { EmitContext } from '../builder/Types';
|
|
2
|
+
/** Leaves the workbook's date system for every part written after it ({@link date1904Of}). */
|
|
3
|
+
export declare const setDate1904: (ctx: EmitContext, date1904: boolean) => void;
|
|
4
|
+
/** Whether the workbook being written counts dates from 1904, for a part that writes a serial. */
|
|
5
|
+
export declare const date1904Of: (ctx: EmitContext) => boolean;
|
|
6
|
+
//# sourceMappingURL=DateSystem.d.ts.map
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { ITypes } from '@sheetxl/sdk';
|
|
2
|
+
import { XlsxHeader, XlsxWorksheetJSON } from './SheetStyleLayout';
|
|
3
|
+
/** How the rows a sheet does not list are written (`sheetFormatPr`). */
|
|
4
|
+
export interface DefaultRows {
|
|
5
|
+
/** `defaultRowHeight`, in points. */
|
|
6
|
+
height: number;
|
|
7
|
+
/** `customHeight`: Excel uses `height` as is; otherwise it uses the Normal height plus the flags' pixels. */
|
|
8
|
+
custom: boolean;
|
|
9
|
+
/** `thickTop`: every row gives a pixel to a thick line above it. */
|
|
10
|
+
thickTop: boolean;
|
|
11
|
+
/** `thickBottom`: every row gives a pixel to a medium or thick line below it. */
|
|
12
|
+
thickBottom: boolean;
|
|
13
|
+
/** The row run written as the default instead of row by row, or `null` when there is none. */
|
|
14
|
+
run: ITypes.RunCoordValue<XlsxHeader> | null;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* The row runs to write once `defaultRows.run` is the sheet's default: the other runs, and the rows
|
|
18
|
+
* no run lists, at the height they no longer get by default.
|
|
19
|
+
*/
|
|
20
|
+
export declare const listedRowRuns: (rows: ITypes.RunCoordValue<XlsxHeader>[], defaultRun: ITypes.RunCoordValue<XlsxHeader>, unlistedHeight: number, maxRows: number) => ITypes.RunCoordValue<XlsxHeader>[];
|
|
21
|
+
export declare const resolveDefaultRows: (json: XlsxWorksheetJSON, normalHeight: number, maxRows: number) => DefaultRows | null;
|
|
22
|
+
//# sourceMappingURL=DefaultRows.d.ts.map
|
|
@@ -1,11 +1,19 @@
|
|
|
1
|
-
import { IFill, IStroke, IEffect, IResource, IStyleCollection, ITheme } from '@sheetxl/sdk';
|
|
1
|
+
import { IFill, IStroke, IEffect, IHyperlink, IResource, IStyleCollection, ITheme } from '@sheetxl/sdk';
|
|
2
2
|
import { EmitContext, IXmlWriter } from '../builder';
|
|
3
|
+
/**
|
|
4
|
+
* A `hlinkClick`/`hlinkHover` element for a hyperlink: its address becomes an external
|
|
5
|
+
* relationship of the part being written, as Excel does; a link with no address (an action
|
|
6
|
+
* alone) is written without one.
|
|
7
|
+
*
|
|
8
|
+
* @param tag `hlinkClick` under the DrawingML namespace, or `a:hlinkClick` where that is not the default.
|
|
9
|
+
*/
|
|
10
|
+
export declare const writeHyperlinkElement: (ctx: EmitContext, xml: IXmlWriter, tag: string, link: IHyperlink.JSON | undefined) => void;
|
|
3
11
|
/**
|
|
4
12
|
* Writes fill definitions (patterns and gradients).
|
|
5
13
|
*/
|
|
6
|
-
export declare function writeFill(ctx: EmitContext, xml: IXmlWriter, fill: IFill.NoneProperties | IFill.SolidProperties | IFill.PatternProperties | IFill.GradientProperties, styles: IStyleCollection, spreadsheetML?: boolean, // SpreadsheetML uses pattern fills but standard DrawML does not.
|
|
14
|
+
export declare function writeFill(ctx: EmitContext, xml: IXmlWriter, fill: IFill.NoneProperties | IFill.SolidProperties | IFill.PatternProperties | IFill.GradientProperties | IFill.ImageProperties | IFill.GroupProperties, styles: IStyleCollection, spreadsheetML?: boolean, // SpreadsheetML uses pattern fills but standard DrawML does not.
|
|
7
15
|
isDxf?: boolean): void;
|
|
8
|
-
export declare const writeLn: (ctx: EmitContext, xml: IXmlWriter, line: IStroke.JSON |
|
|
16
|
+
export declare const writeLn: (ctx: EmitContext, xml: IXmlWriter, line: IStroke.JSON | string | null | undefined, styles: IStyleCollection) => void;
|
|
9
17
|
export declare const writeFillLnEffects: (ctx: EmitContext, styles: IStyleCollection, json: any, element?: string | undefined, includeEmptyEffects?: boolean) => void;
|
|
10
18
|
/**
|
|
11
19
|
* Writes an `<a:effectLst>` from a list of parsed effects (see `ColorContainerVisitor.getEffects`) —
|
|
@@ -28,6 +36,37 @@ export type ImagePartParams = {
|
|
|
28
36
|
type: IResource.Type;
|
|
29
37
|
index: number;
|
|
30
38
|
};
|
|
39
|
+
/** How a part being written refers to an image: the relationship id, and whether it points outside the package. */
|
|
40
|
+
export interface ImagePartRef {
|
|
41
|
+
relId: string;
|
|
42
|
+
external: boolean;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Relates an image to the part being written and returns how to refer to it. An external image is
|
|
46
|
+
* a relationship to its URI; an embedded one is written to `/xl/media` once per package (the
|
|
47
|
+
* {@link IMAGES_WRITTEN_STATE} map) and related once per part, however many pictures and fills
|
|
48
|
+
* share the resource.
|
|
49
|
+
*/
|
|
50
|
+
export declare const addImagePart: (ctx: EmitContext, resource: IResource) => Promise<ImagePartRef>;
|
|
51
|
+
/** How the part being written refers to an image already related with {@link addImagePart}, if it was. */
|
|
52
|
+
export declare const imagePartFor: (ctx: EmitContext, resource: IResource) => ImagePartRef | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* The resource a JSON names by `resId`: the writer's map of the workbook's resources by the id
|
|
55
|
+
* its JSON cites them with, complete before any sheet part emits.
|
|
56
|
+
*/
|
|
57
|
+
export declare const resourceById: (ctx: EmitContext, resId: number | undefined) => IResource | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Relates the image a shape's or a group's fill names before it is written: fills are written
|
|
60
|
+
* synchronously, the parts they cite are added asynchronously.
|
|
61
|
+
*/
|
|
62
|
+
export declare const addImageFillParts: (ctx: EmitContext, json: {
|
|
63
|
+
fill?: IFill.JSON;
|
|
64
|
+
} | undefined) => Promise<void>;
|
|
65
|
+
/**
|
|
66
|
+
* The children of a `blipFill` — the `blip`, the source rectangle and the tile or stretch — in
|
|
67
|
+
* the writer's current default namespace. A `pic` writes them inside its own `xdr:blipFill`.
|
|
68
|
+
*/
|
|
69
|
+
export declare const writeBlipFillChildren: (xml: IXmlWriter, fill: IFill.ImageProperties, ref: ImagePartRef) => void;
|
|
31
70
|
export declare const EMU_PER_POINT: number;
|
|
32
71
|
export declare const EMU_PER_PIXEL: number;
|
|
33
72
|
export declare const DEFAULT_IMAGE_TYPE: {
|
|
@@ -1,29 +1,4 @@
|
|
|
1
1
|
import { Scalar, IWorkbook } from '@sheetxl/sdk';
|
|
2
|
-
/**
|
|
3
|
-
* Exporting a formula Excel cannot evaluate.
|
|
4
|
-
*
|
|
5
|
-
* Excel has no notion of "a function I do not know but should keep working". A name it does not
|
|
6
|
-
* have evaluates to `#NAME?` and the computed value is gone — so a user's own UDF, or one of the
|
|
7
|
-
* 29 built-ins Excel lacks, survives a save as an error and nothing else.
|
|
8
|
-
*
|
|
9
|
-
* Google Sheets solved this years ago and the shape is a de-facto convention, so we emit THEIR
|
|
10
|
-
* spelling rather than inventing one — the same text is then understood by Sheets, by Grid, and by
|
|
11
|
-
* our own reader, which needs a single unwrap path either way:
|
|
12
|
-
*
|
|
13
|
-
* ```
|
|
14
|
-
* IFERROR(__xludf.DUMMYFUNCTION("ISEMAIL(""biggie"")"),FALSE)
|
|
15
|
-
* ```
|
|
16
|
-
*
|
|
17
|
-
* The unknown call errors in Excel, `IFERROR` yields the literal, and the cell keeps showing the
|
|
18
|
-
* right answer. The original formula text rides along as a string argument, which is what lets the
|
|
19
|
-
* round trip back into SheetXL be lossless.
|
|
20
|
-
*
|
|
21
|
-
* The trade is real and worth stating: **the formula is dead in Excel.** It never recalculates, so
|
|
22
|
-
* editing a precedent leaves a stale value with no visual cue. That is Google's trade too; the
|
|
23
|
-
* alternative (emit bare, show `#NAME?`) loses the value instead. See CALC-ISSUES item 7.
|
|
24
|
-
*
|
|
25
|
-
* @see https://docs.grid.is/apiary/explain/gsdv/
|
|
26
|
-
*/
|
|
27
2
|
/** Google's marker. Deliberately their exact spelling — see the note above. */
|
|
28
3
|
export declare const DUMMY_FUNCTION = "__xludf.DUMMYFUNCTION";
|
|
29
4
|
/**
|
|
@@ -1,22 +1,25 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ICellStyle } from '@sheetxl/sdk';
|
|
2
2
|
/**
|
|
3
|
-
* Accumulates
|
|
4
|
-
*
|
|
3
|
+
* Accumulates the differential styles (dxfs) a worksheet and its parts cite — conditional formats,
|
|
4
|
+
* color filters, color sorts — so the styles part, written after the worksheets, can include them
|
|
5
|
+
* in `<dxfs>`.
|
|
5
6
|
*
|
|
6
|
-
* Index contract:
|
|
7
|
-
*
|
|
8
|
-
*
|
|
7
|
+
* Index contract: collected dxfs take `0..count-1`; the table-style dxfs the styles emitter
|
|
8
|
+
* denormalizes are appended after and offset by {@link getCount}. This keeps the `dxfId` written
|
|
9
|
+
* into worksheet and table XML final at the time it is written.
|
|
9
10
|
*
|
|
10
|
-
* Shared via `EmitContext.getSharedStates()` under
|
|
11
|
-
* for the pattern).
|
|
11
|
+
* Shared via `EmitContext.getSharedStates()` under {@link DXFS_SHARED_STATE}; use
|
|
12
|
+
* {@link dxfCollectorOf} (see `MetadataCollector` for the pattern).
|
|
12
13
|
*/
|
|
13
14
|
export declare class DxfCollector {
|
|
14
15
|
private readonly _dxfs;
|
|
15
16
|
private readonly _byKey;
|
|
16
17
|
/** Returns the dxf index for the style, adding it if not yet collected. */
|
|
17
|
-
add(style:
|
|
18
|
-
getDxfs(): readonly
|
|
18
|
+
add(style: ICellStyle.JSON): number;
|
|
19
|
+
getDxfs(): readonly ICellStyle.JSON[];
|
|
19
20
|
getCount(): number;
|
|
20
21
|
}
|
|
21
|
-
export declare const
|
|
22
|
+
export declare const DXFS_SHARED_STATE = "dxfs";
|
|
23
|
+
/** The write's collector, created on first use. */
|
|
24
|
+
export declare const dxfCollectorOf: (sharedStates: Map<string, any>) => DxfCollector;
|
|
22
25
|
//# sourceMappingURL=DxfCollector.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { IGeometry } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* `[name, fmla]` pairs for an `avLst`. Values are integers in the file.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* Excel rejects an `avLst` that lists some of a preset's adjust values but not all of them, so
|
|
7
|
+
* from a geometry every value is written, defaults included, once any is adjusted. Without one
|
|
8
|
+
* (a preset this SDK does not define) the values are written as they are.
|
|
9
|
+
*
|
|
10
|
+
* @param geometry The shape's evaluated geometry, or `null` when there is none.
|
|
11
|
+
* @param adjustments The values the shape sets.
|
|
12
|
+
*/
|
|
13
|
+
export declare const adjustValueEntries: (geometry: IGeometry | null, adjustments: Record<string, number> | undefined | null) => [string, string][];
|
|
14
|
+
//# sourceMappingURL=PrstGeomUtils.d.ts.map
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import { Scalar } from '@sheetxl/sdk';
|
|
1
|
+
import { IWorkbook, Scalar } from '@sheetxl/sdk';
|
|
2
|
+
import { EmitContext } from '../builder';
|
|
3
|
+
import { RichItemText, RichStructureKey, RichStyleDef, RichValueKeyFlags, RichValueSink, RichValueStructureDef } from '../../richValue';
|
|
2
4
|
import { MetadataCollector } from './MetadataCollector';
|
|
3
5
|
/**
|
|
4
6
|
* Accumulates rich-value entries so that RichValueEmitter and
|
|
@@ -20,84 +22,33 @@ import { MetadataCollector } from './MetadataCollector';
|
|
|
20
22
|
* ## XML output relationship
|
|
21
23
|
*
|
|
22
24
|
* ```
|
|
23
|
-
* rdrichvaluestructure.xml – one <s> per
|
|
25
|
+
* rdrichvaluestructure.xml – one <s> per structure written
|
|
24
26
|
* rdrichvalue.xml – one <rv> per registered entry (s= → structure index)
|
|
25
27
|
* metadata.xml futureMetadata XLRICHVALUE – one <bk> per unique rdrichvalue entry
|
|
26
28
|
* metadata.xml valueMetadata – one <bk> per cell (vm= index)
|
|
27
29
|
* ```
|
|
28
|
-
*/
|
|
29
|
-
/**
|
|
30
|
-
* OOXML primitive-value type codes used in `<k t="…">` attributes inside
|
|
31
|
-
* `<rvStructures>`.
|
|
32
|
-
*
|
|
33
|
-
* "d" - Date/Time (ISO-8601 string)
|
|
34
|
-
* "i" - Integer (32-bit signed)
|
|
35
|
-
* "b" - Boolean
|
|
36
|
-
* "e" - Error value
|
|
37
|
-
* "s" - Inline string
|
|
38
|
-
* "r" - Nested rich value
|
|
39
|
-
* "a" - Array data (rdarray.xml)
|
|
40
|
-
* "spb" - Supporting property bag
|
|
41
|
-
*/
|
|
42
|
-
export type RichPrimitiveType = 'd' | 'i' | 'b' | 'e' | 's' | 'r' | 'a' | 'spb';
|
|
43
|
-
/**
|
|
44
|
-
* One property slot in a rich-value schema.
|
|
45
30
|
*
|
|
46
|
-
*
|
|
47
|
-
* - `type` – OOXML primitive type (`t=` attribute on `<k>`).
|
|
48
|
-
* - `defaultValue` – Serialized fallback used when the property is absent or
|
|
49
|
-
* `undefined` on the raw value object. Defaults to `''`.
|
|
31
|
+
* What each value writes is its {@link IRichValueHandler}'s ({@link RichValueHandlers}).
|
|
50
32
|
*/
|
|
51
|
-
export type RichValueProp = [name: string, type: RichPrimitiveType, defaultValue?: string];
|
|
52
|
-
/**
|
|
53
|
-
* Base class (and usable concrete class) for rich-value handler/schema types.
|
|
54
|
-
*
|
|
55
|
-
* Instantiate directly for pure-schema handlers:
|
|
56
|
-
* ```ts
|
|
57
|
-
* const MyHandler = new RichValueHandler('_myType', [
|
|
58
|
-
* ['foo', 'i', '0'],
|
|
59
|
-
* ['bar', 's', ''],
|
|
60
|
-
* ]);
|
|
61
|
-
* ```
|
|
62
|
-
*
|
|
63
|
-
* Subclass and override {@link getValues} for handlers that need custom
|
|
64
|
-
* serialization logic.
|
|
65
|
-
*
|
|
66
|
-
* Pass instances to {@link RichValueCollector.register}.
|
|
67
|
-
*/
|
|
68
|
-
export declare class RichValueHandler {
|
|
69
|
-
/**
|
|
70
|
-
* The OOXML structure type name (value of the `t=` attribute on `<s>`
|
|
71
|
-
* inside `<rvStructures>`). E.g. `"_error"`.
|
|
72
|
-
*/
|
|
73
|
-
readonly type: string;
|
|
74
|
-
/**
|
|
75
|
-
* Ordered property definitions written as `<k n="…" t="…"/>` inside the
|
|
76
|
-
* matching `<s>` element in `rdrichvaluestructure.xml`.
|
|
77
|
-
*/
|
|
78
|
-
readonly props: ReadonlyArray<RichValueProp>;
|
|
79
|
-
constructor(type: string, props: ReadonlyArray<RichValueProp>);
|
|
80
|
-
/**
|
|
81
|
-
* Extracts the serializable string values for one `<rv>` entry in
|
|
82
|
-
* `rdrichvalue.xml`. The array is parallel to {@link props}.
|
|
83
|
-
*
|
|
84
|
-
* The default implementation reads each property by name from `rawValue`
|
|
85
|
-
* (treated as a `Record<string, unknown>`) and falls back to the prop's
|
|
86
|
-
* `defaultValue` (or `''`) when the property is absent or `undefined`.
|
|
87
|
-
*
|
|
88
|
-
* Override in subclasses for custom serialization logic.
|
|
89
|
-
*
|
|
90
|
-
* @param rawValue The raw value that was passed to
|
|
91
|
-
* {@link RichValueCollector.add} / `_register`.
|
|
92
|
-
*/
|
|
93
|
-
getValues(rawValue: Record<string, unknown>): string[];
|
|
94
|
-
}
|
|
95
33
|
/** One registered rich-value entry. */
|
|
96
34
|
export interface RichValueEntry {
|
|
97
|
-
/** The
|
|
98
|
-
|
|
99
|
-
/** The
|
|
100
|
-
|
|
35
|
+
/** The structure the entry is written as. */
|
|
36
|
+
structure: RichValueStructureDef;
|
|
37
|
+
/** The `<v>`s, parallel to the structure's keys. */
|
|
38
|
+
values: readonly string[];
|
|
39
|
+
/** The `<fb>` cached number, for a formatted number. */
|
|
40
|
+
fb?: string;
|
|
41
|
+
}
|
|
42
|
+
/** One `<a>` of rdarray.xml. */
|
|
43
|
+
export interface RichArrayEntry {
|
|
44
|
+
rows: number;
|
|
45
|
+
columns: number;
|
|
46
|
+
items: readonly RichItemText[];
|
|
47
|
+
}
|
|
48
|
+
/** One `<spb>`: its bag structure's index and its `<v>`s. */
|
|
49
|
+
export interface RichBagEntry {
|
|
50
|
+
s: number;
|
|
51
|
+
values: readonly string[];
|
|
101
52
|
}
|
|
102
53
|
/**
|
|
103
54
|
* Accumulates rich-value entries across all sheets.
|
|
@@ -107,12 +58,29 @@ export interface RichValueEntry {
|
|
|
107
58
|
*
|
|
108
59
|
* Stored in `sharedStates` under the key `"persistRichTypes"`.
|
|
109
60
|
*/
|
|
110
|
-
export declare class RichValueCollector {
|
|
61
|
+
export declare class RichValueCollector implements RichValueSink {
|
|
111
62
|
private readonly _metaCollector;
|
|
63
|
+
private readonly _workbook;
|
|
112
64
|
private readonly _entries;
|
|
113
65
|
private readonly _keyMap;
|
|
66
|
+
/** The writers started, by handler, in the order their structures are first written. */
|
|
67
|
+
private readonly _writers;
|
|
68
|
+
private readonly _structureIndex;
|
|
69
|
+
private readonly _structures;
|
|
70
|
+
private readonly _arrays;
|
|
71
|
+
private readonly _arrayKeys;
|
|
72
|
+
private readonly _bagStructures;
|
|
73
|
+
private readonly _bagStructureKeys;
|
|
74
|
+
private readonly _bags;
|
|
75
|
+
private readonly _bagKeys;
|
|
76
|
+
private readonly _bagArrays;
|
|
77
|
+
private readonly _bagArrayKeys;
|
|
78
|
+
private readonly _richStyles;
|
|
79
|
+
private readonly _richStyleKeys;
|
|
80
|
+
private readonly _keyFlags;
|
|
81
|
+
private readonly _records;
|
|
114
82
|
private _onWarn;
|
|
115
|
-
constructor(metaCollector: MetadataCollector, onWarn?: (message: string, value?: any) => void);
|
|
83
|
+
constructor(metaCollector: MetadataCollector, workbook: IWorkbook, onWarn?: (message: string, value?: any) => void);
|
|
116
84
|
/**
|
|
117
85
|
* Registers a cell value and returns the **1-based `vm=`** attribute value
|
|
118
86
|
* to write on the `<c>` element — exactly like `persistStrings.add(text)`
|
|
@@ -122,37 +90,32 @@ export declare class RichValueCollector {
|
|
|
122
90
|
* attrsCol.vm = '' + persistRichTypes.add(value);
|
|
123
91
|
* ```
|
|
124
92
|
*
|
|
125
|
-
*
|
|
126
|
-
* 1. Deduplicates the raw value → 0-based rdrichvalue.xml index (`rdRvIdx`)
|
|
127
|
-
* 2. Deduplicates the futureMetadata XLRICHVALUE block (`rvFMBkIdx`)
|
|
128
|
-
* 3. Appends a per-cell valueMetadata entry → 1-based `vm=`
|
|
129
|
-
*
|
|
130
|
-
* Dispatches on value type:
|
|
131
|
-
* - `ScalarType.Error` with code > 7 → built-in `_error` handler
|
|
132
|
-
* - Future: `ScalarType.RichData` → IRichType registry
|
|
93
|
+
* A value no handler writes is written as `#UNKNOWN!`.
|
|
133
94
|
*
|
|
134
95
|
* @param value The raw `Scalar` value from the cell iterator.
|
|
96
|
+
* @param formula The cell's formula text, or `null` for a literal: where a picture came from.
|
|
135
97
|
* @returns 1-based `vm=` attribute value.
|
|
136
98
|
*/
|
|
137
|
-
add(value: Scalar): number;
|
|
138
|
-
/**
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
99
|
+
add(value: Scalar, formula?: string | null): number;
|
|
100
|
+
/** {@inheritDoc RichValueSink.addHandled} */
|
|
101
|
+
addHandled(value: Scalar): number | null;
|
|
102
|
+
private _addHandled;
|
|
103
|
+
private _writerFor;
|
|
104
|
+
/** {@inheritDoc RichValueSink.structureFor} */
|
|
105
|
+
structureFor(t: string, keys: readonly RichStructureKey[]): RichValueStructureDef;
|
|
106
|
+
/** {@inheritDoc RichValueSink.addValue} */
|
|
107
|
+
addValue(structure: RichValueStructureDef, values: readonly string[], fb?: string): number;
|
|
108
|
+
/** {@inheritDoc RichValueSink.addArray} */
|
|
109
|
+
addArray(rows: number, columns: number, items: readonly RichItemText[]): number;
|
|
110
|
+
/** {@inheritDoc RichValueSink.addBag} */
|
|
111
|
+
addBag(keys: readonly RichStructureKey[], values: readonly string[]): number;
|
|
112
|
+
/** {@inheritDoc RichValueSink.addBagArray} */
|
|
113
|
+
addBagArray(items: readonly RichItemText[]): number;
|
|
114
|
+
/** {@inheritDoc RichValueSink.addRichStyle} */
|
|
115
|
+
addRichStyle(style: RichStyleDef): number;
|
|
116
|
+
/** {@inheritDoc RichValueSink.addKeyFlags} */
|
|
117
|
+
addKeyFlags(t: string, key: string, flags: readonly (readonly [name: string, value: string])[]): void;
|
|
118
|
+
private _intern;
|
|
156
119
|
/** Number of registered (deduplicated) entries. */
|
|
157
120
|
getCount(): number;
|
|
158
121
|
/** Whether any entries have been registered. */
|
|
@@ -162,39 +125,28 @@ export declare class RichValueCollector {
|
|
|
162
125
|
*/
|
|
163
126
|
getEntries(): readonly RichValueEntry[];
|
|
164
127
|
/**
|
|
165
|
-
*
|
|
128
|
+
* The structures written, in the order they are first encountered.
|
|
166
129
|
* Used by RichValueStructureEmitter to build `<rvStructures>`.
|
|
167
130
|
*/
|
|
168
|
-
|
|
131
|
+
getStructures(): RichValueStructureDef[];
|
|
169
132
|
/**
|
|
170
|
-
*
|
|
171
|
-
* produced by {@link uniqueHandlers}. This is the `s=` attribute value on
|
|
133
|
+
* The 0-based index of `structure` within {@link getStructures}: the `s=` attribute value on
|
|
172
134
|
* `<rv>` in `rdrichvalue.xml`.
|
|
173
135
|
*/
|
|
174
|
-
|
|
136
|
+
getStructureIndex(structure: RichValueStructureDef): number;
|
|
137
|
+
/** The arrays written (rdarray.xml), in index order. */
|
|
138
|
+
getArrays(): readonly RichArrayEntry[];
|
|
139
|
+
/** The supporting property bag structures, bags and bag arrays written. */
|
|
140
|
+
getBags(): {
|
|
141
|
+
structures: readonly (readonly RichStructureKey[])[];
|
|
142
|
+
bags: readonly RichBagEntry[];
|
|
143
|
+
arrays: readonly (readonly RichItemText[])[];
|
|
144
|
+
};
|
|
145
|
+
/** The rich styles written, in index order (a bag names the first as 1). */
|
|
146
|
+
getRichStyles(): readonly RichStyleDef[];
|
|
147
|
+
/** The key flags each written structure declares in `rdRichValueTypes.xml`. */
|
|
148
|
+
getKeyFlags(): [structure: string, flags: readonly RichValueKeyFlags[]][];
|
|
149
|
+
/** Adds the parts the written structures need beyond the rich values. */
|
|
150
|
+
addParts(ctx: EmitContext): void;
|
|
175
151
|
}
|
|
176
|
-
/**
|
|
177
|
-
// #PYTHON! contains a correlationId
|
|
178
|
-
<s t="_error">
|
|
179
|
-
<k n="correlationId" t="s"/>
|
|
180
|
-
<k n="errorMessage" t="s"/>
|
|
181
|
-
<k n="errorName" t="s"/>
|
|
182
|
-
<k n="errorType" t="i"/>
|
|
183
|
-
<k n="subType" t="i"/>
|
|
184
|
-
</s>
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
// #SPILL! contains row column offset
|
|
188
|
-
<s t="_error">
|
|
189
|
-
<k n="colOffset" t="i"/>
|
|
190
|
-
<k n="errorType" t="i"/>
|
|
191
|
-
<k n="rwOffset" t="i"/>
|
|
192
|
-
<k n="subType" t="i"/>
|
|
193
|
-
</s>
|
|
194
|
-
|
|
195
|
-
// unknown has no subtype
|
|
196
|
-
<s t="_error">
|
|
197
|
-
<k n="errorType" t="i"/>
|
|
198
|
-
</s>
|
|
199
|
-
*/
|
|
200
152
|
//# sourceMappingURL=RichValueCollector.d.ts.map
|