@office-open/xlsx 0.11.0 → 0.12.1

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/dist/index.d.mts CHANGED
@@ -1,9 +1,9 @@
1
- import { AppPropertiesOptions, BaseConnectorOptions, BaseGroupOptions, BaseMediaEntry, BasePatchOptions, BasePictureOptions, ChartCollection, ChartSpaceOptions, CompressionOptions, CorePropertiesOptions, CorePropertiesOptions as CorePropertiesOptions$1, CustomPropertyOptions, DataType, Media, OutputByType, OutputByType as OutputByType$1, OutputType, OutputType as OutputType$1, PackerOptions, PackerOptions as PackerOptions$1, ParsedArchive, PositiveUniversalMeasure, RelationshipType, Relationships, UniversalMeasure, XmlifyedFile, Zippable } from "@office-open/core";
1
+ import { AppPropertiesOptions, ArgbHexColor, Base64, BaseConnectorOptions, BaseGroupOptions, BaseMediaEntry, BasePatchOptions, BasePictureOptions, ChartCollection, ChartSpaceOptions, CompressionOptions, ContentTypesInput, CorePropertiesOptions, CorePropertiesOptions as CorePropertiesOptions$1, CustomPropertyOptions, DataType, EncryptedContainerOptions, Guid, HexColor, Media, NonVisualDrawingPropertiesOptions, OutputByType, OutputByType as OutputByType$1, OutputType, OutputType as OutputType$1, PackerOptions, PackerOptions as PackerOptions$1, ParsedArchive, PositiveUniversalMeasure, RelationshipType, Relationships, UniversalMeasure, UnsignedShortHex, XmlifyedFile, Zippable } from "@office-open/core";
2
2
  import { Element } from "@office-open/xml";
3
- import { GroupTransform2DOptions, NonVisualDrawingPropertiesOptions, ShapePropertiesOptions, TextBodyOptions } from "@office-open/core/drawing";
4
- import { ThemeOptions, createThemeXml } from "@office-open/core/theme";
3
+ import { BlackWhiteMode, BlipEffectsOptions, GraphicFrameLockingOptions, GroupTransform2DOptions, NonVisualDrawingPropertiesOptions as NonVisualDrawingPropertiesOptions$1, PictureLockingOptions, ShapeLockingOptions, ShapePropertiesOptions, SourceRectangleOptions, TextBodyOptions, TextHyperlinkOptions } from "@office-open/core/drawing";
4
+ import { DefaultShapeStyleOptions, ThemeOptions, createThemeXml } from "@office-open/core/theme";
5
+ import { ChartSpaceOptions as ChartSpaceOptions$1 } from "@office-open/core/chart";
5
6
  import { CustomDescriptor, HyperlinkTarget, ReadContext, WriteContext } from "@office-open/core/descriptor";
6
-
7
7
  //#region src/parts/styles/styles.d.ts
8
8
  declare class Styles {
9
9
  private fonts;
@@ -22,9 +22,13 @@ declare class Styles {
22
22
  private tableStyles?;
23
23
  private customCellStyles?;
24
24
  private styleExtensions?;
25
+ private roundTrip;
26
+ private dxfsDeclared;
27
+ private numFmtsDeclared;
25
28
  constructor();
26
29
  register(opts: StyleOptions): number;
27
30
  registerDxf(opts: DxfOptions): number;
31
+ setDxfs(list: DxfOptions[]): void;
28
32
  setColors(opts: ColorsOptions): void;
29
33
  setTableStyles(styles: CustomTableStyleOptions[]): void;
30
34
  setExtensions(extensions: StyleExtensionOptions[]): void;
@@ -36,6 +40,13 @@ declare class Styles {
36
40
  private registerBorder;
37
41
  private registerNumFmt;
38
42
  private cellXfKey;
43
+ adopt(table: {
44
+ fonts?: FontOptions[];
45
+ fills?: CellFillOptions[];
46
+ borders?: BorderSideOptions[];
47
+ cellXfs?: IndexedXfEntry[];
48
+ numFmts?: NumFmtEntry[];
49
+ }): void;
39
50
  serialize(): string;
40
51
  private fontXmlStr;
41
52
  private borderXmlStr;
@@ -50,7 +61,10 @@ interface FontOptions {
50
61
  underline?: boolean;
51
62
  strike?: boolean;
52
63
  size?: number;
53
- color?: string;
64
+ color?: HexColor;
65
+ themeColor?: number;
66
+ tint?: number;
67
+ colorIndexed?: number;
54
68
  autoColor?: boolean;
55
69
  font?: string;
56
70
  charset?: number;
@@ -64,14 +78,21 @@ interface FontOptions {
64
78
  }
65
79
  interface CellGradientStopOptions {
66
80
  position: number;
67
- color: string;
81
+ color: HexColor;
68
82
  }
69
83
  interface CellFillOptions {
70
84
  type?: "solid" | "pattern" | "gradient";
71
- color?: string;
72
- patternType?: string;
73
- bgColor?: string;
85
+ color?: HexColor;
86
+ themeColor?: number;
87
+ tint?: number;
88
+ fgAutoColor?: boolean;
89
+ patternType?: "none" | "solid" | "mediumGray" | "darkGray" | "lightGray" | "darkHorizontal" | "darkVertical" | "darkDown" | "darkUp" | "darkGrid" | "darkTrellis" | "lightHorizontal" | "lightVertical" | "lightDown" | "lightUp" | "lightGrid" | "lightTrellis" | "gray125" | "gray0625";
90
+ bgColor?: HexColor;
91
+ bgThemeColor?: number;
92
+ bgTint?: number;
74
93
  colorIndexed?: number;
94
+ bgColorIndexed?: number;
95
+ bgAutoColor?: boolean;
75
96
  stops?: CellGradientStopOptions[];
76
97
  gradientType?: "linear" | "path";
77
98
  gradientDegree?: number;
@@ -83,6 +104,10 @@ interface CellFillOptions {
83
104
  interface BorderOptions {
84
105
  style?: "none" | "thin" | "medium" | "dashed" | "dotted" | "thick" | "double" | "hair" | "mediumDashed" | "dashDot" | "mediumDashDot" | "dashDotDot" | "mediumDashDotDot" | "slantDashDot";
85
106
  color?: string;
107
+ themeColor?: number;
108
+ tint?: number;
109
+ autoColor?: boolean;
110
+ colorIndexed?: number;
86
111
  }
87
112
  interface BorderSideOptions {
88
113
  top?: BorderOptions;
@@ -124,26 +149,32 @@ interface CellProtectionOptions {
124
149
  hidden?: boolean;
125
150
  }
126
151
  interface IndexedColorOptions {
127
- rgb: string;
152
+ rgb: ArgbHexColor;
128
153
  }
129
154
  interface ColorsOptions {
130
155
  indexedColors?: IndexedColorOptions[];
131
- mruColors?: string[];
156
+ mruColors?: HexColor[];
157
+ }
158
+ interface DxfNumFmtOptions {
159
+ numFmtId?: number;
160
+ formatCode: string;
132
161
  }
133
162
  interface DxfOptions {
134
163
  font?: FontOptions;
135
164
  fill?: CellFillOptions;
136
165
  border?: BorderSideOptions;
137
- numFmt?: string;
166
+ numFmt?: string | DxfNumFmtOptions;
167
+ alignment?: AlignmentOptions;
168
+ protection?: CellProtectionOptions;
138
169
  }
139
170
  type TableStyleElementType = "wholeTable" | "headerRow" | "totalRow" | "firstColumn" | "lastColumn" | "firstRowStripe" | "secondRowStripe" | "firstColumnStripe" | "secondColumnStripe" | "firstHeaderCell" | "lastHeaderCell" | "firstTotalCell" | "lastTotalCell" | "subtotalRow1" | "subtotalRow2" | "subtotalRow3" | "subtotalColumn1" | "subtotalColumn2" | "subtotalColumn3" | "blankRow" | "firstColumnSubheading" | "secondColumnSubheading" | "thirdColumnSubheading" | "firstRowSubheading" | "secondRowSubheading" | "thirdRowSubheading" | "pageFieldLabels" | "pageFieldValues";
140
171
  interface TableStyleElementOptions {
141
172
  type: TableStyleElementType;
142
173
  dxfId?: number;
143
- button?: boolean;
144
174
  }
145
175
  interface StyleExtensionOptions {
146
176
  uri: string;
177
+ namespaces?: Record<string, string>;
147
178
  content?: string;
148
179
  }
149
180
  interface CustomTableStyleOptions {
@@ -204,10 +235,17 @@ interface IndexedXfEntry {
204
235
  fillId?: number;
205
236
  borderId?: number;
206
237
  numFmtId?: number;
238
+ xfId?: number;
207
239
  alignment?: AlignmentOptions;
208
240
  protection?: CellProtectionOptions;
209
241
  quotePrefix?: boolean;
210
242
  pivotButton?: boolean;
243
+ applyFont?: boolean;
244
+ applyFill?: boolean;
245
+ applyBorder?: boolean;
246
+ applyNumberFormat?: boolean;
247
+ applyAlignment?: boolean;
248
+ applyProtection?: boolean;
211
249
  }
212
250
  interface TableStylesInfo {
213
251
  count?: number;
@@ -215,8 +253,12 @@ interface TableStylesInfo {
215
253
  defaultPivotStyle?: string;
216
254
  tableStyles?: CustomTableStyleOptions[];
217
255
  }
256
+ interface NumFmtEntry {
257
+ numFmtId: number;
258
+ formatCode: string;
259
+ }
218
260
  interface StylesParseResult {
219
- customNumFmtById?: Map<number, string>;
261
+ numFmts?: NumFmtEntry[];
220
262
  fonts?: FontOptions[];
221
263
  fills?: CellFillOptions[];
222
264
  borders?: BorderSideOptions[];
@@ -236,6 +278,11 @@ interface StylesDocOptions {
236
278
  declare const stylesDesc: CustomDescriptor<StylesDocOptions, WriteContext, StylesParseResult>;
237
279
  //#endregion
238
280
  //#region src/parts/workbook/types.d.ts
281
+ interface WorkbookExtensionOptions {
282
+ uri: string;
283
+ namespaces?: Record<string, string>;
284
+ content?: string;
285
+ }
239
286
  interface SheetDefinition {
240
287
  name: string;
241
288
  sheetId: number;
@@ -251,7 +298,7 @@ interface TablePartReference {
251
298
  }
252
299
  interface CustomWorkbookViewOptions {
253
300
  name: string;
254
- guid: string;
301
+ guid: Guid;
255
302
  windowWidth: number;
256
303
  windowHeight: number;
257
304
  activeSheetId: number;
@@ -263,7 +310,7 @@ interface CustomWorkbookViewOptions {
263
310
  showVerticalScroll?: boolean;
264
311
  showSheetTabs?: boolean;
265
312
  tabRatio?: number;
266
- visibility?: "visible" | "hidden" | "veryHidden";
313
+ showObjects?: "all" | "placeholders" | "none";
267
314
  includeHiddenRowCol?: boolean;
268
315
  includePrintSettings?: boolean;
269
316
  personalView?: boolean;
@@ -273,7 +320,7 @@ interface CustomWorkbookViewOptions {
273
320
  mergeInterval?: number;
274
321
  changesSavedWin?: boolean;
275
322
  onlySync?: boolean;
276
- showComments?: string;
323
+ showComments?: "none" | "indicator" | "comment";
277
324
  }
278
325
  interface WorkbookProtectionOptions {
279
326
  lockStructure?: boolean;
@@ -281,13 +328,13 @@ interface WorkbookProtectionOptions {
281
328
  lockRevision?: boolean;
282
329
  workbookPassword?: string;
283
330
  workbookAlgorithmName?: string;
284
- workbookHashValue?: string;
285
- workbookSaltValue?: string;
331
+ workbookHashValue?: Base64;
332
+ workbookSaltValue?: Base64;
286
333
  workbookSpinCount?: number;
287
334
  revisionsPassword?: string;
288
335
  revisionsAlgorithmName?: string;
289
- revisionsHashValue?: string;
290
- revisionsSaltValue?: string;
336
+ revisionsHashValue?: Base64;
337
+ revisionsSaltValue?: Base64;
291
338
  revisionsSpinCount?: number;
292
339
  workbookPasswordCharacterSet?: string;
293
340
  revisionsPasswordCharacterSet?: string;
@@ -305,7 +352,7 @@ interface WebPublishingOptions {
305
352
  longFileNames?: boolean;
306
353
  vml?: boolean;
307
354
  allowPng?: boolean;
308
- targetScreenSize?: string;
355
+ targetScreenSize?: "544x376" | "640x480" | "720x512" | "800x600" | "1024x768" | "1152x882" | "1152x900" | "1280x1024" | "1600x1200" | "1800x1440" | "1920x1200";
309
356
  dpi?: number;
310
357
  codePage?: number;
311
358
  characterSet?: string;
@@ -313,16 +360,16 @@ interface WebPublishingOptions {
313
360
  interface FileSharingOptions {
314
361
  readOnlyRecommended?: boolean;
315
362
  userName?: string;
316
- reservationPassword?: string;
363
+ reservationPassword?: UnsignedShortHex;
317
364
  algorithmName?: string;
318
- hashValue?: string;
319
- saltValue?: string;
365
+ hashValue?: Base64;
366
+ saltValue?: Base64;
320
367
  spinCount?: number;
321
368
  }
322
369
  interface WorkbookPropertiesOptions {
323
370
  date1904?: boolean;
324
371
  defaultThemeVersion?: number;
325
- showObjects?: string;
372
+ showObjects?: "all" | "placeholders" | "none";
326
373
  hidePivotFieldList?: boolean;
327
374
  allowRefreshQuery?: boolean;
328
375
  filterPrivacy?: boolean;
@@ -332,7 +379,7 @@ interface WorkbookPropertiesOptions {
332
379
  promptedSolutions?: boolean;
333
380
  showInkAnnotation?: boolean;
334
381
  saveExternalLinkValues?: boolean;
335
- updateLinks?: string;
382
+ updateLinks?: "userSet" | "never" | "always";
336
383
  showPivotChartFilter?: boolean;
337
384
  publishItems?: boolean;
338
385
  checkCompatibility?: boolean;
@@ -358,14 +405,15 @@ interface VolTopicRefOptions {
358
405
  sheetIndex: number;
359
406
  }
360
407
  interface WebPublishObjectOptions {
361
- rId: string;
362
- destinationFile?: string;
363
- autoRepublish?: boolean;
364
- title?: string;
408
+ id: number;
409
+ divId: string;
410
+ destinationFile: string;
365
411
  sourceObject?: string;
412
+ title?: string;
413
+ autoRepublish?: boolean;
366
414
  }
367
415
  interface CalculationPropertiesOptions {
368
- calcMode?: string;
416
+ calcMode?: "manual" | "auto" | "autoNoTable";
369
417
  calcId?: number;
370
418
  fullCalcOnLoad?: boolean;
371
419
  calcOnSave?: boolean;
@@ -375,7 +423,7 @@ interface CalculationPropertiesOptions {
375
423
  iterate?: boolean;
376
424
  iterateCount?: number;
377
425
  iterateDelta?: number;
378
- refMode?: string;
426
+ refMode?: "A1" | "R1C1";
379
427
  fullPrecision?: boolean;
380
428
  calcCompleted?: boolean;
381
429
  }
@@ -417,6 +465,13 @@ interface FileVersionOptions {
417
465
  lowestEdited?: number;
418
466
  rupBuild?: number;
419
467
  }
468
+ interface RevisionPtrOptions {
469
+ revisionIdLastSave?: number;
470
+ documentId?: string;
471
+ coauthVersionLast?: number;
472
+ coauthVersionMax?: number;
473
+ uidLastSave?: Guid;
474
+ }
420
475
  type SmartTagShow = "all" | "none" | "noIndicator";
421
476
  interface SmartTagPropertiesOptions {
422
477
  embed?: boolean;
@@ -429,6 +484,9 @@ interface SmartTagTypeOptions {
429
484
  }
430
485
  interface WorkbookDescriptorOptions {
431
486
  fileVersion?: FileVersionOptions;
487
+ absPath?: string;
488
+ revisionPtr?: RevisionPtrOptions;
489
+ extensions?: WorkbookExtensionOptions[];
432
490
  sheets: SheetDefinition[];
433
491
  pivotCaches?: PivotCacheReference[];
434
492
  protection?: WorkbookProtectionOptions;
@@ -441,8 +499,8 @@ interface WorkbookDescriptorOptions {
441
499
  fileSharing?: FileSharingOptions;
442
500
  workbookPr?: WorkbookPropertiesOptions;
443
501
  calcPr?: CalculationPropertiesOptions;
502
+ oleSize?: string;
444
503
  bookView?: WorkbookViewOptions;
445
- volTypes?: VolTypeOptions[];
446
504
  webPublishObjects?: WebPublishObjectOptions[];
447
505
  definedNames?: DefinedNameOptions[];
448
506
  conformance?: WorkbookConformance;
@@ -469,374 +527,144 @@ interface CalcChainOptions {
469
527
  }
470
528
  declare const calcChainDesc: CustomDescriptor<CalcChainOptions>;
471
529
  //#endregion
472
- //#region src/parts/chartsheet.d.ts
473
- interface ChartsheetPageMargins {
474
- left?: number | UniversalMeasure;
475
- right?: number | UniversalMeasure;
476
- top?: number | UniversalMeasure;
477
- bottom?: number | UniversalMeasure;
478
- header?: number | UniversalMeasure;
479
- footer?: number | UniversalMeasure;
480
- }
481
- interface ChartsheetPageSetup {
482
- paperSize?: number;
483
- orientation?: string;
484
- horizontalDpi?: number;
485
- verticalDpi?: number;
486
- copies?: number;
487
- }
488
- interface ChartsheetProtectionOptions {
489
- content?: boolean;
490
- objects?: boolean;
491
- }
492
- interface ChartsheetHeaderFooterOptions {
493
- differentFirst?: boolean;
494
- differentOddEven?: boolean;
495
- oddHeader?: string;
496
- oddFooter?: string;
530
+ //#region src/parts/drawing/types.d.ts
531
+ declare const ANCHOR_TYPES: {
532
+ readonly twoCell: "twoCell";
533
+ readonly oneCell: "oneCell";
534
+ readonly absolute: "absolute";
535
+ };
536
+ type AnchorType = (typeof ANCHOR_TYPES)[keyof typeof ANCHOR_TYPES];
537
+ declare const EDIT_AS_TYPES: {
538
+ readonly twoCell: "twoCell";
539
+ readonly oneCell: "oneCell";
540
+ readonly absolute: "absolute";
541
+ };
542
+ type EditAsType = (typeof EDIT_AS_TYPES)[keyof typeof EDIT_AS_TYPES];
543
+ interface DrawingAnchorOptions {
544
+ col: number;
545
+ colOffset?: number | UniversalMeasure;
546
+ row: number;
547
+ rowOffset?: number | UniversalMeasure;
548
+ toCol?: number;
549
+ toRow?: number;
550
+ toColOffset?: number | UniversalMeasure;
551
+ toRowOffset?: number | UniversalMeasure;
552
+ anchorType?: AnchorType;
553
+ editAs?: EditAsType;
554
+ absoluteX?: number | UniversalMeasure;
555
+ absoluteY?: number | UniversalMeasure;
556
+ extentCx?: number | UniversalMeasure;
557
+ extentCy?: number | UniversalMeasure;
558
+ locksWithSheet?: boolean;
559
+ printsWithSheet?: boolean;
560
+ zOrder?: number;
561
+ shapeId?: number;
497
562
  }
498
- interface ChartsheetOptions {
499
- name?: string;
500
- tabColor?: string;
501
- pageMargins?: ChartsheetPageMargins;
502
- pageSetup?: ChartsheetPageSetup;
503
- headerFooter?: ChartsheetHeaderFooterOptions;
504
- sheetProtection?: ChartsheetProtectionOptions;
505
- published?: boolean;
506
- codeName?: string;
507
- zoomToFit?: boolean;
508
- chart: {
509
- type: string;
510
- title?: string;
511
- categories?: string[];
512
- series: {
513
- name: string;
514
- values: number[];
515
- }[];
516
- };
563
+ declare function pickAnchorOptions<T extends DrawingAnchorOptions>(source: T): DrawingAnchorOptions;
564
+ interface DrawingPictureOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions$1 {
565
+ rId: string;
566
+ linkRId?: string;
567
+ spPr?: ShapePropertiesOptions;
568
+ hyperlink?: TextHyperlinkOptions;
569
+ sourceRectangle?: SourceRectangleOptions;
570
+ blackWhiteMode?: BlackWhiteMode;
571
+ locking?: PictureLockingOptions;
572
+ preferRelativeResize?: boolean;
573
+ blipEffects?: BlipEffectsOptions;
574
+ useLocalDpi?: boolean;
575
+ blipExt?: string;
576
+ }
577
+ interface DrawingChartOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions$1 {
578
+ rId: string;
579
+ hyperlink?: TextHyperlinkOptions;
580
+ frameLocks?: GraphicFrameLockingOptions;
581
+ macro?: string;
517
582
  }
518
- interface ChartsheetDescriptorOptions extends ChartsheetOptions {
519
- drawingRId: string;
583
+ interface DrawingSmartArtOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions$1 {
584
+ dataRId: string;
585
+ layoutRId: string;
586
+ quickStyleRId: string;
587
+ colorsRId: string;
588
+ frameLocks?: GraphicFrameLockingOptions;
589
+ macro?: string;
520
590
  }
521
- declare const chartsheetDesc: CustomDescriptor<ChartsheetDescriptorOptions>;
522
- //#endregion
523
- //#region src/parts/connection.d.ts
524
- interface DatabasePropertiesOptions {
525
- connection: string;
526
- command?: string;
527
- serverCommand?: string;
528
- commandType?: number;
591
+ interface ShapeOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions$1 {
592
+ hyperlink?: TextHyperlinkOptions;
593
+ locking?: ShapeLockingOptions;
594
+ spPr: ShapePropertiesOptions;
595
+ textBody?: TextBodyOptions;
596
+ style?: DefaultShapeStyleOptions;
597
+ macro?: string;
598
+ textlink?: string;
599
+ textBox?: boolean;
529
600
  }
530
- type WebTableSelection = string | number | null;
531
- interface WebPropertiesOptions {
532
- url?: string;
533
- xml?: boolean;
534
- sourceData?: boolean;
535
- parsePre?: boolean;
536
- consecutive?: boolean;
537
- firstRow?: boolean;
538
- xl97?: boolean;
539
- textDates?: boolean;
540
- xl2000?: boolean;
541
- post?: string;
542
- htmlTables?: boolean;
543
- htmlFormat?: string;
544
- editPage?: string;
545
- tables?: WebTableSelection[];
601
+ interface ConnectorOptions extends DrawingAnchorOptions, BaseConnectorOptions {
602
+ hyperlink?: TextHyperlinkOptions;
603
+ spPr: ShapePropertiesOptions;
604
+ style?: DefaultShapeStyleOptions;
605
+ macro?: string;
546
606
  }
547
- interface ConnectionTextFieldOptions {
548
- type?: string;
549
- position?: number;
607
+ interface GroupShapeChildOptions extends NonVisualDrawingPropertiesOptions$1 {
608
+ hyperlink?: TextHyperlinkOptions;
609
+ spPr: ShapePropertiesOptions;
610
+ textBody?: TextBodyOptions;
611
+ style?: DefaultShapeStyleOptions;
612
+ macro?: string;
613
+ textlink?: string;
614
+ locking?: ShapeLockingOptions;
615
+ textBox?: boolean;
550
616
  }
551
- interface TextPropertiesOptions {
552
- prompt?: boolean;
553
- fileType?: "mac" | "win" | "dos";
554
- codePage?: number;
555
- characterSet?: string;
556
- firstRow?: number;
557
- sourceFile?: string;
558
- delimited?: boolean;
559
- delimiter?: string;
560
- decimal?: string;
561
- thousands?: string;
562
- tab?: boolean;
563
- space?: boolean;
564
- comma?: boolean;
565
- semicolon?: boolean;
566
- consecutive?: boolean;
567
- qualifier?: "doubleQuote" | "singleQuote" | "none";
568
- textFields?: ConnectionTextFieldOptions[];
617
+ interface GroupConnectorChildOptions extends BaseConnectorOptions {
618
+ hyperlink?: TextHyperlinkOptions;
619
+ spPr: ShapePropertiesOptions;
620
+ style?: DefaultShapeStyleOptions;
621
+ macro?: string;
569
622
  }
570
- interface ParameterOptions {
571
- name?: string;
572
- sqlType?: number;
573
- parameterType?: "prompt" | "value" | "cell";
574
- refreshOnChange?: boolean;
575
- prompt?: string;
576
- boolean?: boolean;
577
- double?: number;
578
- integer?: number;
579
- string?: string;
580
- cell?: string;
623
+ interface GroupOptions extends DrawingAnchorOptions, BaseGroupOptions {
624
+ hyperlink?: TextHyperlinkOptions;
625
+ grpSpPr: GroupTransform2DOptions;
626
+ shapes?: GroupShapeChildOptions[];
627
+ connectors?: GroupConnectorChildOptions[];
581
628
  }
582
- interface ConnectionOptions {
583
- id: number;
584
- name?: string;
585
- type?: number;
586
- refreshedVersion: number;
587
- minRefreshableVersion?: number;
588
- refreshOnLoad?: boolean;
589
- backgroundRefresh?: boolean;
590
- saveData?: boolean;
591
- savePassword?: boolean;
592
- description?: string;
593
- credentials?: string;
594
- interval?: number;
595
- keepAlive?: boolean;
596
- new?: boolean;
597
- deleted?: boolean;
598
- sourceFile?: string;
599
- odcFile?: string;
600
- onlyUseConnectionFile?: boolean;
601
- reconnectionMethod?: number;
602
- singleSignOnId?: string;
603
- dbPr?: DatabasePropertiesOptions;
604
- webPr?: WebPropertiesOptions;
605
- textPr?: TextPropertiesOptions;
606
- parameters?: ParameterOptions[];
629
+ interface DrawingContentPartOptions extends DrawingAnchorOptions {
630
+ rId: string;
607
631
  }
608
- interface ConnectionsOptions {
609
- connections: ConnectionOptions[];
632
+ interface DrawingOptions {
633
+ images?: DrawingPictureOptions[];
634
+ charts?: DrawingChartOptions[];
635
+ smartArts?: DrawingSmartArtOptions[];
636
+ shapes?: ShapeOptions[];
637
+ connectors?: ConnectorOptions[];
638
+ groups?: GroupOptions[];
639
+ contentParts?: DrawingContentPartOptions[];
610
640
  }
611
- declare const connectionsDesc: CustomDescriptor<ConnectionsOptions>;
612
641
  //#endregion
613
- //#region src/parts/dialogsheet.d.ts
614
- interface DialogsheetPageMargins {
615
- left?: number | UniversalMeasure;
616
- right?: number | UniversalMeasure;
617
- top?: number | UniversalMeasure;
618
- bottom?: number | UniversalMeasure;
619
- header?: number | UniversalMeasure;
620
- footer?: number | UniversalMeasure;
621
- }
622
- interface DialogsheetPageSetup {
623
- paperSize?: number;
624
- orientation?: string;
625
- horizontalDpi?: number;
626
- verticalDpi?: number;
627
- copies?: number;
628
- }
629
- interface DialogsheetProtectionOptions {
630
- content?: boolean;
631
- objects?: boolean;
632
- scenarios?: boolean;
633
- }
634
- interface DialogsheetOptions {
642
+ //#region src/parts/drawing/descriptor.d.ts
643
+ declare const drawingDesc: CustomDescriptor<DrawingOptions>;
644
+ //#endregion
645
+ //#region src/parts/pivot/pivot-utils.d.ts
646
+ declare const ConsolidateFunction: {
647
+ readonly SUM: "sum";
648
+ readonly COUNT: "count";
649
+ readonly AVERAGE: "average";
650
+ readonly MAX: "max";
651
+ readonly MIN: "min";
652
+ readonly PRODUCT: "product";
653
+ readonly COUNT_NUMS: "countNumbers";
654
+ readonly STD_DEV: "standardDeviation";
655
+ readonly STD_DEV_P: "standardDeviationPopulation";
656
+ readonly VAR: "variance";
657
+ readonly VAR_P: "variancePopulation";
658
+ };
659
+ type ConsolidateFunction = (typeof ConsolidateFunction)[keyof typeof ConsolidateFunction];
660
+ interface PivotDataField {
661
+ field: string;
662
+ summarize?: ConsolidateFunction;
635
663
  name?: string;
636
- tabColor?: string;
637
- published?: boolean;
638
- codeName?: string;
639
- pageMargins?: DialogsheetPageMargins;
640
- pageSetup?: DialogsheetPageSetup;
641
- sheetProtection?: DialogsheetProtectionOptions;
642
- extLst?: string;
643
- }
644
- declare const dialogsheetDesc: CustomDescriptor<DialogsheetOptions>;
645
- //#endregion
646
- //#region src/parts/external-link.d.ts
647
- interface ExternalDefinedNameOptions {
648
- name: string;
649
- refersTo?: string;
650
- sheetId?: number;
651
- publishToServer?: boolean;
652
- vbProcedure?: boolean;
653
- workbookParameter?: boolean;
654
- xlm?: boolean;
655
- }
656
- interface ExternalCellOptions {
657
- reference: string;
658
- type?: string;
659
- value?: string;
660
- valueMetadataIndex?: number;
661
- }
662
- interface ExternalBookOptions {
663
- target?: string;
664
- sheetNames?: string[];
665
- definedNames?: ExternalDefinedNameOptions[];
666
- sheetDataSet?: ExternalSheetDataOptions[];
667
- }
668
- interface ExternalRowOptions {
669
- rowNumber: number;
670
- cells?: ExternalCellOptions[];
671
- }
672
- interface ExternalSheetDataOptions {
673
- sheetId: number;
674
- refreshError?: boolean;
675
- rows?: ExternalRowOptions[];
676
- }
677
- interface ExternalLinkOptions {
678
- externalBook?: ExternalBookOptions;
679
- bookRId?: string;
680
- ddeLink?: DdeLinkOptions;
681
- oleLink?: OleLinkOptions;
682
- oleRId?: string;
683
- }
684
- interface DdeValueOptions {
685
- type?: "nil" | "b" | "n" | "e" | "str";
686
- value: string;
687
- }
688
- interface DdeValuesOptions {
689
- rows?: number;
690
- cols?: number;
691
- values: DdeValueOptions[];
692
- }
693
- interface DdeItemOptions {
694
- name?: string;
695
- ole?: boolean;
696
- advise?: boolean;
697
- preferPic?: boolean;
698
- values?: DdeValuesOptions;
699
- }
700
- interface DdeLinkOptions {
701
- ddeService: string;
702
- ddeTopic: string;
703
- ddeItems?: DdeItemOptions[];
704
- }
705
- interface OleItemOptions {
706
- name: string;
707
- icon?: boolean;
708
- advise?: boolean;
709
- preferPic?: boolean;
710
- }
711
- interface OleLinkOptions {
712
- progId?: string;
713
- oleItems?: OleItemOptions[];
714
- }
715
- declare const externalLinkDesc: CustomDescriptor<ExternalLinkOptions>;
716
- //#endregion
717
- //#region src/parts/metadata.d.ts
718
- interface MetadataTypeOptions {
719
- name: string;
720
- minSupportedVersion: number;
721
- ghostRow?: boolean;
722
- ghostCol?: boolean;
723
- edit?: boolean;
724
- delete?: boolean;
725
- copy?: boolean;
726
- pasteAll?: boolean;
727
- pasteFormulas?: boolean;
728
- pasteValues?: boolean;
729
- pasteFormats?: boolean;
730
- pasteComments?: boolean;
731
- pasteDataValidation?: boolean;
732
- pasteBorders?: boolean;
733
- pasteColWidths?: boolean;
734
- pasteNumberFormats?: boolean;
735
- merge?: boolean;
736
- splitFirst?: boolean;
737
- splitAll?: boolean;
738
- rowColShift?: boolean;
739
- clearAll?: boolean;
740
- clearFormats?: boolean;
741
- clearContents?: boolean;
742
- clearComments?: boolean;
743
- assign?: boolean;
744
- coerce?: boolean;
745
- adjust?: boolean;
746
- cellMeta?: boolean;
747
- }
748
- interface MetadataStringOptions {
749
- value: string;
750
- }
751
- interface MetadataStringIndexOptions {
752
- index: number;
753
- show?: boolean;
754
- }
755
- interface MdxTupleOptions {
756
- count?: number;
757
- culture?: string;
758
- styleIndex?: number;
759
- formatIndex?: number;
760
- backgroundColor?: string;
761
- foregroundColor?: string;
762
- italic?: boolean;
763
- underline?: boolean;
764
- strikethrough?: boolean;
765
- bold?: boolean;
766
- stringIndexes?: MetadataStringIndexOptions[];
767
- }
768
- interface MdxSetOptions {
769
- namespaceCount: number;
770
- count?: number;
771
- order?: string;
772
- stringIndexes?: MetadataStringIndexOptions[];
773
- }
774
- type MdxFunctionType = "m" | "v" | "s" | "c" | "r" | "p" | "k";
775
- type MdxKpiProperty = "v" | "g" | "s" | "t" | "w" | "m";
776
- interface MdxMemberPropOptions {
777
- nameIndex: number;
778
- namePairIndex: number;
779
- }
780
- interface MdxKpiOptions {
781
- nameIndex: number;
782
- namePairIndex: number;
783
- property: MdxKpiProperty;
784
- }
785
- interface MdxOptions {
786
- functionType: MdxFunctionType;
787
- stringIndex: number;
788
- tuple?: MdxTupleOptions;
789
- set?: MdxSetOptions;
790
- memberProp?: MdxMemberPropOptions;
791
- kpi?: MdxKpiOptions;
792
- }
793
- interface FutureMetadataBlockOptions {
794
- extLst?: string;
795
- }
796
- interface FutureMetadataOptions {
797
- name: string;
798
- blocks?: FutureMetadataBlockOptions[];
799
- }
800
- interface MetadataRecordOptions {
801
- typeIndex: number;
802
- valueIndex: number;
803
- }
804
- interface MetadataBlockOptions {
805
- records?: MetadataRecordOptions[];
806
- }
807
- interface MetadataOptions {
808
- types?: MetadataTypeOptions[];
809
- strings?: MetadataStringOptions[];
810
- mdx?: MdxOptions[];
811
- futureMetadata?: FutureMetadataOptions[];
812
- cellMetadata?: MetadataBlockOptions[];
813
- valueMetadata?: MetadataBlockOptions[];
814
- }
815
- declare const metadataDesc: CustomDescriptor<MetadataOptions>;
816
- //#endregion
817
- //#region src/parts/pivot/pivot-utils.d.ts
818
- declare const ConsolidateFunction: {
819
- readonly SUM: "sum";
820
- readonly COUNT: "count";
821
- readonly AVERAGE: "average";
822
- readonly MAX: "max";
823
- readonly MIN: "min";
824
- readonly PRODUCT: "product";
825
- readonly COUNT_NUMS: "countNums";
826
- readonly STD_DEV: "stdDev";
827
- readonly STD_DEV_P: "stdDevp";
828
- readonly VAR: "var";
829
- readonly VAR_P: "varp";
830
- };
831
- type ConsolidateFunction = (typeof ConsolidateFunction)[keyof typeof ConsolidateFunction];
832
- interface PivotDataField {
833
- field: string;
834
- summarize?: ConsolidateFunction;
835
- name?: string;
836
- showDataAs?: string;
837
- baseField?: number;
838
- baseItem?: number;
839
- sortByTupleItems?: number[];
664
+ showDataAs?: "normal" | "difference" | "percent" | "percentDiff" | "runTotal" | "percentOfRow" | "percentOfCol" | "percentOfTotal" | "index";
665
+ baseField?: number;
666
+ baseItem?: number;
667
+ sortByTupleItems?: number[];
840
668
  }
841
669
  interface PivotFieldOverrideOptions {
842
670
  field: string;
@@ -945,7 +773,7 @@ type PivotFilterType = (typeof PivotFilterType)[keyof typeof PivotFilterType];
945
773
  interface PivotFilterOptions {
946
774
  fld: number;
947
775
  type: PivotFilterType;
948
- id: number;
776
+ id?: number;
949
777
  mpFld?: number;
950
778
  evalOrder?: number;
951
779
  iMeasureHier?: number;
@@ -955,6 +783,11 @@ interface PivotFilterOptions {
955
783
  stringValue1?: string;
956
784
  stringValue2?: string;
957
785
  }
786
+ interface PivotPageFieldOptions {
787
+ field: string;
788
+ caption?: string;
789
+ item?: number;
790
+ }
958
791
  interface PivotTableOptions {
959
792
  name?: string;
960
793
  source: string;
@@ -965,8 +798,7 @@ interface PivotTableOptions {
965
798
  data: PivotDataField[];
966
799
  style?: string;
967
800
  filters?: PivotFilterOptions[];
968
- pages?: string[];
969
- pageCaptions?: string[];
801
+ pages?: PivotPageFieldOptions[];
970
802
  dataOnRows?: boolean;
971
803
  grandTotalCaption?: string;
972
804
  errorCaption?: string;
@@ -1018,7 +850,6 @@ interface PivotTableOptions {
1018
850
  chartFormats?: ChartFormatOptions[];
1019
851
  chartFormat?: boolean;
1020
852
  preserveFormatting?: boolean;
1021
- pageFieldItems?: number[];
1022
853
  autoSortScope?: PivotAreaOptions;
1023
854
  memberProperties?: MemberPropertyOptions[];
1024
855
  formats?: PivotFormatOptions[];
@@ -1270,11 +1101,10 @@ interface MeasureDimensionMapOptions {
1270
1101
  dimension?: number;
1271
1102
  }
1272
1103
  interface OLAPPropertiesOptions {
1273
- local?: string;
1104
+ local?: boolean;
1274
1105
  localConnection?: string;
1275
1106
  sendLocale?: boolean;
1276
1107
  rowDrillCount?: number;
1277
- colDrillCount?: number;
1278
1108
  localRefresh?: boolean;
1279
1109
  serverFill?: boolean;
1280
1110
  serverNumberFormat?: boolean;
@@ -1331,1276 +1161,1587 @@ interface PivotCacheDefinitionOptions {
1331
1161
  olapPr?: OLAPPropertiesOptions;
1332
1162
  }
1333
1163
  //#endregion
1334
- //#region src/parts/pivot-cache.d.ts
1335
- type PivotCacheRecordEntry = {
1336
- type: "string";
1337
- v: number;
1338
- } | {
1339
- type: "number";
1340
- v: number;
1341
- } | {
1342
- type: "date";
1343
- v: string;
1344
- } | {
1345
- type: "error";
1346
- v: string;
1347
- } | {
1348
- type: "missing";
1349
- };
1350
- interface PivotCacheRecordsDescriptorOptions {
1351
- sourceData: PivotSourceData;
1352
- records?: PivotCacheRecordEntry[][];
1164
+ //#region src/parts/query-table.d.ts
1165
+ interface QueryTableDeletedFieldOptions {
1166
+ name: string;
1353
1167
  }
1354
- interface PivotCacheDefDescriptorOptions {
1355
- sourceRef: string;
1356
- sourceSheet: string;
1357
- sourceData: PivotSourceData;
1358
- recordsRid: string;
1359
- cacheDefOpts?: PivotCacheDefinitionOptions;
1168
+ interface QueryTableFieldOptions {
1169
+ id: number;
1170
+ name?: string;
1171
+ dataBound?: boolean;
1172
+ rowNumbers?: boolean;
1173
+ fillFormulas?: boolean;
1174
+ clipped?: boolean;
1175
+ tableColumnId?: number;
1360
1176
  }
1361
- interface PivotCacheDefWorksheetSource {
1362
- ref?: string;
1363
- sheet?: string;
1177
+ interface QueryTableRefreshOptions {
1178
+ preserveSortFilterLayout?: boolean;
1179
+ fieldIdWrapped?: boolean;
1180
+ headersInLastRefresh?: boolean;
1181
+ minimumVersion?: number;
1182
+ nextId?: number;
1183
+ unboundColumnsLeft?: number;
1184
+ unboundColumnsRight?: number;
1185
+ queryTableFields?: QueryTableFieldOptions[];
1186
+ deletedFields?: QueryTableDeletedFieldOptions[];
1364
1187
  }
1365
- interface PivotCacheDefCacheField {
1188
+ interface QueryTableOptions {
1366
1189
  name?: string;
1367
- numFmtId?: number;
1368
- sharedItems?: (string | number)[];
1369
- }
1370
- interface PivotCacheDefParseResult {
1371
- invalid?: boolean;
1372
- saveData?: boolean;
1373
- optimizeMemory?: boolean;
1374
- enableRefresh?: boolean;
1375
- refreshedBy?: string;
1376
- refreshedDate?: number;
1377
- refreshedDateIso?: string;
1378
- backgroundQuery?: boolean;
1379
- missingItemsLimit?: number;
1380
- upgradeOnRefresh?: boolean;
1381
- supportSubquery?: boolean;
1382
- supportAdvancedDrill?: boolean;
1190
+ headers?: boolean;
1191
+ rowNumbers?: boolean;
1192
+ disableRefresh?: boolean;
1193
+ backgroundRefresh?: boolean;
1194
+ firstBackgroundRefresh?: boolean;
1383
1195
  refreshOnLoad?: boolean;
1384
- tupleCache?: boolean;
1385
- recordCount?: number;
1386
- sourceType?: string;
1387
- worksheetSource?: PivotCacheDefWorksheetSource;
1388
- cacheFields?: PivotCacheDefCacheField[];
1389
- }
1390
- interface PivotCacheRecordsParseResult {
1391
- records: PivotCacheRecordEntry[][];
1196
+ growShrinkType?: "insertDelete" | "insertWhole" | "overwriteWhole";
1197
+ fillFormulas?: boolean;
1198
+ removeDataOnSave?: boolean;
1199
+ disableEdit?: boolean;
1200
+ preserveFormatting?: boolean;
1201
+ adjustColumnWidth?: boolean;
1202
+ connectionId: number;
1203
+ autoFormat?: boolean;
1204
+ intermediate?: boolean;
1205
+ queryTableRefresh?: QueryTableRefreshOptions;
1392
1206
  }
1393
- declare const pivotCacheDefDesc: CustomDescriptor<PivotCacheDefDescriptorOptions, WriteContext, PivotCacheDefParseResult>;
1394
- declare const pivotCacheRecordsDesc: CustomDescriptor<PivotCacheRecordsDescriptorOptions, WriteContext, PivotCacheRecordsParseResult>;
1207
+ declare const queryTableDesc: CustomDescriptor<QueryTableOptions>;
1395
1208
  //#endregion
1396
- //#region src/parts/revision-log/types.d.ts
1397
- type RowColumnAction = "insertRow" | "deleteRow" | "insertCol" | "deleteCol";
1398
- type RevisionAction = "add" | "delete";
1399
- interface RevisionHeaderEntry {
1400
- guid: string;
1401
- dateTime: string;
1402
- userName: string;
1403
- rId: string;
1404
- maxSheetId: number;
1405
- sheetIds: number[];
1406
- reviewed?: number[];
1407
- minRId?: number;
1408
- maxRId?: number;
1209
+ //#region src/parts/worksheet/descriptor.d.ts
1210
+ declare const worksheetDesc: CustomDescriptor<WorksheetOptions>;
1211
+ //#endregion
1212
+ //#region src/parts/worksheet/stringify.d.ts
1213
+ declare function stringifyWorksheet(opts: WorksheetOptions, ctx: WorksheetContext): string;
1214
+ //#endregion
1215
+ //#region src/parts/shared-strings.d.ts
1216
+ type SstEntry = string | RichTextOptions;
1217
+ declare class SharedStrings {
1218
+ private entries;
1219
+ private indexMap;
1220
+ private richIndexMap;
1221
+ register(s: string): number;
1222
+ registerRich(rst: RichTextOptions): number;
1223
+ loadEntries(entries: SharedStringsDocOptions["entries"]): void;
1224
+ get count(): number;
1225
+ toDescriptorOptions(): {
1226
+ entries: SstEntry[];
1227
+ };
1228
+ serialize(): string;
1409
1229
  }
1410
- interface RevisionHeadersOptions {
1411
- guid: string;
1412
- headers: RevisionHeaderEntry[];
1413
- lastGuid?: string;
1414
- shared?: boolean;
1415
- diskRevisions?: boolean;
1416
- history?: boolean;
1417
- trackRevisions?: boolean;
1418
- exclusive?: boolean;
1419
- revisionId?: number;
1420
- version?: number;
1421
- keepChangeHistory?: boolean;
1422
- protected?: boolean;
1423
- preserveHistory?: number;
1230
+ interface SharedStringsDocOptions {
1231
+ entries: (string | RichTextOptions)[];
1424
1232
  }
1425
- interface SharedUserOptions {
1426
- guid: string;
1427
- name: string;
1428
- id: number;
1429
- dateTime: string;
1233
+ declare const sharedStringsDesc: CustomDescriptor<SharedStringsDocOptions>;
1234
+ //#endregion
1235
+ //#region src/parts/table.d.ts
1236
+ declare const TotalsRowFunction: {
1237
+ readonly NONE: "none";
1238
+ readonly SUM: "sum";
1239
+ readonly MIN: "min";
1240
+ readonly MAX: "max";
1241
+ readonly AVERAGE: "average";
1242
+ readonly COUNT: "count";
1243
+ readonly COUNT_NUMS: "countNumbers";
1244
+ readonly STD_DEV: "standardDeviation";
1245
+ readonly VAR: "variance";
1246
+ readonly CUSTOM: "custom";
1247
+ };
1248
+ type TotalsRowFunction = (typeof TotalsRowFunction)[keyof typeof TotalsRowFunction];
1249
+ declare const TableType: {
1250
+ readonly WORKSHEET: "worksheet";
1251
+ readonly XML: "xml";
1252
+ readonly QUERY_TABLE: "queryTable";
1253
+ };
1254
+ type TableType = (typeof TableType)[keyof typeof TableType];
1255
+ interface TableStyleInfoOptions {
1256
+ name?: string;
1257
+ showFirstColumn?: boolean;
1258
+ showLastColumn?: boolean;
1259
+ showRowStripes?: boolean;
1260
+ showColumnStripes?: boolean;
1430
1261
  }
1431
- interface UsersOptions {
1432
- users?: SharedUserOptions[];
1262
+ interface TableColumnOptions {
1263
+ name: string;
1264
+ totalsRowFunction?: TotalsRowFunction;
1265
+ totalsRowLabel?: string;
1266
+ calculatedColumnFormula?: string;
1267
+ totalsRowFormula?: string;
1268
+ totalsRowFormulaArray?: boolean;
1269
+ calculatedColumnFormulaArray?: boolean;
1270
+ uniqueName?: string;
1271
+ queryTableFieldId?: number;
1272
+ headerRowDxfId?: number;
1273
+ dataDxfId?: number;
1274
+ totalsRowDxfId?: number;
1275
+ headerRowCellStyle?: string;
1276
+ dataCellStyle?: string;
1277
+ totalsRowCellStyle?: string;
1278
+ xmlColumnPr?: XmlColumnPrOptions;
1433
1279
  }
1434
- interface RevisionUndoOptions {
1435
- index: number;
1436
- expression: "ref" | "refError" | "area" | "areaError" | "computedArea";
1437
- undoRange: string;
1438
- ref3D?: boolean;
1439
- array?: boolean;
1440
- value?: boolean;
1441
- numberFormat?: boolean;
1442
- conditionalStyle?: boolean;
1443
- definedName?: string;
1444
- reference?: string;
1445
- sId?: number;
1280
+ interface XmlColumnPrOptions {
1281
+ mapId: number;
1282
+ xpath: string;
1283
+ denormalized?: boolean;
1284
+ xmlDataType: string;
1446
1285
  }
1447
- type RevisionNestedChild = {
1448
- kind: "undo";
1449
- data: RevisionUndoOptions;
1450
- } | {
1451
- kind: "cellChange";
1452
- data: RevisionCellChangeOptions;
1453
- } | {
1454
- kind: "formatting";
1455
- data: RevisionFormattingOptions;
1456
- };
1457
- interface RevisionRowColumnOptions {
1458
- rId: number;
1459
- sheetId: number;
1286
+ interface TableOptions {
1287
+ id?: number;
1288
+ name?: string;
1289
+ displayName: string;
1290
+ comment?: string;
1460
1291
  ref: string;
1461
- action: RowColumnAction;
1462
- endOfList?: boolean;
1463
- edge?: boolean;
1464
- undo?: boolean;
1465
- rejected?: boolean;
1466
- children?: RevisionNestedChild[];
1467
- }
1468
- interface RevisionMoveOptions {
1469
- rId: number;
1470
- sheetId: number;
1471
- source: string;
1472
- destination: string;
1473
- sourceSheetId?: number;
1474
- undo?: boolean;
1475
- rejected?: boolean;
1476
- children?: RevisionNestedChild[];
1292
+ columns: TableColumnOptions[];
1293
+ headerRowCount?: number;
1294
+ insertRow?: boolean;
1295
+ totalsRowCount?: number;
1296
+ totalsRowShown?: boolean;
1297
+ tableType?: TableType;
1298
+ style?: TableStyleInfoOptions;
1299
+ ext?: string;
1300
+ altText?: string;
1301
+ altTextSummary?: string;
1302
+ autoFilter?: string | AutoFilterOptions;
1303
+ insertRowShift?: boolean;
1304
+ published?: boolean;
1305
+ headerRowDxfId?: number;
1306
+ dataDxfId?: number;
1307
+ totalsRowDxfId?: number;
1308
+ headerRowBorderDxfId?: number;
1309
+ tableBorderDxfId?: number;
1310
+ totalsRowBorderDxfId?: number;
1311
+ headerRowCellStyle?: string;
1312
+ dataCellStyle?: string;
1313
+ totalsRowCellStyle?: string;
1314
+ connectionId?: number;
1477
1315
  }
1478
- interface RevisionCustomViewOptions {
1479
- guid: string;
1480
- action: RevisionAction;
1316
+ declare const tableDesc: CustomDescriptor<TableOptions>;
1317
+ //#endregion
1318
+ //#region src/parts/xml-mapping.d.ts
1319
+ interface SchemaOptions {
1320
+ id: string;
1321
+ schemaRef?: string;
1322
+ namespace?: string;
1323
+ schemaLanguage?: string;
1324
+ content?: string;
1481
1325
  }
1482
- interface RevisionSheetRenameOptions {
1483
- rId: number;
1484
- sheetId: number;
1485
- oldName: string;
1486
- newName: string;
1487
- undo?: boolean;
1488
- rejected?: boolean;
1326
+ interface DataBindingOptions {
1327
+ dataBindingName?: string;
1328
+ fileBinding?: boolean;
1329
+ connectionId?: number;
1330
+ fileBindingName?: string;
1331
+ dataBindingLoadMode: number;
1489
1332
  }
1490
- interface RevisionInsertSheetOptions {
1491
- rId: number;
1492
- sheetId: number;
1333
+ interface MapOptions {
1334
+ id: number;
1493
1335
  name: string;
1494
- sheetPosition: number;
1495
- undo?: boolean;
1496
- rejected?: boolean;
1336
+ rootElement: string;
1337
+ schemaId: string;
1338
+ showImportExportValidationErrors?: boolean;
1339
+ autoFit?: boolean;
1340
+ append?: boolean;
1341
+ preserveSortAFLayout?: boolean;
1342
+ preserveFormat?: boolean;
1343
+ dataBinding?: DataBindingOptions;
1497
1344
  }
1498
- interface RevisionCellChangeOptions {
1499
- rId: number;
1500
- sheetId: number;
1501
- hasOldDxf?: boolean;
1502
- xfDxf?: boolean;
1503
- style?: boolean;
1504
- hasDxf?: boolean;
1505
- numFmtId?: number;
1506
- quotePrefix?: boolean;
1507
- oldQuotePrefix?: boolean;
1508
- phonetic?: boolean;
1509
- oldPhonetic?: boolean;
1510
- endOfListFormulaUpdate?: boolean;
1511
- undo?: boolean;
1512
- rejected?: boolean;
1513
- oldCellXml?: string;
1514
- newCellXml: string;
1515
- oldDxfXml?: string;
1516
- newDxfXml?: string;
1345
+ interface MapInfoOptions {
1346
+ selectionNamespaces: string;
1347
+ schemas: SchemaOptions[];
1348
+ maps: MapOptions[];
1517
1349
  }
1518
- interface RevisionFormattingOptions {
1519
- sheetId: number;
1520
- sqref: string;
1521
- xfDxf?: boolean;
1522
- style?: boolean;
1523
- start?: number;
1524
- length?: number;
1525
- dxfXml?: string;
1350
+ interface XmlPropertiesOptions {
1351
+ mapId: number;
1352
+ xpath: string;
1353
+ xmlDataType: string;
1526
1354
  }
1527
- interface RevisionAutoFormattingOptions {
1528
- sheetId: number;
1529
- ref: string;
1530
- autoFormatXml?: string;
1355
+ interface XmlCellPropertiesOptions {
1356
+ id: number;
1357
+ uniqueName?: string;
1358
+ xmlPr: XmlPropertiesOptions;
1531
1359
  }
1532
- interface RevisionDefinedNameOptions {
1533
- rId: number;
1534
- name: string;
1535
- localSheetId?: number;
1536
- customView?: boolean;
1537
- formula?: string;
1538
- oldFormula?: string;
1539
- function?: boolean;
1540
- oldFunction?: boolean;
1541
- functionGroupId?: number;
1542
- oldFunctionGroupId?: number;
1543
- shortcutKey?: number;
1544
- oldShortcutKey?: number;
1360
+ interface SingleXmlCellOptions {
1361
+ id: number;
1362
+ reference: string;
1363
+ connectionId: number;
1364
+ xmlCellPr: XmlCellPropertiesOptions;
1365
+ }
1366
+ interface SingleXmlCellsOptions {
1367
+ cells: SingleXmlCellOptions[];
1368
+ }
1369
+ interface XmlColumnPropertiesOptions {
1370
+ xpath: string;
1371
+ xmlDataType: string;
1372
+ mapId: number;
1373
+ denormalized?: boolean;
1374
+ }
1375
+ declare const mapInfoDesc: CustomDescriptor<MapInfoOptions>;
1376
+ declare const singleXmlCellsDesc: CustomDescriptor<SingleXmlCellsOptions>;
1377
+ //#endregion
1378
+ //#region src/parts/worksheet/types.d.ts
1379
+ interface ColumnOptions {
1380
+ min: number;
1381
+ max: number;
1382
+ width?: number;
1545
1383
  hidden?: boolean;
1546
- oldHidden?: boolean;
1547
- customMenu?: string;
1548
- oldCustomMenu?: string;
1549
- description?: string;
1550
- oldDescription?: string;
1551
- help?: string;
1552
- oldHelp?: string;
1553
- statusBar?: string;
1554
- oldStatusBar?: string;
1384
+ customWidth?: boolean;
1385
+ outlineLevel?: number;
1386
+ collapsed?: boolean;
1387
+ bestFit?: boolean;
1388
+ phonetic?: boolean;
1389
+ }
1390
+ interface RowOptions {
1391
+ cells?: CellOptions[];
1392
+ height?: number | UniversalMeasure;
1393
+ hidden?: boolean;
1394
+ rowNumber?: number;
1395
+ spans?: string;
1396
+ customFormat?: boolean;
1397
+ thickTop?: boolean;
1398
+ thickBot?: boolean;
1399
+ phonetic?: boolean;
1400
+ outlineLevel?: number;
1401
+ collapsed?: boolean;
1402
+ style?: StyleOptions | number;
1403
+ }
1404
+ type RichTextColor = string;
1405
+ interface RichTextRunPropertiesOptions {
1406
+ font?: string;
1407
+ charset?: number;
1408
+ family?: number;
1409
+ bold?: boolean;
1410
+ italic?: boolean;
1411
+ strike?: boolean;
1412
+ outline?: boolean;
1413
+ shadow?: boolean;
1414
+ condense?: boolean;
1415
+ extend?: boolean;
1416
+ color?: RichTextColor;
1417
+ size?: number;
1418
+ underline?: "single" | "double" | "singleAccounting" | "doubleAccounting" | "none";
1419
+ vertAlign?: "superscript" | "subscript" | "baseline";
1420
+ scheme?: "major" | "minor" | "none";
1421
+ }
1422
+ interface RichTextRunOptions {
1423
+ properties?: RichTextRunPropertiesOptions;
1424
+ text: string;
1425
+ }
1426
+ interface PhoneticRunOptions {
1427
+ startByte: number;
1428
+ endByte: number;
1429
+ text: string;
1430
+ }
1431
+ interface RichTextOptions {
1432
+ text?: string;
1433
+ runs?: RichTextRunOptions[];
1434
+ phonetics?: PhoneticRunOptions[];
1435
+ phoneticProperties?: PhoneticPropertiesOptions;
1436
+ }
1437
+ interface CellOptions {
1438
+ value?: string | number | boolean | Date | RichTextOptions | null;
1439
+ reference?: string;
1440
+ style?: StyleOptions | number;
1441
+ formula?: string | FormulaOptions;
1442
+ cellMetadataId?: number;
1443
+ valueMetadataId?: number;
1444
+ error?: string;
1445
+ }
1446
+ declare const FormulaType: {
1447
+ readonly NORMAL: "normal";
1448
+ readonly ARRAY: "array";
1449
+ readonly SHARED: "shared";
1450
+ };
1451
+ type FormulaType = (typeof FormulaType)[keyof typeof FormulaType];
1452
+ interface FormulaOptions {
1453
+ formula: string;
1454
+ type?: FormulaType;
1455
+ reference?: string;
1456
+ sharedIndex?: number;
1457
+ aca?: boolean;
1458
+ dt2D?: boolean;
1459
+ dtr?: boolean;
1460
+ del1?: boolean;
1461
+ del2?: boolean;
1462
+ inputCell1?: string;
1463
+ inputCell2?: string;
1464
+ calculateCell?: boolean;
1465
+ arrayContext?: boolean;
1466
+ }
1467
+ interface ScenarioCellOptions {
1468
+ reference: string;
1469
+ val: string | number;
1470
+ deleted?: boolean;
1471
+ undone?: boolean;
1472
+ }
1473
+ interface ScenarioDefinition {
1474
+ name: string;
1475
+ inputCells: ScenarioCellOptions[];
1476
+ count?: number;
1477
+ user?: string;
1555
1478
  comment?: string;
1556
- oldComment?: string;
1557
- undo?: boolean;
1558
- rejected?: boolean;
1479
+ hidden?: boolean;
1480
+ locked?: boolean;
1559
1481
  }
1560
- interface RevisionCommentOptions {
1561
- sheetId: number;
1482
+ interface ScenarioOptions {
1483
+ scenarios: ScenarioDefinition[];
1484
+ current?: number;
1485
+ show?: number;
1486
+ }
1487
+ interface MergeCellOptions {
1488
+ ref: string;
1489
+ }
1490
+ interface SheetProtectionOptions {
1491
+ password?: string;
1492
+ algorithmName?: string;
1493
+ hashValue?: Base64;
1494
+ saltValue?: Base64;
1495
+ spinCount?: number;
1496
+ sheet?: boolean;
1497
+ objects?: boolean;
1498
+ scenarios?: boolean;
1499
+ formatCells?: boolean;
1500
+ formatColumns?: boolean;
1501
+ formatRows?: boolean;
1502
+ insertColumns?: boolean;
1503
+ insertRows?: boolean;
1504
+ insertHyperlinks?: boolean;
1505
+ deleteColumns?: boolean;
1506
+ deleteRows?: boolean;
1507
+ selectLockedCells?: boolean;
1508
+ sort?: boolean;
1509
+ autoFilter?: boolean;
1510
+ pivotTables?: boolean;
1511
+ selectUnlockedCells?: boolean;
1512
+ }
1513
+ interface ProtectedRangeOptions {
1514
+ sqref: string;
1515
+ name: string;
1516
+ password?: string;
1517
+ algorithmName?: string;
1518
+ hashValue?: Base64;
1519
+ saltValue?: Base64;
1520
+ spinCount?: number;
1521
+ securityDescriptor?: string;
1522
+ }
1523
+ interface FreezePaneOptions {
1524
+ row?: number;
1525
+ col?: number;
1526
+ split?: boolean;
1527
+ topLeftCell?: string;
1528
+ activePane?: "bottomRight" | "topRight" | "bottomLeft" | "topLeft";
1529
+ }
1530
+ interface PictureOptions extends Omit<BasePictureOptions, "type">, DrawingAnchorOptions {
1531
+ type: "png" | "jpg" | "wmf" | "emf";
1532
+ spPr?: ShapePropertiesOptions;
1533
+ sourceRectangle?: SourceRectangleOptions;
1534
+ blackWhiteMode?: BlackWhiteMode;
1535
+ preferRelativeResize?: boolean;
1536
+ blipEffects?: BlipEffectsOptions;
1537
+ useLocalDpi?: boolean;
1538
+ blipExt?: string;
1539
+ locking?: PictureLockingOptions;
1540
+ hyperlink?: TextHyperlinkOptions;
1541
+ zOrder?: number;
1542
+ shapeId?: number;
1543
+ }
1544
+ interface WorksheetChartOptions extends ChartSpaceOptions, DrawingAnchorOptions, Omit<NonVisualDrawingPropertiesOptions, "title"> {
1545
+ frameLocks?: GraphicFrameLockingOptions;
1546
+ hyperlink?: TextHyperlinkOptions;
1547
+ zOrder?: number;
1548
+ shapeId?: number;
1549
+ macro?: string;
1550
+ }
1551
+ interface WorksheetSmartArtOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions {
1552
+ dataPath: string;
1553
+ layoutPath: string;
1554
+ quickStylePath: string;
1555
+ colorsPath: string;
1556
+ frameLocks?: GraphicFrameLockingOptions;
1557
+ zOrder?: number;
1558
+ shapeId?: number;
1559
+ macro?: string;
1560
+ }
1561
+ interface SheetViewOptions {
1562
+ showGridLines?: boolean;
1563
+ showRowColHeaders?: boolean;
1564
+ showZeros?: boolean;
1565
+ zoomScale?: number;
1566
+ tabSelected?: boolean;
1567
+ rightToLeft?: boolean;
1568
+ windowProtection?: boolean;
1569
+ showFormulas?: boolean;
1570
+ showRuler?: boolean;
1571
+ showOutlineSymbols?: boolean;
1572
+ defaultGridColor?: boolean;
1573
+ showWhiteSpace?: boolean;
1574
+ view?: "normal" | "pageBreakPreview" | "pageLayout";
1575
+ topLeftCell?: string;
1576
+ colorId?: number;
1577
+ zoomScaleNormal?: number;
1578
+ zoomScaleSheetLayoutView?: number;
1579
+ zoomScalePageLayoutView?: number;
1580
+ }
1581
+ interface HyperlinkOptions {
1562
1582
  cell: string;
1563
- guid: string;
1564
- action?: RevisionAction;
1565
- alwaysShow?: boolean;
1566
- old?: boolean;
1567
- hiddenRow?: boolean;
1568
- hiddenColumn?: boolean;
1569
- author: string;
1570
- oldLength?: number;
1571
- newLength?: number;
1583
+ url?: string;
1584
+ location?: string;
1585
+ tooltip?: string;
1586
+ display?: string;
1587
+ }
1588
+ interface HeaderFooterOptions {
1589
+ oddHeader?: string;
1590
+ oddFooter?: string;
1591
+ evenHeader?: string;
1592
+ evenFooter?: string;
1593
+ firstHeader?: string;
1594
+ firstFooter?: string;
1595
+ differentOddEven?: boolean;
1596
+ differentFirst?: boolean;
1597
+ scaleWithDoc?: boolean;
1598
+ alignWithMargins?: boolean;
1599
+ }
1600
+ type PageOrientation = "default" | "portrait" | "landscape";
1601
+ interface PageSetupOptions {
1602
+ paperSize?: number;
1603
+ orientation?: PageOrientation;
1604
+ scale?: number;
1605
+ fitToWidth?: number;
1606
+ fitToHeight?: number;
1607
+ pageOrder?: "downThenOver" | "overThenDown";
1608
+ useFirstPageNumber?: boolean;
1609
+ firstPageNumber?: number;
1610
+ paperHeight?: number | PositiveUniversalMeasure;
1611
+ paperWidth?: number | PositiveUniversalMeasure;
1612
+ usePrinterDefaults?: boolean;
1613
+ blackAndWhite?: boolean;
1614
+ draft?: boolean;
1615
+ cellComments?: "none" | "asDisplayed" | "atEnd";
1616
+ errors?: "displayed" | "blank" | "dash" | "NA";
1617
+ horizontalDpi?: number;
1618
+ verticalDpi?: number;
1619
+ copies?: number;
1620
+ autoPageBreaks?: boolean;
1621
+ fitToPage?: boolean;
1622
+ printerSettingsRId?: string;
1623
+ }
1624
+ interface TabColorOptions {
1625
+ rgb?: ArgbHexColor;
1626
+ theme?: number;
1627
+ tint?: number;
1628
+ indexed?: number;
1629
+ }
1630
+ interface AnchorMarkerOptions {
1631
+ col: number;
1632
+ colOff?: number;
1633
+ row: number;
1634
+ rowOff?: number;
1635
+ }
1636
+ interface ObjectAnchorOptions {
1637
+ moveWithCells?: boolean;
1638
+ sizeWithCells?: boolean;
1639
+ from: AnchorMarkerOptions;
1640
+ to: AnchorMarkerOptions;
1641
+ }
1642
+ interface CommentPropertiesOptions {
1643
+ locked?: boolean;
1644
+ defaultSize?: boolean;
1645
+ print?: boolean;
1646
+ disabled?: boolean;
1647
+ autoFill?: boolean;
1648
+ autoLine?: boolean;
1649
+ altText?: string;
1650
+ textHAlign?: "left" | "center" | "right" | "justify" | "distributed";
1651
+ textVAlign?: "top" | "center" | "bottom" | "justify" | "distributed";
1652
+ lockText?: boolean;
1653
+ justLastX?: boolean;
1654
+ autoScale?: boolean;
1655
+ anchor?: ObjectAnchorOptions;
1572
1656
  }
1573
- interface RevisionQueryTableFieldOptions {
1574
- sheetId: number;
1575
- ref: string;
1576
- fieldId: number;
1657
+ interface CommentOptions {
1658
+ cell: string;
1659
+ author: string;
1660
+ text: string | RichTextOptions;
1661
+ commentPr?: CommentPropertiesOptions;
1662
+ anchor?: NoteAnchorOptions;
1663
+ visible?: boolean;
1664
+ size?: {
1665
+ width: number;
1666
+ height: number;
1667
+ };
1577
1668
  }
1578
- interface RevisionConflictOptions {
1579
- rId: number;
1580
- undo?: boolean;
1581
- rejected?: boolean;
1582
- sheetId?: number;
1669
+ interface NoteAnchorOptions {
1670
+ from: AnchorMarkerOptions;
1671
+ to: AnchorMarkerOptions;
1583
1672
  }
1584
- type RevisionEntry = {
1585
- type: "rowColumn";
1586
- data: RevisionRowColumnOptions;
1587
- } | {
1588
- type: "move";
1589
- data: RevisionMoveOptions;
1590
- } | {
1591
- type: "customView";
1592
- data: RevisionCustomViewOptions;
1593
- } | {
1594
- type: "sheetRename";
1595
- data: RevisionSheetRenameOptions;
1596
- } | {
1597
- type: "insertSheet";
1598
- data: RevisionInsertSheetOptions;
1599
- } | {
1600
- type: "cellChange";
1601
- data: RevisionCellChangeOptions;
1602
- } | {
1603
- type: "formatting";
1604
- data: RevisionFormattingOptions;
1605
- } | {
1606
- type: "autoFormatting";
1607
- data: RevisionAutoFormattingOptions;
1608
- } | {
1609
- type: "definedName";
1610
- data: RevisionDefinedNameOptions;
1611
- } | {
1612
- type: "comment";
1613
- data: RevisionCommentOptions;
1614
- } | {
1615
- type: "queryTableField";
1616
- data: RevisionQueryTableFieldOptions;
1617
- } | {
1618
- type: "conflict";
1619
- data: RevisionConflictOptions;
1620
- };
1621
- interface RevisionLogOptions {
1622
- revisions: RevisionEntry[];
1673
+ type DataValidationType = "none" | "whole" | "decimal" | "list" | "date" | "time" | "textLength" | "custom";
1674
+ type DataValidationOperator = "between" | "notBetween" | "equal" | "notEqual" | "greaterThan" | "lessThan" | "greaterThanOrEqual" | "lessThanOrEqual";
1675
+ interface DataValidationOptions {
1676
+ sqref: string;
1677
+ type?: DataValidationType;
1678
+ operator?: DataValidationOperator;
1679
+ formula1?: string;
1680
+ formula2?: string;
1681
+ allowBlank?: boolean;
1682
+ showErrorMessage?: boolean;
1683
+ errorTitle?: string;
1684
+ error?: string;
1685
+ showInputMessage?: boolean;
1686
+ promptTitle?: string;
1687
+ prompt?: string;
1688
+ errorStyle?: "stop" | "warning" | "information";
1689
+ imeMode?: "noControl" | "on" | "off" | "disabled" | "hiragana" | "fullKatakana" | "halfKatakana" | "fullAlpha" | "halfAlpha" | "fullHangul" | "halfHangul";
1690
+ showDropDown?: boolean;
1623
1691
  }
1624
- //#endregion
1625
- //#region src/parts/drawing/types.d.ts
1626
- declare const ANCHOR_TYPES: {
1627
- readonly twoCell: "twoCell";
1628
- readonly oneCell: "oneCell";
1629
- readonly absolute: "absolute";
1630
- };
1631
- type AnchorType = (typeof ANCHOR_TYPES)[keyof typeof ANCHOR_TYPES];
1632
- declare const EDIT_AS_TYPES: {
1633
- readonly twoCell: "twoCell";
1634
- readonly oneCell: "oneCell";
1635
- readonly absolute: "absolute";
1636
- };
1637
- type EditAsType = (typeof EDIT_AS_TYPES)[keyof typeof EDIT_AS_TYPES];
1638
- interface DrawingAnchorOptions {
1639
- col: number;
1640
- colOffset?: number | UniversalMeasure;
1641
- row: number;
1642
- rowOffset?: number | UniversalMeasure;
1643
- toCol?: number;
1644
- toRow?: number;
1645
- toColOffset?: number | UniversalMeasure;
1646
- toRowOffset?: number | UniversalMeasure;
1647
- anchorType?: AnchorType;
1648
- editAs?: EditAsType;
1649
- absoluteX?: number | UniversalMeasure;
1650
- absoluteY?: number | UniversalMeasure;
1651
- extentCx?: number | UniversalMeasure;
1652
- extentCy?: number | UniversalMeasure;
1653
- locksWithSheet?: boolean;
1654
- printsWithSheet?: boolean;
1692
+ type ConditionalFormatType = "cellIs" | "containsText" | "expression" | "top10" | "aboveAverage" | "colorScale" | "dataBar" | "iconSet";
1693
+ type ConditionalFormatOperator = "lessThan" | "lessThanOrEqual" | "equal" | "notEqual" | "greaterThanOrEqual" | "greaterThan" | "between" | "notBetween" | "containsText" | "notContains" | "beginsWith" | "endsWith";
1694
+ type CfvoType = "num" | "percent" | "max" | "min" | "formula" | "percentile";
1695
+ interface CfvoOptions {
1696
+ type: CfvoType;
1697
+ val?: string | number;
1698
+ gte?: boolean;
1655
1699
  }
1656
- interface DrawingPictureOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions {
1657
- rId: string;
1700
+ type IconSetType = "3Arrows" | "3ArrowsGray" | "3Flags" | "3TrafficLights1" | "3TrafficLights2" | "3Signs" | "3Symbols" | "3Symbols2" | "4Arrows" | "4ArrowsGray" | "4RedToBlack" | "4Rating" | "4TrafficLights" | "5Arrows" | "5ArrowsGray" | "5Rating" | "5Quarters";
1701
+ interface CfColorOptions {
1702
+ rgb?: HexColor;
1703
+ theme?: number;
1704
+ tint?: number;
1705
+ indexed?: number;
1658
1706
  }
1659
- interface DrawingChartOptions extends NonVisualDrawingPropertiesOptions {
1660
- col: number;
1661
- colOffset?: number | UniversalMeasure;
1662
- row: number;
1663
- rowOffset?: number | UniversalMeasure;
1664
- rId: string;
1665
- locksWithSheet?: boolean;
1666
- printsWithSheet?: boolean;
1707
+ interface ColorScaleOptions {
1708
+ cfvo: CfvoOptions[];
1709
+ colors: CfColorOptions[];
1667
1710
  }
1668
- interface ShapeOptions extends DrawingAnchorOptions, NonVisualDrawingPropertiesOptions {
1669
- spPr: ShapePropertiesOptions;
1670
- textBody?: TextBodyOptions;
1671
- macro?: string;
1672
- textlink?: string;
1711
+ interface DataBarOptions {
1712
+ cfvo: [CfvoOptions, CfvoOptions];
1713
+ color: CfColorOptions;
1714
+ minLength?: number;
1715
+ maxLength?: number;
1716
+ showValue?: boolean;
1673
1717
  }
1674
- interface ConnectorOptions extends DrawingAnchorOptions, BaseConnectorOptions {
1675
- spPr: ShapePropertiesOptions;
1676
- macro?: string;
1718
+ interface IconSetOptions {
1719
+ cfvo: CfvoOptions[];
1720
+ iconSet?: IconSetType;
1721
+ showValue?: boolean;
1722
+ percent?: boolean;
1723
+ reverse?: boolean;
1677
1724
  }
1678
- interface GroupShapeChildOptions extends NonVisualDrawingPropertiesOptions {
1679
- spPr: ShapePropertiesOptions;
1680
- textBody?: TextBodyOptions;
1681
- macro?: string;
1682
- textlink?: string;
1725
+ interface ConditionalFormatRule {
1726
+ type: ConditionalFormatType;
1727
+ operator?: ConditionalFormatOperator;
1728
+ formulas?: string[];
1729
+ priority?: number;
1730
+ dxfId?: number;
1731
+ colorScale?: ColorScaleOptions;
1732
+ dataBar?: DataBarOptions;
1733
+ iconSet?: IconSetOptions;
1734
+ stopIfTrue?: boolean;
1735
+ timePeriod?: "today" | "yesterday" | "tomorrow" | "last7Days" | "thisMonth" | "lastMonth" | "nextMonth" | "thisWeek" | "lastWeek" | "nextWeek";
1736
+ rank?: number;
1737
+ bottom?: boolean;
1738
+ percent?: boolean;
1739
+ text?: string;
1740
+ equalAverage?: boolean;
1741
+ aboveAverage?: boolean;
1742
+ stdDev?: number;
1683
1743
  }
1684
- interface GroupConnectorChildOptions extends BaseConnectorOptions {
1685
- spPr: ShapePropertiesOptions;
1686
- macro?: string;
1744
+ interface ConditionalFormatOptions {
1745
+ sqref: string;
1746
+ pivot?: boolean;
1747
+ rules: ConditionalFormatRule[];
1687
1748
  }
1688
- interface GroupOptions extends DrawingAnchorOptions, BaseGroupOptions {
1689
- grpSpPr: GroupTransform2DOptions;
1690
- shapes?: GroupShapeChildOptions[];
1691
- connectors?: GroupConnectorChildOptions[];
1749
+ interface Top10FilterOptions {
1750
+ top?: boolean;
1751
+ percent?: boolean;
1752
+ val: number;
1753
+ filterVal?: number;
1692
1754
  }
1693
- interface DrawingContentPartOptions extends DrawingAnchorOptions {
1694
- rId: string;
1755
+ type CustomFilterOperator = "equal" | "notEqual" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual";
1756
+ interface CustomFilterEntry {
1757
+ operator?: CustomFilterOperator;
1758
+ val: string;
1695
1759
  }
1696
- interface DrawingOptions {
1697
- images?: DrawingPictureOptions[];
1698
- charts?: DrawingChartOptions[];
1699
- shapes?: ShapeOptions[];
1700
- connectors?: ConnectorOptions[];
1701
- groups?: GroupOptions[];
1702
- contentParts?: DrawingContentPartOptions[];
1760
+ interface CustomFiltersOptions {
1761
+ and?: boolean;
1762
+ entries: CustomFilterEntry[];
1703
1763
  }
1704
- //#endregion
1705
- //#region src/parts/drawing/descriptor.d.ts
1706
- declare const drawingDesc: CustomDescriptor<DrawingOptions>;
1707
- //#endregion
1708
- //#region src/parts/query-table.d.ts
1709
- interface QueryTableDeletedFieldOptions {
1710
- name: string;
1764
+ interface SortCondition {
1765
+ ref: string;
1766
+ descending?: boolean;
1767
+ sortBy?: "value" | "cellColor" | "fontColor" | "icon";
1768
+ customList?: string;
1769
+ dxfId?: number;
1770
+ iconSet?: IconSetType;
1771
+ iconId?: number;
1711
1772
  }
1712
- interface QueryTableFieldOptions {
1713
- id: number;
1714
- name?: string;
1715
- dataBound?: boolean;
1716
- rowNumbers?: boolean;
1717
- fillFormulas?: boolean;
1718
- clipped?: boolean;
1719
- tableColumnId?: number;
1773
+ interface SortStateOptions {
1774
+ ref: string;
1775
+ columnSort?: boolean;
1776
+ caseSensitive?: boolean;
1777
+ sortMethod?: "pinYin" | "stroke" | "none";
1778
+ conditions: SortCondition[];
1720
1779
  }
1721
- interface QueryTableRefreshOptions {
1722
- preserveSortFilterLayout?: boolean;
1723
- fieldIdWrapped?: boolean;
1724
- headersInLastRefresh?: boolean;
1725
- minimumVersion?: number;
1726
- nextId?: number;
1727
- unboundColumnsLeft?: number;
1728
- unboundColumnsRight?: number;
1729
- queryTableFields?: QueryTableFieldOptions[];
1730
- deletedFields?: QueryTableDeletedFieldOptions[];
1780
+ interface AutoFilterOptions {
1781
+ ref: string;
1782
+ columns?: FilterColumnOptions[];
1783
+ sortState?: SortStateOptions;
1731
1784
  }
1732
- interface QueryTableOptions {
1733
- name?: string;
1734
- headers?: boolean;
1735
- rowNumbers?: boolean;
1736
- disableRefresh?: boolean;
1737
- backgroundRefresh?: boolean;
1738
- firstBackgroundRefresh?: boolean;
1739
- refreshOnLoad?: boolean;
1740
- growShrinkType?: "insertDelete" | "insertWhole" | "overwriteWhole";
1741
- fillFormulas?: boolean;
1742
- removeDataOnSave?: boolean;
1743
- disableEdit?: boolean;
1744
- preserveFormatting?: boolean;
1745
- adjustColumnWidth?: boolean;
1746
- connectionId: number;
1747
- autoFormat?: boolean;
1748
- intermediate?: boolean;
1749
- queryTableRefresh?: QueryTableRefreshOptions;
1785
+ interface FilterColumnOptions {
1786
+ colId: number;
1787
+ hiddenButton?: boolean;
1788
+ showButton?: boolean;
1789
+ top10?: Top10FilterOptions;
1790
+ customFilters?: CustomFiltersOptions;
1791
+ filters?: FilterItemsOptions;
1792
+ colorFilter?: ColorFilterOptions;
1793
+ iconFilter?: IconFilterOptions;
1794
+ dynamicFilter?: DynamicFilterOptions;
1750
1795
  }
1751
- declare const queryTableDesc: CustomDescriptor<QueryTableOptions>;
1752
- //#endregion
1753
- //#region src/parts/shared-strings.d.ts
1754
- type SstEntry = string | RichTextOptions;
1755
- declare class SharedStrings {
1756
- private entries;
1757
- private indexMap;
1758
- register(s: string): number;
1759
- registerRich(rst: RichTextOptions): number;
1760
- loadEntries(entries: SharedStringsDocOptions["entries"]): void;
1761
- get count(): number;
1762
- toDescriptorOptions(): {
1763
- entries: SstEntry[];
1764
- };
1765
- serialize(): string;
1796
+ interface ColorFilterOptions {
1797
+ dxfId?: number;
1798
+ cellColor?: boolean;
1766
1799
  }
1767
- interface SharedStringsDocOptions {
1768
- entries: (string | RichTextOptions)[];
1800
+ interface IconFilterOptions {
1801
+ iconSet: IconSetType;
1802
+ iconId?: number;
1769
1803
  }
1770
- declare const sharedStringsDesc: CustomDescriptor<SharedStringsDocOptions>;
1771
- //#endregion
1772
- //#region src/parts/table.d.ts
1773
- declare const TotalsRowFunction: {
1774
- readonly NONE: "none";
1775
- readonly SUM: "sum";
1776
- readonly MIN: "min";
1777
- readonly MAX: "max";
1778
- readonly AVERAGE: "average";
1779
- readonly COUNT: "count";
1780
- readonly COUNT_NUMS: "countNums";
1781
- readonly STD_DEV: "stdDev";
1782
- readonly VAR: "var";
1783
- readonly CUSTOM: "custom";
1784
- };
1785
- type TotalsRowFunction = (typeof TotalsRowFunction)[keyof typeof TotalsRowFunction];
1786
- declare const TableType: {
1787
- readonly WORKSHEET: "worksheet";
1788
- readonly XML: "xml";
1789
- readonly QUERY_TABLE: "queryTable";
1790
- };
1791
- type TableType = (typeof TableType)[keyof typeof TableType];
1792
- interface TableStyleInfoOptions {
1793
- name?: string;
1794
- showFirstColumn?: boolean;
1795
- showLastColumn?: boolean;
1796
- showRowStripes?: boolean;
1797
- showColumnStripes?: boolean;
1804
+ interface FilterItemsOptions {
1805
+ blank?: boolean;
1806
+ calendarType?: "gregorian" | "gregorianUs" | "gregorianMeFrench" | "gregorianArabic" | "hijri" | "hebrew" | "taiwan" | "japan" | "thai" | "korea" | "saka" | "gregorianXlitEnglish" | "gregorianXlitFrench" | "none";
1807
+ values?: string[];
1808
+ dateGroupItems?: DateGroupFilterOptions[];
1798
1809
  }
1799
- interface TableColumnOptions {
1800
- name: string;
1801
- totalsRowFunction?: TotalsRowFunction;
1802
- totalsRowLabel?: string;
1803
- calculatedColumnFormula?: string;
1804
- totalsRowFormula?: string;
1805
- totalsRowFormulaArray?: boolean;
1806
- calculatedColumnFormulaArray?: boolean;
1807
- uniqueName?: string;
1808
- queryTableFieldId?: number;
1809
- headerRowDxfId?: number;
1810
- dataDxfId?: number;
1811
- totalsRowDxfId?: number;
1812
- headerRowCellStyle?: string;
1813
- dataCellStyle?: string;
1814
- totalsRowCellStyle?: string;
1815
- xmlColumnPr?: XmlColumnPrOptions;
1810
+ interface DynamicFilterOptions {
1811
+ type: "null" | "aboveAverage" | "belowAverage" | "tomorrow" | "today" | "yesterday" | "nextWeek" | "thisWeek" | "lastWeek" | "nextMonth" | "thisMonth" | "lastMonth" | "nextQuarter" | "thisQuarter" | "lastQuarter" | "nextYear" | "thisYear" | "lastYear" | "yearToDate" | "Q1" | "Q2" | "Q3" | "Q4" | "M1" | "M2" | "M3" | "M4" | "M5" | "M6" | "M7" | "M8" | "M9" | "M10" | "M11" | "M12";
1812
+ val?: number;
1813
+ maxVal?: number;
1814
+ valIso?: string;
1815
+ maxValIso?: string;
1816
1816
  }
1817
- interface XmlColumnPrOptions {
1818
- mapId: number;
1819
- xpath: string;
1820
- denormalized?: boolean;
1821
- xmlDataType: string;
1817
+ interface DateGroupFilterOptions {
1818
+ dateTimeGrouping: "year" | "month" | "day" | "hour" | "minute" | "second";
1819
+ year?: number;
1820
+ month?: number;
1821
+ day?: number;
1822
+ hour?: number;
1823
+ minute?: number;
1824
+ second?: number;
1822
1825
  }
1823
- interface TableOptions {
1824
- id: number;
1825
- name?: string;
1826
- displayName: string;
1827
- comment?: string;
1828
- ref: string;
1829
- columns: TableColumnOptions[];
1830
- headerRowCount?: number;
1831
- insertRow?: boolean;
1832
- totalsRowCount?: number;
1833
- totalsRowShown?: boolean;
1834
- tableType?: TableType;
1835
- style?: TableStyleInfoOptions;
1836
- autoFilter?: string | AutoFilterOptions;
1837
- insertRowShift?: boolean;
1826
+ interface PrintOptions {
1827
+ horizontalCentered?: boolean;
1828
+ verticalCentered?: boolean;
1829
+ headings?: boolean;
1830
+ gridLines?: boolean;
1831
+ gridLinesSet?: boolean;
1832
+ }
1833
+ interface SheetFormatPropertiesOptions {
1834
+ baseColWidth?: number;
1835
+ defaultColWidth?: number;
1836
+ defaultRowHeight?: number;
1837
+ zeroHeight?: boolean;
1838
+ thickTop?: boolean;
1839
+ thickBottom?: boolean;
1840
+ outlineLevelRow?: number;
1841
+ outlineLevelCol?: number;
1842
+ }
1843
+ interface SheetPropertiesOptions {
1844
+ codeName?: string;
1845
+ syncHorizontal?: boolean;
1846
+ syncVertical?: boolean;
1847
+ syncRef?: string;
1848
+ transitionEvaluation?: boolean;
1849
+ transitionEntry?: boolean;
1838
1850
  published?: boolean;
1839
- headerRowDxfId?: number;
1840
- dataDxfId?: number;
1841
- totalsRowDxfId?: number;
1842
- headerRowBorderDxfId?: number;
1843
- tableBorderDxfId?: number;
1844
- totalsRowBorderDxfId?: number;
1845
- headerRowCellStyle?: string;
1846
- dataCellStyle?: string;
1847
- totalsRowCellStyle?: string;
1848
- connectionId?: number;
1851
+ filterMode?: boolean;
1852
+ enableFormatConditionsCalculation?: boolean;
1853
+ outlineApplyStyles?: boolean;
1854
+ outlineShowSymbols?: boolean;
1855
+ outlineSummaryBelow?: boolean;
1856
+ outlineSummaryRight?: boolean;
1849
1857
  }
1850
- declare const tableDesc: CustomDescriptor<TableOptions>;
1851
- //#endregion
1852
- //#region src/parts/xml-mapping.d.ts
1853
- interface SchemaOptions {
1854
- id: string;
1855
- schemaRef?: string;
1856
- namespace?: string;
1857
- schemaLanguage?: string;
1858
- content?: string;
1858
+ interface IgnoredErrorOptions {
1859
+ sqref: string;
1860
+ evalError?: boolean;
1861
+ twoDigitTextYear?: boolean;
1862
+ numberStoredAsText?: boolean;
1863
+ formula?: boolean;
1864
+ formulaRange?: boolean;
1865
+ unlockedFormula?: boolean;
1866
+ emptyCellReference?: boolean;
1867
+ listDataValidation?: boolean;
1868
+ calculatedColumn?: boolean;
1859
1869
  }
1860
- interface DataBindingOptions {
1861
- dataBindingName?: string;
1862
- fileBinding?: boolean;
1863
- connectionId?: number;
1864
- fileBindingName?: string;
1865
- dataBindingLoadMode: number;
1870
+ interface PhoneticPropertiesOptions {
1871
+ fontId: number;
1872
+ type?: "fullwidthKatakana" | "halfwidthKatakana" | "Hiragana" | "noConversion";
1873
+ alignment?: "noControl" | "left" | "center" | "distributed";
1866
1874
  }
1867
- interface MapOptions {
1875
+ interface SheetBackgroundImageOptions {
1876
+ data: DataType;
1877
+ type: "png" | "jpg";
1878
+ }
1879
+ interface PageBreakOptions {
1868
1880
  id: number;
1869
- name: string;
1870
- rootElement: string;
1871
- schemaId: string;
1872
- showImportExportValidationErrors?: boolean;
1873
- autoFit?: boolean;
1874
- append?: boolean;
1875
- preserveSortAFLayout?: boolean;
1876
- preserveFormat?: boolean;
1877
- dataBinding?: DataBindingOptions;
1881
+ min?: number;
1882
+ max?: number;
1883
+ manual?: boolean;
1884
+ pivot?: boolean;
1878
1885
  }
1879
- interface MapInfoOptions {
1880
- selectionNamespaces: string;
1881
- schemas: SchemaOptions[];
1882
- maps: MapOptions[];
1886
+ interface SelectionOptions {
1887
+ pane?: "bottomRight" | "topRight" | "bottomLeft" | "topLeft";
1888
+ activeCell?: string;
1889
+ activeCellId?: number;
1890
+ sqref?: string;
1883
1891
  }
1884
- interface XmlPropertiesOptions {
1885
- mapId: number;
1886
- xpath: string;
1887
- xmlDataType: string;
1892
+ interface PivotSelectionOptions {
1893
+ pane?: "bottomRight" | "topRight" | "bottomLeft" | "topLeft";
1894
+ showHeader?: boolean;
1895
+ label?: boolean;
1896
+ data?: boolean;
1897
+ extendable?: boolean;
1898
+ count?: number;
1899
+ axis?: "axisRow" | "axisCol" | "axisPage" | "axisValues";
1900
+ dimension?: number;
1901
+ start?: number;
1902
+ min?: number;
1903
+ max?: number;
1904
+ activeRow?: number;
1905
+ activeCol?: number;
1906
+ previousRow?: number;
1907
+ previousCol?: number;
1908
+ click?: number;
1909
+ rId?: string;
1910
+ pivotArea?: PivotAreaOptions;
1888
1911
  }
1889
- interface XmlCellPropertiesOptions {
1890
- id: number;
1891
- uniqueName?: string;
1892
- xmlPr: XmlPropertiesOptions;
1912
+ interface CellSmartTagPropertyOptions {
1913
+ key: string;
1914
+ val: string;
1915
+ }
1916
+ interface CellSmartTagOptions {
1917
+ type: number;
1918
+ deleted?: boolean;
1919
+ xmlBased?: boolean;
1920
+ properties?: CellSmartTagPropertyOptions[];
1921
+ }
1922
+ interface CellSmartTagsOptions {
1923
+ reference: string;
1924
+ smartTags: CellSmartTagOptions[];
1925
+ }
1926
+ interface CustomSheetViewOptions {
1927
+ guid: string;
1928
+ scale?: number;
1929
+ showPageBreaks?: boolean;
1930
+ showFormulas?: boolean;
1931
+ showGridLines?: boolean;
1932
+ showRowColHeaders?: boolean;
1933
+ outlineSymbols?: boolean;
1934
+ zeroValues?: boolean;
1935
+ fitToPage?: boolean;
1936
+ printArea?: boolean;
1937
+ filter?: boolean;
1938
+ showAutoFilter?: boolean;
1939
+ hiddenRows?: boolean;
1940
+ hiddenColumns?: boolean;
1941
+ state?: "visible" | "hidden" | "veryHidden";
1942
+ filterUnique?: boolean;
1943
+ view?: "normal" | "pageBreakPreview" | "pageLayout";
1893
1944
  }
1894
- interface SingleXmlCellOptions {
1895
- id: number;
1945
+ interface CellWatchOptions {
1896
1946
  reference: string;
1897
- connectionId: number;
1898
- xmlCellPr: XmlCellPropertiesOptions;
1899
- }
1900
- interface SingleXmlCellsOptions {
1901
- cells: SingleXmlCellOptions[];
1902
- }
1903
- interface XmlColumnPropertiesOptions {
1904
- xpath: string;
1905
- xmlDataType: string;
1906
- mapId: number;
1907
- denormalized?: boolean;
1908
- }
1909
- declare const mapInfoDesc: CustomDescriptor<MapInfoOptions>;
1910
- declare const singleXmlCellsDesc: CustomDescriptor<SingleXmlCellsOptions>;
1911
- //#endregion
1912
- //#region src/parts/worksheet/types.d.ts
1913
- interface ColumnOptions {
1914
- min: number;
1915
- max: number;
1916
- width?: number;
1917
- hidden?: boolean;
1918
- customWidth?: boolean;
1919
- outlineLevel?: number;
1920
- collapsed?: boolean;
1921
- bestFit?: boolean;
1922
- phonetic?: boolean;
1923
1947
  }
1924
- interface RowOptions {
1925
- cells?: CellOptions[];
1926
- height?: number | UniversalMeasure;
1927
- hidden?: boolean;
1928
- rowNumber?: number;
1929
- spans?: string;
1930
- customFormat?: boolean;
1931
- thickTop?: boolean;
1932
- thickBot?: boolean;
1933
- phonetic?: boolean;
1948
+ interface DataConsolidateOptions {
1949
+ function?: "average" | "count" | "countNumbers" | "max" | "min" | "product" | "standardDeviation" | "standardDeviationPopulation" | "sum" | "variance" | "variancePopulation";
1950
+ topLabels?: boolean;
1951
+ leftLabels?: boolean;
1952
+ startLabels?: boolean;
1953
+ link?: boolean;
1954
+ refs?: string[];
1934
1955
  }
1935
- interface RichTextRunPropertiesOptions {
1936
- font?: string;
1937
- charset?: number;
1938
- family?: number;
1939
- bold?: boolean;
1940
- italic?: boolean;
1941
- strike?: boolean;
1942
- outline?: boolean;
1943
- shadow?: boolean;
1944
- condense?: boolean;
1945
- extend?: boolean;
1946
- color?: string;
1947
- size?: number;
1948
- underline?: "single" | "double" | "singleAccounting" | "doubleAccounting" | "none";
1949
- vertAlign?: "superscript" | "subscript" | "baseline";
1950
- scheme?: "major" | "minor" | "none";
1956
+ interface DrawingHfOptions {
1957
+ rId: string;
1958
+ lho?: number;
1959
+ lhe?: number;
1960
+ lhf?: number;
1961
+ cho?: number;
1962
+ che?: number;
1963
+ chf?: number;
1964
+ rho?: number;
1965
+ rhe?: number;
1966
+ rhf?: number;
1967
+ lfo?: number;
1968
+ lfe?: number;
1969
+ lff?: number;
1970
+ cfo?: number;
1971
+ cfe?: number;
1972
+ cff?: number;
1973
+ rfo?: number;
1974
+ rfe?: number;
1975
+ rff?: number;
1951
1976
  }
1952
- interface RichTextRunOptions {
1953
- properties?: RichTextRunPropertiesOptions;
1954
- text: string;
1977
+ interface WorksheetOptions {
1978
+ name?: string;
1979
+ sheetId?: number;
1980
+ state?: "visible" | "hidden" | "veryHidden";
1981
+ rows?: RowOptions[];
1982
+ columns?: ColumnOptions[];
1983
+ mergeCells?: MergeCellOptions[];
1984
+ freezePanes?: FreezePaneOptions;
1985
+ protection?: SheetProtectionOptions;
1986
+ protectedRanges?: ProtectedRangeOptions[];
1987
+ scenarios?: ScenarioOptions;
1988
+ autoFilter?: string | AutoFilterOptions;
1989
+ sortState?: SortStateOptions;
1990
+ images?: PictureOptions[];
1991
+ charts?: WorksheetChartOptions[];
1992
+ smartArts?: WorksheetSmartArtOptions[];
1993
+ shapes?: ShapeOptions[];
1994
+ connectors?: ConnectorOptions[];
1995
+ groups?: GroupOptions[];
1996
+ dataValidations?: DataValidationOptions[];
1997
+ dataValidationsDisablePrompts?: boolean;
1998
+ conditionalFormats?: ConditionalFormatOptions[];
1999
+ hyperlinks?: HyperlinkOptions[];
2000
+ comments?: CommentOptions[];
2001
+ headerFooter?: HeaderFooterOptions;
2002
+ pageSetup?: PageSetupOptions;
2003
+ tabColor?: TabColorOptions;
2004
+ sheetView?: SheetViewOptions;
2005
+ pivotTables?: PivotTableOptions[];
2006
+ tables?: TableOptions[];
2007
+ ignoredErrors?: IgnoredErrorOptions[];
2008
+ phoneticPr?: PhoneticPropertiesOptions;
2009
+ backgroundImage?: SheetBackgroundImageOptions;
2010
+ printOptions?: PrintOptions;
2011
+ sheetFormatPr?: SheetFormatPropertiesOptions;
2012
+ sheetPr?: SheetPropertiesOptions;
2013
+ rowBreaks?: PageBreakOptions[];
2014
+ colBreaks?: PageBreakOptions[];
2015
+ customSheetViews?: CustomSheetViewOptions[];
2016
+ cellWatches?: CellWatchOptions[];
2017
+ dataConsolidate?: DataConsolidateOptions;
2018
+ drawingHF?: DrawingHfOptions;
2019
+ legacyDrawingHF?: string;
2020
+ drawingRid?: string;
2021
+ legacyDrawingRid?: string;
2022
+ selection?: SelectionOptions[];
2023
+ pivotSelection?: PivotSelectionOptions;
2024
+ smartTags?: CellSmartTagsOptions[];
2025
+ queryTables?: QueryTableOptions[];
2026
+ singleXmlCells?: SingleXmlCellOptions[];
2027
+ sheetCalcPr?: SheetCalculationPropertiesOptions;
2028
+ ext?: string;
2029
+ controls?: ControlOptions[];
2030
+ customProperties?: CustomSheetPropertyOptions[];
2031
+ oleObjects?: OleObjectOptions[];
2032
+ webPublishItems?: WebPublishItemOptions[];
2033
+ pageMargins?: PageMarginsOptions;
2034
+ dimension?: string;
1955
2035
  }
1956
- interface PhoneticRunOptions {
1957
- startByte: number;
1958
- endByte: number;
1959
- text: string;
2036
+ interface PageMarginsOptions {
2037
+ left?: number | UniversalMeasure;
2038
+ right?: number | UniversalMeasure;
2039
+ top?: number | UniversalMeasure;
2040
+ bottom?: number | UniversalMeasure;
2041
+ header?: number | UniversalMeasure;
2042
+ footer?: number | UniversalMeasure;
1960
2043
  }
1961
- interface RichTextOptions {
1962
- text?: string;
1963
- runs?: RichTextRunOptions[];
1964
- phonetics?: PhoneticRunOptions[];
2044
+ interface SheetCalculationPropertiesOptions {
2045
+ fullCalcOnLoad?: boolean;
1965
2046
  }
1966
- interface CellOptions {
1967
- value?: string | number | boolean | Date | RichTextOptions | null;
1968
- reference?: string;
1969
- styleIndex?: number;
1970
- style?: StyleOptions;
1971
- formula?: string | FormulaOptions;
1972
- cellMetadataId?: number;
1973
- valueMetadataId?: number;
2047
+ interface ControlOptions {
2048
+ shapeId: number;
2049
+ rId: string;
2050
+ name?: string;
2051
+ locked?: boolean;
2052
+ uiObject?: boolean;
2053
+ recalcAlways?: boolean;
2054
+ linkedCell?: string;
2055
+ listFillRange?: string;
2056
+ formula?: string;
2057
+ defaultSize?: boolean;
2058
+ autoLine?: boolean;
2059
+ autoPict?: boolean;
2060
+ iconRid?: string;
2061
+ anchor?: ObjectAnchorOptions;
2062
+ alternateContent?: boolean;
1974
2063
  }
1975
- declare const FormulaType: {
1976
- readonly NORMAL: "normal";
1977
- readonly ARRAY: "array";
1978
- readonly SHARED: "shared";
1979
- };
1980
- type FormulaType = (typeof FormulaType)[keyof typeof FormulaType];
1981
- interface FormulaOptions {
1982
- formula: string;
1983
- type?: FormulaType;
1984
- reference?: string;
1985
- sharedIndex?: number;
1986
- aca?: boolean;
1987
- dt2D?: boolean;
1988
- dtr?: boolean;
1989
- del1?: boolean;
1990
- del2?: boolean;
1991
- inputCell1?: string;
1992
- inputCell2?: string;
1993
- calculateCell?: boolean;
1994
- arrayContext?: boolean;
2064
+ interface CustomSheetPropertyOptions {
2065
+ name: string;
2066
+ rId: string;
1995
2067
  }
1996
- interface ScenarioCellOptions {
1997
- reference: string;
1998
- val: string | number;
1999
- deleted?: boolean;
2000
- undone?: boolean;
2068
+ interface OleObjectOptions {
2069
+ progId?: string;
2070
+ dvAspect?: "DVASPECT_CONTENT" | "DVASPECT_ICON";
2071
+ link?: string;
2072
+ oleUpdate?: "OLEUPDATE_ALWAYS" | "OLEUPDATE_ONCALL";
2073
+ autoLoad?: boolean;
2074
+ shapeId: number;
2075
+ rId?: string;
2076
+ objectPr?: OleObjectPropertiesOptions;
2077
+ alternateContent?: boolean;
2001
2078
  }
2002
- interface ScenarioDefinition {
2003
- name: string;
2004
- inputCells: ScenarioCellOptions[];
2005
- count?: number;
2006
- user?: string;
2007
- comment?: string;
2008
- hidden?: boolean;
2079
+ interface OleObjectPropertiesOptions {
2009
2080
  locked?: boolean;
2081
+ defaultSize?: boolean;
2082
+ print?: boolean;
2083
+ disabled?: boolean;
2084
+ uiObject?: boolean;
2085
+ autoFill?: boolean;
2086
+ autoLine?: boolean;
2087
+ autoPict?: boolean;
2088
+ macro?: string;
2089
+ altText?: string;
2090
+ dde?: boolean;
2091
+ iconRid?: string;
2092
+ anchor?: ObjectAnchorOptions;
2010
2093
  }
2011
- interface ScenarioOptions {
2012
- scenarios: ScenarioDefinition[];
2013
- current?: number;
2014
- show?: number;
2094
+ interface WebPublishItemOptions {
2095
+ id: number;
2096
+ divId: string;
2097
+ sourceType: "sheet" | "printArea" | "autoFilter" | "range" | "chart" | "pivotTable" | "query" | "label";
2098
+ sourceRef?: string;
2099
+ sourceObject?: string;
2100
+ destinationFile: string;
2101
+ title?: string;
2102
+ autoRepublish?: boolean;
2015
2103
  }
2016
- interface MergeCellOptions {
2017
- from: {
2018
- row: number;
2019
- col: number;
2020
- };
2021
- to: {
2022
- row: number;
2023
- col: number;
2024
- };
2104
+ interface WorksheetContext {
2105
+ sharedStrings?: SharedStrings;
2106
+ styles?: Styles;
2107
+ }
2108
+ //#endregion
2109
+ //#region src/parts/chartsheet.d.ts
2110
+ interface ChartsheetPageSetup {
2111
+ paperSize?: number;
2112
+ paperHeight?: number | PositiveUniversalMeasure;
2113
+ paperWidth?: number | PositiveUniversalMeasure;
2114
+ firstPageNumber?: number;
2115
+ orientation?: PageOrientation;
2116
+ usePrinterDefaults?: boolean;
2117
+ blackAndWhite?: boolean;
2118
+ draft?: boolean;
2119
+ useFirstPageNumber?: boolean;
2120
+ horizontalDpi?: number;
2121
+ verticalDpi?: number;
2122
+ copies?: number;
2123
+ printerSettingsRId?: string;
2025
2124
  }
2026
- interface SheetProtectionOptions {
2125
+ interface ChartsheetProtectionOptions {
2027
2126
  password?: string;
2028
2127
  algorithmName?: string;
2029
- hashValue?: string;
2030
- saltValue?: string;
2128
+ hashValue?: Base64;
2129
+ saltValue?: Base64;
2031
2130
  spinCount?: number;
2032
- sheet?: boolean;
2131
+ content?: boolean;
2033
2132
  objects?: boolean;
2034
- scenarios?: boolean;
2035
- formatCells?: boolean;
2036
- formatColumns?: boolean;
2037
- formatRows?: boolean;
2038
- insertColumns?: boolean;
2039
- insertRows?: boolean;
2040
- insertHyperlinks?: boolean;
2041
- deleteColumns?: boolean;
2042
- deleteRows?: boolean;
2043
- selectLockedCells?: boolean;
2044
- sort?: boolean;
2045
- autoFilter?: boolean;
2046
- pivotTables?: boolean;
2047
- selectUnlockedCells?: boolean;
2048
2133
  }
2049
- interface ProtectedRangeOptions {
2050
- sqref: string;
2051
- name: string;
2052
- password?: string;
2053
- algorithmName?: string;
2054
- hashValue?: string;
2055
- saltValue?: string;
2056
- spinCount?: number;
2057
- securityDescriptor?: string;
2134
+ interface ChartsheetOptions {
2135
+ name?: string;
2136
+ sheetId?: number;
2137
+ state?: "visible" | "hidden" | "veryHidden";
2138
+ tabColor?: ArgbHexColor;
2139
+ pageMargins?: PageMarginsOptions;
2140
+ pageSetup?: ChartsheetPageSetup;
2141
+ headerFooter?: HeaderFooterOptions;
2142
+ sheetProtection?: ChartsheetProtectionOptions;
2143
+ published?: boolean;
2144
+ codeName?: string;
2145
+ zoomToFit?: boolean;
2146
+ tabSelected?: boolean;
2147
+ zoomScale?: number;
2148
+ chart?: ChartSpaceOptions$1;
2149
+ macro?: string;
2150
+ frameLocks?: GraphicFrameLockingOptions;
2151
+ absoluteX?: number;
2152
+ absoluteY?: number;
2153
+ extentCx?: number;
2154
+ extentCy?: number;
2155
+ shapeId?: number;
2058
2156
  }
2059
- interface FreezePaneOptions {
2060
- row?: number;
2061
- col?: number;
2157
+ interface ChartsheetDescriptorOptions extends ChartsheetOptions {
2158
+ drawingRId: string;
2062
2159
  }
2063
- interface PictureOptions extends Omit<BasePictureOptions, "type"> {
2064
- type: "png" | "jpg";
2065
- col: number;
2066
- row: number;
2160
+ declare const chartsheetDesc: CustomDescriptor<ChartsheetDescriptorOptions>;
2161
+ //#endregion
2162
+ //#region src/parts/connection.d.ts
2163
+ interface DatabasePropertiesOptions {
2164
+ connection: string;
2165
+ command?: string;
2166
+ serverCommand?: string;
2167
+ commandType?: number;
2067
2168
  }
2068
- interface WorksheetChartOptions extends ChartSpaceOptions {
2069
- col: number;
2070
- row: number;
2169
+ type WebTableSelection = string | number | null;
2170
+ interface WebPropertiesOptions {
2171
+ url?: string;
2172
+ xml?: boolean;
2173
+ sourceData?: boolean;
2174
+ parsePre?: boolean;
2175
+ consecutive?: boolean;
2176
+ firstRow?: boolean;
2177
+ xl97?: boolean;
2178
+ textDates?: boolean;
2179
+ xl2000?: boolean;
2180
+ post?: string;
2181
+ htmlTables?: boolean;
2182
+ htmlFormat?: "none" | "rtf" | "all";
2183
+ editPage?: string;
2184
+ tables?: WebTableSelection[];
2071
2185
  }
2072
- interface SheetViewOptions {
2073
- showGridLines?: boolean;
2074
- showRowColHeaders?: boolean;
2075
- showZeros?: boolean;
2076
- zoomScale?: number;
2077
- tabSelected?: boolean;
2078
- rightToLeft?: boolean;
2079
- windowProtection?: boolean;
2080
- showFormulas?: boolean;
2081
- showRuler?: boolean;
2082
- showOutlineSymbols?: boolean;
2083
- defaultGridColor?: boolean;
2084
- showWhiteSpace?: boolean;
2085
- view?: "normal" | "pageBreakPreview" | "pageLayout";
2086
- colorId?: number;
2087
- zoomScaleNormal?: number;
2088
- zoomScaleSheetLayoutView?: number;
2089
- zoomScalePageLayoutView?: number;
2186
+ interface ConnectionTextFieldOptions {
2187
+ type?: "general" | "text" | "MDY" | "DMY" | "YMD" | "MYD" | "DYM" | "YDM" | "skip" | "EMD";
2188
+ position?: number;
2090
2189
  }
2091
- type HyperlinkTarget$1 = {
2092
- type: "external";
2093
- url: string;
2094
- } | {
2095
- type: "internal";
2096
- location: string;
2097
- };
2098
- interface HyperlinkOptions {
2099
- cell: string;
2100
- target: HyperlinkTarget$1;
2101
- tooltip?: string;
2102
- display?: string;
2190
+ interface TextPropertiesOptions {
2191
+ prompt?: boolean;
2192
+ fileType?: "mac" | "win" | "dos";
2193
+ codePage?: number;
2194
+ characterSet?: string;
2195
+ firstRow?: number;
2196
+ sourceFile?: string;
2197
+ delimited?: boolean;
2198
+ delimiter?: string;
2199
+ decimal?: string;
2200
+ thousands?: string;
2201
+ tab?: boolean;
2202
+ space?: boolean;
2203
+ comma?: boolean;
2204
+ semicolon?: boolean;
2205
+ consecutive?: boolean;
2206
+ qualifier?: "doubleQuote" | "singleQuote" | "none";
2207
+ textFields?: ConnectionTextFieldOptions[];
2103
2208
  }
2104
- interface HeaderFooterOptions {
2105
- oddHeader?: string;
2106
- oddFooter?: string;
2107
- evenHeader?: string;
2108
- evenFooter?: string;
2109
- firstHeader?: string;
2110
- firstFooter?: string;
2111
- differentOddEven?: boolean;
2112
- differentFirst?: boolean;
2113
- scaleWithDoc?: boolean;
2114
- alignWithMargins?: boolean;
2209
+ interface ParameterOptions {
2210
+ name?: string;
2211
+ sqlType?: number;
2212
+ parameterType?: "prompt" | "value" | "cell";
2213
+ refreshOnChange?: boolean;
2214
+ prompt?: string;
2215
+ boolean?: boolean;
2216
+ double?: number;
2217
+ integer?: number;
2218
+ string?: string;
2219
+ cell?: string;
2115
2220
  }
2116
- type PageOrientation = "default" | "portrait" | "landscape";
2117
- interface PageSetupOptions {
2118
- paperSize?: number;
2119
- orientation?: PageOrientation;
2120
- scale?: number;
2121
- fitToWidth?: number;
2122
- fitToHeight?: number;
2123
- pageOrder?: "downThenOver" | "overThenDown";
2124
- useFirstPageNumber?: boolean;
2125
- firstPageNumber?: number;
2126
- paperHeight?: number | PositiveUniversalMeasure;
2127
- paperWidth?: number | PositiveUniversalMeasure;
2128
- usePrinterDefaults?: boolean;
2129
- blackAndWhite?: boolean;
2130
- draft?: boolean;
2131
- cellComments?: "none" | "asDisplayed" | "atEnd";
2132
- errors?: "displayed" | "blank" | "dash" | "NA";
2133
- autoPageBreaks?: boolean;
2134
- fitToPage?: boolean;
2221
+ interface ConnectionOptions {
2222
+ id: number;
2223
+ name?: string;
2224
+ type?: number;
2225
+ refreshedVersion: number;
2226
+ minRefreshableVersion?: number;
2227
+ refreshOnLoad?: boolean;
2228
+ backgroundRefresh?: boolean;
2229
+ saveData?: boolean;
2230
+ savePassword?: boolean;
2231
+ description?: string;
2232
+ credentials?: string;
2233
+ interval?: number;
2234
+ keepAlive?: boolean;
2235
+ new?: boolean;
2236
+ deleted?: boolean;
2237
+ sourceFile?: string;
2238
+ odcFile?: string;
2239
+ onlyUseConnectionFile?: boolean;
2240
+ reconnectionMethod?: number;
2241
+ singleSignOnId?: string;
2242
+ dbPr?: DatabasePropertiesOptions;
2243
+ olapPr?: OLAPPropertiesOptions;
2244
+ webPr?: WebPropertiesOptions;
2245
+ textPr?: TextPropertiesOptions;
2246
+ parameters?: ParameterOptions[];
2135
2247
  }
2136
- interface TabColorOptions {
2137
- rgb?: string;
2138
- theme?: number;
2139
- tint?: number;
2140
- indexed?: number;
2248
+ interface ConnectionsOptions {
2249
+ connections: ConnectionOptions[];
2141
2250
  }
2142
- interface AnchorMarkerOptions {
2143
- col: number;
2144
- colOff?: number;
2145
- row: number;
2146
- rowOff?: number;
2251
+ declare const connectionsDesc: CustomDescriptor<ConnectionsOptions>;
2252
+ //#endregion
2253
+ //#region src/parts/dialogsheet.d.ts
2254
+ interface DialogsheetOptions {
2255
+ name?: string;
2256
+ sheetId?: number;
2257
+ state?: "visible" | "hidden" | "veryHidden";
2258
+ tabColor?: string;
2259
+ published?: boolean;
2260
+ codeName?: string;
2261
+ pageMargins?: PageMarginsOptions;
2262
+ pageSetup?: PageSetupOptions;
2263
+ sheetProtection?: SheetProtectionOptions;
2264
+ printOptions?: PrintOptions;
2265
+ headerFooter?: HeaderFooterOptions;
2266
+ drawingRId?: string;
2267
+ legacyDrawingRId?: string;
2268
+ extLst?: string;
2147
2269
  }
2148
- interface ObjectAnchorOptions {
2149
- moveWithCells?: boolean;
2150
- sizeWithCells?: boolean;
2151
- from?: AnchorMarkerOptions;
2152
- to?: AnchorMarkerOptions;
2270
+ declare const dialogsheetDesc: CustomDescriptor<DialogsheetOptions>;
2271
+ //#endregion
2272
+ //#region src/parts/external-link.d.ts
2273
+ interface ExternalDefinedNameOptions {
2274
+ name: string;
2275
+ refersTo?: string;
2276
+ sheetId?: number;
2153
2277
  }
2154
- interface CommentPropertiesOptions {
2155
- locked?: boolean;
2156
- defaultSize?: boolean;
2157
- print?: boolean;
2158
- disabled?: boolean;
2159
- autoFill?: boolean;
2160
- autoLine?: boolean;
2161
- altText?: string;
2162
- textHAlign?: "left" | "center" | "right" | "justify" | "distributed";
2163
- textVAlign?: "top" | "center" | "bottom" | "justify" | "distributed";
2164
- lockText?: boolean;
2165
- justLastX?: boolean;
2166
- autoScale?: boolean;
2167
- anchor?: ObjectAnchorOptions;
2278
+ interface ExternalCellOptions {
2279
+ reference: string;
2280
+ type?: "b" | "n" | "e" | "str";
2281
+ value?: string;
2282
+ valueMetadataIndex?: number;
2283
+ }
2284
+ interface ExternalBookOptions {
2285
+ target?: string;
2286
+ sheetNames?: string[];
2287
+ definedNames?: ExternalDefinedNameOptions[];
2288
+ sheetDataSet?: ExternalSheetDataOptions[];
2168
2289
  }
2169
- interface CommentOptions {
2170
- cell: string;
2171
- author: string;
2172
- text: string | RichTextOptions;
2173
- commentPr?: CommentPropertiesOptions;
2174
- anchor?: number[];
2175
- visible?: boolean;
2176
- size?: {
2177
- width: number;
2178
- height: number;
2179
- };
2290
+ interface ExternalRowOptions {
2291
+ rowNumber: number;
2292
+ cells?: ExternalCellOptions[];
2180
2293
  }
2181
- type DataValidationType = "none" | "whole" | "decimal" | "list" | "date" | "time" | "textLength" | "custom";
2182
- type DataValidationOperator = "between" | "notBetween" | "equal" | "notEqual" | "greaterThan" | "lessThan" | "greaterThanOrEqual" | "lessThanOrEqual";
2183
- interface DataValidationOptions {
2184
- sqref: string;
2185
- type?: DataValidationType;
2186
- operator?: DataValidationOperator;
2187
- formula1?: string;
2188
- formula2?: string;
2189
- allowBlank?: boolean;
2190
- showErrorMessage?: boolean;
2191
- errorTitle?: string;
2192
- error?: string;
2193
- showInputMessage?: boolean;
2194
- promptTitle?: string;
2195
- prompt?: string;
2196
- errorStyle?: "stop" | "warning" | "information";
2197
- imeMode?: "noControl" | "on" | "off" | "disabled" | "hiragana" | "fullKatakana" | "halfKatakana" | "fullAlpha" | "halfAlpha" | "fullHangul" | "halfHangul";
2198
- showDropDown?: boolean;
2294
+ interface ExternalSheetDataOptions {
2295
+ sheetId: number;
2296
+ refreshError?: boolean;
2297
+ rows?: ExternalRowOptions[];
2199
2298
  }
2200
- type ConditionalFormatType = "cellIs" | "containsText" | "expression" | "top10" | "aboveAverage" | "colorScale" | "dataBar" | "iconSet";
2201
- type ConditionalFormatOperator = "lessThan" | "lessThanOrEqual" | "equal" | "notEqual" | "greaterThanOrEqual" | "greaterThan" | "between" | "notBetween" | "containsText" | "notContains" | "beginsWith" | "endsWith";
2202
- type CfvoType = "num" | "percent" | "max" | "min" | "formula" | "percentile";
2203
- interface CfvoOptions {
2204
- type: CfvoType;
2205
- val?: string | number;
2206
- gte?: boolean;
2299
+ interface ExternalLinkOptions {
2300
+ externalBook?: ExternalBookOptions;
2301
+ bookRId?: string;
2302
+ ddeLink?: DdeLinkOptions;
2303
+ oleLink?: OleLinkOptions;
2304
+ oleRId?: string;
2207
2305
  }
2208
- type IconSetType = "3Arrows" | "3ArrowsGray" | "3Flags" | "3TrafficLights1" | "3TrafficLights2" | "3Signs" | "3Symbols" | "3Symbols2" | "4Arrows" | "4ArrowsGray" | "4RedToBlack" | "4Rating" | "4TrafficLights" | "5Arrows" | "5ArrowsGray" | "5Rating" | "5Quarters";
2209
- interface ColorScaleOptions {
2210
- cfvo: CfvoOptions[];
2211
- colors: string[];
2306
+ interface DdeValueOptions {
2307
+ type?: "nil" | "b" | "n" | "e" | "str";
2308
+ value: string;
2212
2309
  }
2213
- interface DataBarOptions {
2214
- cfvo: [CfvoOptions, CfvoOptions];
2215
- color: string;
2216
- minLength?: number;
2217
- maxLength?: number;
2218
- showValue?: boolean;
2310
+ interface DdeValuesOptions {
2311
+ rows?: number;
2312
+ cols?: number;
2313
+ values: DdeValueOptions[];
2219
2314
  }
2220
- interface IconSetOptions {
2221
- cfvo: CfvoOptions[];
2222
- iconSet?: IconSetType;
2223
- showValue?: boolean;
2224
- percent?: boolean;
2225
- reverse?: boolean;
2315
+ interface DdeItemOptions {
2316
+ name?: string;
2317
+ ole?: boolean;
2318
+ advise?: boolean;
2319
+ preferPic?: boolean;
2320
+ values?: DdeValuesOptions;
2226
2321
  }
2227
- interface ConditionalFormatRule {
2228
- type: ConditionalFormatType;
2229
- operator?: ConditionalFormatOperator;
2230
- formulas?: string[];
2231
- priority?: number;
2232
- dxfId?: number;
2233
- colorScale?: ColorScaleOptions;
2234
- dataBar?: DataBarOptions;
2235
- iconSet?: IconSetOptions;
2236
- stopIfTrue?: boolean;
2237
- timePeriod?: "today" | "yesterday" | "tomorrow" | "last7Days" | "thisMonth" | "lastMonth" | "nextMonth" | "thisWeek" | "lastWeek" | "nextWeek";
2238
- rank?: number;
2239
- equalAverage?: boolean;
2240
- aboveAverage?: boolean;
2241
- stdDev?: number;
2322
+ interface DdeLinkOptions {
2323
+ ddeService: string;
2324
+ ddeTopic: string;
2325
+ ddeItems?: DdeItemOptions[];
2242
2326
  }
2243
- interface ConditionalFormatOptions {
2244
- sqref: string;
2245
- rules: ConditionalFormatRule[];
2327
+ interface OleItemOptions {
2328
+ name: string;
2329
+ icon?: boolean;
2330
+ advise?: boolean;
2331
+ preferPic?: boolean;
2246
2332
  }
2247
- interface Top10FilterOptions {
2248
- colId: number;
2249
- top?: boolean;
2250
- percent?: boolean;
2251
- val: number;
2252
- filterVal?: number;
2253
- hiddenButton?: boolean;
2254
- showButton?: boolean;
2333
+ interface OleLinkOptions {
2334
+ progId?: string;
2335
+ oleItems?: OleItemOptions[];
2255
2336
  }
2256
- interface CustomFilterOptions {
2257
- colId: number;
2258
- operator?: "equal" | "notEqual" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual";
2259
- val?: string;
2260
- and?: boolean;
2261
- val2?: string;
2262
- hiddenButton?: boolean;
2263
- showButton?: boolean;
2337
+ declare const externalLinkDesc: CustomDescriptor<ExternalLinkOptions>;
2338
+ //#endregion
2339
+ //#region src/parts/metadata.d.ts
2340
+ interface MetadataTypeOptions {
2341
+ name: string;
2342
+ minSupportedVersion: number;
2343
+ ghostRow?: boolean;
2344
+ ghostCol?: boolean;
2345
+ edit?: boolean;
2346
+ delete?: boolean;
2347
+ copy?: boolean;
2348
+ pasteAll?: boolean;
2349
+ pasteFormulas?: boolean;
2350
+ pasteValues?: boolean;
2351
+ pasteFormats?: boolean;
2352
+ pasteComments?: boolean;
2353
+ pasteDataValidation?: boolean;
2354
+ pasteBorders?: boolean;
2355
+ pasteColWidths?: boolean;
2356
+ pasteNumberFormats?: boolean;
2357
+ merge?: boolean;
2358
+ splitFirst?: boolean;
2359
+ splitAll?: boolean;
2360
+ rowColShift?: boolean;
2361
+ clearAll?: boolean;
2362
+ clearFormats?: boolean;
2363
+ clearContents?: boolean;
2364
+ clearComments?: boolean;
2365
+ assign?: boolean;
2366
+ coerce?: boolean;
2367
+ adjust?: boolean;
2368
+ cellMeta?: boolean;
2264
2369
  }
2265
- interface SortCondition {
2266
- ref: string;
2267
- descending?: boolean;
2268
- sortBy?: "value" | "cellColor" | "fontColor" | "icon";
2269
- customList?: string;
2270
- iconId?: number;
2370
+ interface MetadataStringOptions {
2371
+ value: string;
2271
2372
  }
2272
- interface AutoFilterOptions {
2273
- ref: string;
2274
- top10?: Top10FilterOptions[];
2275
- customFilters?: CustomFilterOptions[];
2276
- sort?: SortCondition[];
2277
- sortState?: SortStateOptions;
2278
- colorFilters?: ColorFilterOptions[];
2279
- iconFilters?: IconFilterOptions[];
2280
- dynamicFilters?: DynamicFilterOptions[];
2281
- dateGroupItems?: DateGroupFilterOptions[];
2282
- filters?: FilterItemsOptions[];
2373
+ interface MetadataStringIndexOptions {
2374
+ index: number;
2375
+ show?: boolean;
2283
2376
  }
2284
- interface ColorFilterOptions {
2285
- colId: number;
2286
- dxfId?: number;
2287
- cellColor?: boolean;
2377
+ interface MdxTupleOptions {
2378
+ count?: number;
2379
+ culture?: string;
2380
+ styleIndex?: number;
2381
+ formatIndex?: number;
2382
+ backgroundColor?: string;
2383
+ foregroundColor?: string;
2384
+ italic?: boolean;
2385
+ underline?: boolean;
2386
+ strikethrough?: boolean;
2387
+ bold?: boolean;
2388
+ stringIndexes?: MetadataStringIndexOptions[];
2288
2389
  }
2289
- interface IconFilterOptions {
2290
- colId: number;
2291
- iconSet: number;
2292
- iconId?: number;
2390
+ interface MdxSetOptions {
2391
+ namespaceCount: number;
2392
+ count?: number;
2393
+ order?: "u" | "a" | "d" | "aa" | "ad" | "na" | "nd";
2394
+ stringIndexes?: MetadataStringIndexOptions[];
2293
2395
  }
2294
- interface FilterItemsOptions {
2295
- colId: number;
2296
- blank?: boolean;
2297
- calendarType?: string;
2298
- values?: string[];
2396
+ type MdxFunctionType = "m" | "v" | "s" | "c" | "r" | "p" | "k";
2397
+ type MdxKpiProperty = "v" | "g" | "s" | "t" | "w" | "m";
2398
+ interface MdxMemberPropOptions {
2399
+ nameIndex: number;
2400
+ namePairIndex: number;
2299
2401
  }
2300
- interface DynamicFilterOptions {
2301
- colId: number;
2302
- type: "null" | "aboveAverage" | "belowAverage" | "tomorrow" | "today" | "yesterday" | "nextWeek" | "thisWeek" | "lastWeek" | "nextMonth" | "thisMonth" | "lastMonth" | "nextQuarter" | "thisQuarter" | "lastQuarter" | "nextYear" | "thisYear" | "lastYear" | "yearToDate" | "Q1" | "Q2" | "Q3" | "Q4" | "M1" | "M2" | "M3" | "M4" | "M5" | "M6" | "M7" | "M8" | "M9" | "M10" | "M11" | "M12";
2303
- val?: number;
2304
- maxVal?: number;
2305
- valIso?: string;
2306
- maxValIso?: string;
2402
+ interface MdxKpiOptions {
2403
+ nameIndex: number;
2404
+ namePairIndex: number;
2405
+ property: MdxKpiProperty;
2307
2406
  }
2308
- interface DateGroupFilterOptions {
2309
- colId: number;
2310
- dateTimeGrouping: "year" | "month" | "day" | "hour" | "minute" | "second";
2311
- year?: number;
2312
- month?: number;
2313
- day?: number;
2314
- hour?: number;
2315
- minute?: number;
2316
- second?: number;
2407
+ interface MdxOptions {
2408
+ functionType: MdxFunctionType;
2409
+ stringIndex: number;
2410
+ tuple?: MdxTupleOptions;
2411
+ set?: MdxSetOptions;
2412
+ memberProp?: MdxMemberPropOptions;
2413
+ kpi?: MdxKpiOptions;
2317
2414
  }
2318
- interface SortStateOptions {
2319
- columnSort?: boolean;
2320
- caseSensitive?: boolean;
2321
- sortMethod?: "pinYin" | "stroke" | "none";
2415
+ interface FutureMetadataBlockOptions {
2416
+ extLst?: string;
2322
2417
  }
2323
- interface PrintOptions {
2324
- horizontalCentered?: boolean;
2325
- verticalCentered?: boolean;
2326
- headings?: boolean;
2327
- gridLines?: boolean;
2328
- gridLinesSet?: boolean;
2418
+ interface FutureMetadataOptions {
2419
+ name: string;
2420
+ blocks?: FutureMetadataBlockOptions[];
2329
2421
  }
2330
- interface SheetFormatPropertiesOptions {
2331
- baseColWidth?: number;
2332
- defaultColWidth?: number;
2333
- defaultRowHeight?: number;
2334
- zeroHeight?: boolean;
2335
- thickTop?: boolean;
2336
- thickBottom?: boolean;
2337
- outlineLevelRow?: number;
2338
- outlineLevelCol?: number;
2422
+ interface MetadataRecordOptions {
2423
+ typeIndex: number;
2424
+ valueIndex: number;
2425
+ }
2426
+ interface MetadataBlockOptions {
2427
+ records?: MetadataRecordOptions[];
2339
2428
  }
2340
- interface SheetPropertiesOptions {
2341
- syncHorizontal?: boolean;
2342
- syncVertical?: boolean;
2343
- syncRef?: string;
2344
- transitionEvaluation?: boolean;
2345
- transitionEntry?: boolean;
2346
- published?: boolean;
2347
- filterMode?: boolean;
2348
- enableFormatConditionsCalculation?: boolean;
2349
- outlineApplyStyles?: boolean;
2350
- outlineShowSymbols?: boolean;
2351
- outlineSummaryBelow?: boolean;
2352
- outlineSummaryRight?: boolean;
2429
+ interface MetadataOptions {
2430
+ types?: MetadataTypeOptions[];
2431
+ strings?: MetadataStringOptions[];
2432
+ mdx?: MdxOptions[];
2433
+ futureMetadata?: FutureMetadataOptions[];
2434
+ cellMetadata?: MetadataBlockOptions[];
2435
+ valueMetadata?: MetadataBlockOptions[];
2353
2436
  }
2354
- interface IgnoredErrorOptions {
2355
- sqref: string;
2356
- evalError?: boolean;
2357
- twoDigitTextYear?: boolean;
2358
- numberStoredAsText?: boolean;
2359
- formula?: boolean;
2360
- formulaRange?: boolean;
2361
- unlockedFormula?: boolean;
2362
- emptyCellReference?: boolean;
2363
- listDataValidation?: boolean;
2364
- calculatedColumn?: boolean;
2437
+ declare const metadataDesc: CustomDescriptor<MetadataOptions>;
2438
+ //#endregion
2439
+ //#region src/parts/pivot-cache.d.ts
2440
+ type PivotCacheRecordEntry = {
2441
+ type: "string";
2442
+ v: number;
2443
+ } | {
2444
+ type: "number";
2445
+ v: number;
2446
+ } | {
2447
+ type: "date";
2448
+ v: string;
2449
+ } | {
2450
+ type: "error";
2451
+ v: string;
2452
+ } | {
2453
+ type: "missing";
2454
+ };
2455
+ interface PivotCacheRecordsDescriptorOptions {
2456
+ sourceData: PivotSourceData;
2457
+ records?: PivotCacheRecordEntry[][];
2365
2458
  }
2366
- interface PhoneticPropertiesOptions {
2367
- fontId: number;
2368
- type?: "fullwidthKatakana" | "halfwidthKatakana" | "Hiragana" | "noConversion";
2369
- alignment?: "left" | "center" | "distributed";
2459
+ interface PivotCacheDefDescriptorOptions {
2460
+ sourceRef: string;
2461
+ sourceSheet: string;
2462
+ sourceData: PivotSourceData;
2463
+ recordsRid: string;
2464
+ cacheDefOpts?: PivotCacheDefinitionOptions;
2370
2465
  }
2371
- interface SheetBackgroundImageOptions {
2372
- data: DataType;
2373
- type: "png" | "jpg";
2466
+ interface PivotCacheDefWorksheetSource {
2467
+ ref?: string;
2468
+ sheet?: string;
2374
2469
  }
2375
- interface PageBreakOptions {
2376
- id: number;
2377
- min?: number;
2378
- max?: number;
2379
- manual?: boolean;
2380
- pivot?: boolean;
2470
+ interface PivotCacheDefCacheField {
2471
+ name?: string;
2472
+ numFmtId?: number;
2473
+ sharedItems?: (string | number)[];
2381
2474
  }
2382
- interface SelectionOptions {
2383
- pane?: "bottomRight" | "topRight" | "bottomLeft" | "topLeft";
2384
- activeCell?: string;
2385
- activeCellId?: number;
2386
- sqref?: string;
2475
+ interface PivotCacheDefParseResult {
2476
+ invalid?: boolean;
2477
+ saveData?: boolean;
2478
+ optimizeMemory?: boolean;
2479
+ enableRefresh?: boolean;
2480
+ refreshedBy?: string;
2481
+ refreshedDate?: number;
2482
+ refreshedDateIso?: string;
2483
+ backgroundQuery?: boolean;
2484
+ missingItemsLimit?: number;
2485
+ upgradeOnRefresh?: boolean;
2486
+ supportSubquery?: boolean;
2487
+ supportAdvancedDrill?: boolean;
2488
+ refreshOnLoad?: boolean;
2489
+ tupleCache?: boolean;
2490
+ recordCount?: number;
2491
+ sourceType?: string;
2492
+ worksheetSource?: PivotCacheDefWorksheetSource;
2493
+ cacheFields?: PivotCacheDefCacheField[];
2387
2494
  }
2388
- interface PivotSelectionOptions {
2389
- pane?: "bottomRight" | "topRight" | "bottomLeft" | "topLeft";
2390
- showHeader?: boolean;
2391
- label?: boolean;
2392
- data?: boolean;
2393
- extendable?: boolean;
2394
- count?: number;
2395
- axis?: "axisRow" | "axisCol" | "axisPage" | "axisValues";
2396
- dimension?: number;
2397
- start?: number;
2398
- min?: number;
2399
- max?: number;
2400
- activeRow?: number;
2401
- activeCol?: number;
2402
- previousRow?: number;
2403
- previousCol?: number;
2404
- click?: number;
2405
- rId?: string;
2406
- pivotArea?: PivotAreaOptions;
2495
+ interface PivotCacheRecordsParseResult {
2496
+ records: PivotCacheRecordEntry[][];
2407
2497
  }
2408
- interface CellSmartTagPropertyOptions {
2409
- key: string;
2410
- val: string;
2498
+ declare const pivotCacheDefDesc: CustomDescriptor<PivotCacheDefDescriptorOptions, WriteContext, PivotCacheDefParseResult>;
2499
+ declare const pivotCacheRecordsDesc: CustomDescriptor<PivotCacheRecordsDescriptorOptions, WriteContext, PivotCacheRecordsParseResult>;
2500
+ //#endregion
2501
+ //#region src/parts/revision-log/types.d.ts
2502
+ type RowColumnAction = "insertRow" | "deleteRow" | "insertCol" | "deleteCol";
2503
+ type RevisionAction = "add" | "delete";
2504
+ interface RevisionHeaderEntry {
2505
+ guid: Guid;
2506
+ dateTime: string;
2507
+ userName: string;
2508
+ rId: string;
2509
+ maxSheetId: number;
2510
+ sheetIds: number[];
2511
+ reviewed?: number[];
2512
+ minRId?: number;
2513
+ maxRId?: number;
2411
2514
  }
2412
- interface CellSmartTagOptions {
2413
- type: number;
2414
- deleted?: boolean;
2415
- xmlBased?: boolean;
2416
- properties?: CellSmartTagPropertyOptions[];
2515
+ interface RevisionHeadersOptions {
2516
+ guid: Guid;
2517
+ headers: RevisionHeaderEntry[];
2518
+ lastGuid?: Guid;
2519
+ shared?: boolean;
2520
+ diskRevisions?: boolean;
2521
+ history?: boolean;
2522
+ trackRevisions?: boolean;
2523
+ exclusive?: boolean;
2524
+ revisionId?: number;
2525
+ version?: number;
2526
+ keepChangeHistory?: boolean;
2527
+ protected?: boolean;
2528
+ preserveHistory?: number;
2417
2529
  }
2418
- interface CellSmartTagsOptions {
2419
- reference: string;
2420
- smartTags: CellSmartTagOptions[];
2530
+ interface SharedUserOptions {
2531
+ guid: Guid;
2532
+ name: string;
2533
+ id: number;
2534
+ dateTime: string;
2421
2535
  }
2422
- interface CustomSheetViewOptions {
2423
- guid: string;
2424
- scale?: number;
2425
- showPageBreaks?: boolean;
2426
- showFormulas?: boolean;
2427
- showGridLines?: boolean;
2428
- showRowColHeaders?: boolean;
2429
- outlineSymbols?: boolean;
2430
- zeroValues?: boolean;
2431
- fitToPage?: boolean;
2432
- printArea?: boolean;
2433
- filter?: boolean;
2434
- showAutoFilter?: boolean;
2435
- hiddenRows?: boolean;
2436
- hiddenColumns?: boolean;
2437
- state?: "visible" | "hidden" | "veryHidden";
2438
- filterUnique?: boolean;
2439
- view?: "normal" | "pageBreakPreview" | "pageLayout";
2536
+ interface UsersOptions {
2537
+ users?: SharedUserOptions[];
2440
2538
  }
2441
- interface CellWatchOptions {
2442
- reference: string;
2539
+ interface RevisionUndoOptions {
2540
+ index: number;
2541
+ expression: "ref" | "refError" | "area" | "areaError" | "computedArea";
2542
+ undoRange: string;
2543
+ ref3D?: boolean;
2544
+ array?: boolean;
2545
+ value?: boolean;
2546
+ numberFormat?: boolean;
2547
+ conditionalStyle?: boolean;
2548
+ definedName?: string;
2549
+ reference?: string;
2550
+ sId?: number;
2443
2551
  }
2444
- interface DataConsolidateOptions {
2445
- function?: "average" | "count" | "countNums" | "max" | "min" | "product" | "stdDev" | "stdDevp" | "sum" | "var" | "varp";
2446
- topLabels?: boolean;
2447
- leftLabels?: boolean;
2448
- startLabels?: boolean;
2449
- link?: boolean;
2450
- refs?: string[];
2552
+ type RevisionNestedChild = {
2553
+ kind: "undo";
2554
+ data: RevisionUndoOptions;
2555
+ } | {
2556
+ kind: "cellChange";
2557
+ data: RevisionCellChangeOptions;
2558
+ } | {
2559
+ kind: "formatting";
2560
+ data: RevisionFormattingOptions;
2561
+ };
2562
+ interface RevisionRowColumnOptions {
2563
+ rId: number;
2564
+ sheetId: number;
2565
+ ref: string;
2566
+ action: RowColumnAction;
2567
+ endOfList?: boolean;
2568
+ edge?: boolean;
2569
+ undo?: boolean;
2570
+ rejected?: boolean;
2571
+ children?: RevisionNestedChild[];
2451
2572
  }
2452
- interface DrawingHfOptions {
2453
- rId: string;
2454
- lho?: number;
2455
- lhe?: number;
2456
- lhf?: number;
2457
- cho?: number;
2458
- che?: number;
2459
- chf?: number;
2460
- rho?: number;
2461
- rhe?: number;
2462
- rhf?: number;
2463
- lfo?: number;
2464
- lfe?: number;
2465
- lff?: number;
2466
- cfo?: number;
2467
- cfe?: number;
2468
- cff?: number;
2469
- rfo?: number;
2470
- rfe?: number;
2471
- rff?: number;
2573
+ interface RevisionMoveOptions {
2574
+ rId: number;
2575
+ sheetId: number;
2576
+ source: string;
2577
+ destination: string;
2578
+ sourceSheetId?: number;
2579
+ undo?: boolean;
2580
+ rejected?: boolean;
2581
+ children?: RevisionNestedChild[];
2582
+ }
2583
+ interface RevisionCustomViewOptions {
2584
+ guid: Guid;
2585
+ action: RevisionAction;
2472
2586
  }
2473
- interface WorksheetOptions {
2474
- name?: string;
2475
- rows?: RowOptions[];
2476
- columns?: ColumnOptions[];
2477
- mergeCells?: MergeCellOptions[];
2478
- freezePanes?: FreezePaneOptions;
2479
- protection?: SheetProtectionOptions;
2480
- protectedRanges?: ProtectedRangeOptions[];
2481
- scenarios?: ScenarioOptions;
2482
- autoFilter?: string | AutoFilterOptions;
2483
- images?: PictureOptions[];
2484
- charts?: WorksheetChartOptions[];
2485
- shapes?: ShapeOptions[];
2486
- connectors?: ConnectorOptions[];
2487
- groups?: GroupOptions[];
2488
- dataValidations?: DataValidationOptions[];
2489
- dataValidationsDisablePrompts?: boolean;
2490
- conditionalFormats?: ConditionalFormatOptions[];
2491
- hyperlinks?: HyperlinkOptions[];
2492
- comments?: CommentOptions[];
2493
- headerFooter?: HeaderFooterOptions;
2494
- pageSetup?: PageSetupOptions;
2495
- tabColor?: TabColorOptions;
2496
- sheetView?: SheetViewOptions;
2497
- pivotTables?: PivotTableOptions[];
2498
- tables?: TableOptions[];
2499
- ignoredErrors?: IgnoredErrorOptions[];
2500
- phoneticPr?: PhoneticPropertiesOptions;
2501
- backgroundImage?: SheetBackgroundImageOptions;
2502
- printOptions?: PrintOptions;
2503
- sheetFormatPr?: SheetFormatPropertiesOptions;
2504
- sheetPr?: SheetPropertiesOptions;
2505
- rowBreaks?: PageBreakOptions[];
2506
- colBreaks?: PageBreakOptions[];
2507
- customSheetViews?: CustomSheetViewOptions[];
2508
- cellWatches?: CellWatchOptions[];
2509
- dataConsolidate?: DataConsolidateOptions;
2510
- oleSize?: string;
2511
- drawingHF?: DrawingHfOptions;
2512
- legacyDrawingHF?: string;
2513
- selection?: SelectionOptions;
2514
- pivotSelection?: PivotSelectionOptions;
2515
- smartTags?: CellSmartTagsOptions[];
2516
- queryTables?: QueryTableOptions[];
2517
- singleXmlCells?: SingleXmlCellOptions[];
2518
- sheetCalcPr?: SheetCalculationPropertiesOptions;
2519
- ext?: string;
2520
- controls?: ControlOptions[];
2521
- customProperties?: CustomSheetPropertyOptions[];
2522
- oleObjects?: OleObjectOptions[];
2523
- webPublishItems?: WebPublishItemOptions[];
2524
- pageMargins?: PageMarginsOptions;
2525
- dimension?: string;
2587
+ interface RevisionSheetRenameOptions {
2588
+ rId: number;
2589
+ sheetId: number;
2590
+ oldName: string;
2591
+ newName: string;
2592
+ undo?: boolean;
2593
+ rejected?: boolean;
2526
2594
  }
2527
- interface PageMarginsOptions {
2528
- left?: number | UniversalMeasure;
2529
- right?: number | UniversalMeasure;
2530
- top?: number | UniversalMeasure;
2531
- bottom?: number | UniversalMeasure;
2532
- header?: number | UniversalMeasure;
2533
- footer?: number | UniversalMeasure;
2595
+ interface RevisionInsertSheetOptions {
2596
+ rId: number;
2597
+ sheetId: number;
2598
+ name: string;
2599
+ sheetPosition: number;
2600
+ undo?: boolean;
2601
+ rejected?: boolean;
2534
2602
  }
2535
- interface SheetCalculationPropertiesOptions {
2536
- fullCalcOnLoad?: boolean;
2603
+ interface RevisionCellChangeOptions {
2604
+ rId: number;
2605
+ sheetId: number;
2606
+ hasOldDxf?: boolean;
2607
+ xfDxf?: boolean;
2608
+ style?: boolean;
2609
+ hasDxf?: boolean;
2610
+ numFmtId?: number;
2611
+ quotePrefix?: boolean;
2612
+ oldQuotePrefix?: boolean;
2613
+ phonetic?: boolean;
2614
+ oldPhonetic?: boolean;
2615
+ endOfListFormulaUpdate?: boolean;
2616
+ undo?: boolean;
2617
+ rejected?: boolean;
2618
+ oldCellXml?: string;
2619
+ newCellXml: string;
2620
+ oldDxfXml?: string;
2621
+ newDxfXml?: string;
2537
2622
  }
2538
- interface ControlOptions {
2539
- shapeId: number;
2540
- rId: string;
2541
- name?: string;
2542
- locked?: boolean;
2543
- uiObject?: boolean;
2544
- recalcAlways?: boolean;
2545
- linkedCell?: string;
2546
- listFillRange?: string;
2547
- formula?: string;
2623
+ interface RevisionFormattingOptions {
2624
+ sheetId: number;
2625
+ sqref: string;
2626
+ xfDxf?: boolean;
2627
+ style?: boolean;
2628
+ start?: number;
2629
+ length?: number;
2630
+ dxfXml?: string;
2548
2631
  }
2549
- interface CustomSheetPropertyOptions {
2632
+ interface RevisionAutoFormattingOptions {
2633
+ sheetId: number;
2634
+ ref: string;
2635
+ autoFormatXml?: string;
2636
+ }
2637
+ interface RevisionDefinedNameOptions {
2638
+ rId: number;
2550
2639
  name: string;
2551
- rId: string;
2640
+ localSheetId?: number;
2641
+ customView?: boolean;
2642
+ formula?: string;
2643
+ oldFormula?: string;
2644
+ function?: boolean;
2645
+ oldFunction?: boolean;
2646
+ functionGroupId?: number;
2647
+ oldFunctionGroupId?: number;
2648
+ shortcutKey?: number;
2649
+ oldShortcutKey?: number;
2650
+ hidden?: boolean;
2651
+ oldHidden?: boolean;
2652
+ customMenu?: string;
2653
+ oldCustomMenu?: string;
2654
+ description?: string;
2655
+ oldDescription?: string;
2656
+ help?: string;
2657
+ oldHelp?: string;
2658
+ statusBar?: string;
2659
+ oldStatusBar?: string;
2660
+ comment?: string;
2661
+ oldComment?: string;
2662
+ undo?: boolean;
2663
+ rejected?: boolean;
2552
2664
  }
2553
- interface OleObjectOptions {
2554
- progId?: string;
2555
- dvAspect?: "DVASPECT_CONTENT" | "DVASPECT_ICON";
2556
- link?: string;
2557
- oleUpdate?: "OLEUPDATE_ALWAYS" | "OLEUPDATE_ONCALL";
2558
- autoLoad?: boolean;
2559
- shapeId: number;
2560
- rId?: string;
2561
- objectPr?: OleObjectPropertiesOptions;
2665
+ interface RevisionCommentOptions {
2666
+ sheetId: number;
2667
+ cell: string;
2668
+ guid: Guid;
2669
+ action?: RevisionAction;
2670
+ alwaysShow?: boolean;
2671
+ old?: boolean;
2672
+ hiddenRow?: boolean;
2673
+ hiddenColumn?: boolean;
2674
+ author: string;
2675
+ oldLength?: number;
2676
+ newLength?: number;
2562
2677
  }
2563
- interface OleObjectPropertiesOptions {
2564
- locked?: boolean;
2565
- defaultSize?: boolean;
2566
- print?: boolean;
2567
- disabled?: boolean;
2568
- uiObject?: boolean;
2569
- autoFill?: boolean;
2570
- autoLine?: boolean;
2571
- autoPict?: boolean;
2572
- macro?: string;
2573
- altText?: string;
2574
- dde?: boolean;
2575
- rId?: string;
2678
+ interface RevisionQueryTableFieldOptions {
2679
+ sheetId: number;
2680
+ ref: string;
2681
+ fieldId: number;
2576
2682
  }
2577
- interface WebPublishItemOptions {
2578
- id: number;
2579
- divId: string;
2580
- sourceType: "sheet" | "printArea" | "autoFilter" | "range" | "chart" | "pivotTable" | "query" | "label";
2581
- sourceRef?: string;
2582
- sourceObject?: string;
2583
- destinationFile: string;
2584
- title?: string;
2585
- autoRepublish?: boolean;
2683
+ interface RevisionConflictOptions {
2684
+ rId: number;
2685
+ undo?: boolean;
2686
+ rejected?: boolean;
2687
+ sheetId?: number;
2586
2688
  }
2587
- interface WorksheetContext {
2588
- sharedStrings?: SharedStrings;
2589
- styles?: Styles;
2689
+ type RevisionEntry = {
2690
+ type: "rowColumn";
2691
+ data: RevisionRowColumnOptions;
2692
+ } | {
2693
+ type: "move";
2694
+ data: RevisionMoveOptions;
2695
+ } | {
2696
+ type: "customView";
2697
+ data: RevisionCustomViewOptions;
2698
+ } | {
2699
+ type: "sheetRename";
2700
+ data: RevisionSheetRenameOptions;
2701
+ } | {
2702
+ type: "insertSheet";
2703
+ data: RevisionInsertSheetOptions;
2704
+ } | {
2705
+ type: "cellChange";
2706
+ data: RevisionCellChangeOptions;
2707
+ } | {
2708
+ type: "formatting";
2709
+ data: RevisionFormattingOptions;
2710
+ } | {
2711
+ type: "autoFormatting";
2712
+ data: RevisionAutoFormattingOptions;
2713
+ } | {
2714
+ type: "definedName";
2715
+ data: RevisionDefinedNameOptions;
2716
+ } | {
2717
+ type: "comment";
2718
+ data: RevisionCommentOptions;
2719
+ } | {
2720
+ type: "queryTableField";
2721
+ data: RevisionQueryTableFieldOptions;
2722
+ } | {
2723
+ type: "conflict";
2724
+ data: RevisionConflictOptions;
2725
+ };
2726
+ interface RevisionLogOptions {
2727
+ revisions: RevisionEntry[];
2590
2728
  }
2591
2729
  //#endregion
2592
- //#region src/parts/worksheet/descriptor.d.ts
2593
- declare const worksheetDesc: CustomDescriptor<WorksheetOptions>;
2594
- //#endregion
2595
- //#region src/parts/worksheet/stringify.d.ts
2596
- declare function stringifyWorksheet(opts: WorksheetOptions, ctx: WorksheetContext): string;
2597
- //#endregion
2598
2730
  //#region src/parts/file.d.ts
2599
2731
  interface WorkbookOptions extends CorePropertiesOptions$1 {
2600
2732
  worksheets?: WorksheetOptions[];
2733
+ encrypted?: EncryptedContainerOptions;
2734
+ absPath?: string;
2735
+ revisionPtr?: RevisionPtrOptions;
2736
+ extensions?: WorkbookExtensionOptions[];
2601
2737
  chartsheets?: ChartsheetOptions[];
2602
2738
  dialogsheets?: DialogsheetOptions[];
2603
2739
  dxfs?: DxfOptions[];
2740
+ fonts?: FontOptions[];
2741
+ fills?: CellFillOptions[];
2742
+ borders?: BorderSideOptions[];
2743
+ cellXfs?: IndexedXfEntry[];
2744
+ numFmts?: NumFmtEntry[];
2604
2745
  colors?: ColorsOptions;
2605
2746
  tableStyles?: CustomTableStyleOptions[];
2606
2747
  theme?: ThemeOptions;
@@ -2622,13 +2763,29 @@ interface WorkbookOptions extends CorePropertiesOptions$1 {
2622
2763
  definedNames?: DefinedNameOptions[];
2623
2764
  bookView?: WorkbookViewOptions;
2624
2765
  calcPr?: CalculationPropertiesOptions;
2766
+ oleSize?: string;
2625
2767
  workbookPr?: WorkbookPropertiesOptions;
2626
2768
  calcChain?: CalcCell[];
2627
2769
  pivotCaches?: PivotCacheDefParseResult[];
2770
+ pivotCacheRefs?: PivotCacheReference[];
2628
2771
  pivotCacheRecords?: PivotCacheRecordsParseResult[];
2772
+ sharedStrings?: (string | RichTextOptions)[];
2629
2773
  appProperties?: AppPropertiesOptions;
2630
2774
  customProperties?: CustomPropertyOptions[];
2631
2775
  revisionLog?: SharedWorkbookOptions;
2776
+ contentTypes?: ContentTypesInput;
2777
+ rawParts?: {
2778
+ path: string;
2779
+ data: DataType;
2780
+ contentType?: string;
2781
+ }[];
2782
+ passthroughRelationships?: {
2783
+ source: string;
2784
+ relationshipType: string;
2785
+ target: string;
2786
+ rId: string;
2787
+ targetMode?: "External";
2788
+ }[];
2632
2789
  }
2633
2790
  interface SharedWorkbookOptions {
2634
2791
  headers: RevisionHeadersOptions;
@@ -2644,7 +2801,7 @@ declare const commentsDesc: CustomDescriptor<CommentsDocOptions>;
2644
2801
  interface VmlNoteAnchor {
2645
2802
  row: number;
2646
2803
  column: number;
2647
- anchor?: number[];
2804
+ anchor?: NoteAnchorOptions;
2648
2805
  visible: boolean;
2649
2806
  width?: number;
2650
2807
  height?: number;
@@ -2834,6 +2991,14 @@ interface MediaData extends BaseMediaEntry {
2834
2991
  height: number;
2835
2992
  }
2836
2993
  //#endregion
2994
+ //#region src/shared/formula-lint.d.ts
2995
+ interface FormulaIssue {
2996
+ location: string;
2997
+ formula: string;
2998
+ message: string;
2999
+ }
3000
+ declare function lintWorkbookFormulas(options: WorkbookOptions): FormulaIssue[];
3001
+ //#endregion
2837
3002
  //#region src/util/index.d.ts
2838
3003
  declare function columnToLetter(col: number): string;
2839
3004
  declare function letterToColumn(letters: string): number;
@@ -2865,26 +3030,15 @@ declare function parseWorkbook(data: DataType): WorkbookOptions;
2865
3030
  //#region src/patch.d.ts
2866
3031
  type ScalarValue = string | number | boolean | Date;
2867
3032
  type Patch = ScalarValue;
2868
- interface PatchWorkbookOptions<T extends OutputType$1 = OutputType$1> extends BasePatchOptions<T> {
2869
- placeholders?: Readonly<Record<string, ScalarValue>>;
2870
- findReplace?: Readonly<Record<string, ScalarValue>>;
2871
- coreProperties?: Partial<CorePropertiesOptions$1>;
3033
+ interface PatchWorkbookOptions<T extends OutputType$1 = OutputType$1> extends BasePatchOptions<T, ScalarValue> {
2872
3034
  worksheets?: {
2873
3035
  replace?: Readonly<Record<string, WorksheetOptions>>;
2874
3036
  append?: Readonly<WorksheetOptions[]>;
3037
+ remove?: readonly string[];
2875
3038
  };
2876
3039
  comments?: Readonly<Record<string, CommentOptions[]>>;
2877
3040
  }
2878
- declare const patchWorkbook: <T extends OutputType$1 = OutputType$1>({
2879
- outputType,
2880
- data,
2881
- placeholders,
2882
- findReplace,
2883
- coreProperties,
2884
- worksheets,
2885
- comments,
2886
- placeholderDelimiters
2887
- }: PatchWorkbookOptions<T>) => Promise<OutputByType$1[T]>;
3041
+ declare const patchWorkbook: <T extends OutputType$1 = OutputType$1>({ outputType, data, placeholders, findReplace, coreProperties, worksheets, comments, placeholderDelimiters }: PatchWorkbookOptions<T>) => Promise<OutputByType$1[T]>;
2888
3042
  //#endregion
2889
3043
  //#region src/compiler.d.ts
2890
3044
  declare function compileWorkbook(options: WorkbookOptions, overrides?: XmlifyedFile[], mediaLevel?: number): Zippable;
@@ -2911,9 +3065,12 @@ declare class XlsxWriteContext implements WriteContext {
2911
3065
  }
2912
3066
  declare class XlsxReadContext implements ReadContext {
2913
3067
  private xlsx;
2914
- readonly sharedStrings: string[];
2915
- parsedStyles?: StylesParseResult;
2916
- constructor(xlsx: XlsxDocument, sharedStrings?: string[]);
3068
+ readonly sharedStrings: (string | RichTextOptions)[];
3069
+ currentPart: string;
3070
+ private readonly partRels;
3071
+ constructor(xlsx: XlsxDocument, sharedStrings?: (string | RichTextOptions)[]);
3072
+ private loadPartRels;
3073
+ withPart<T>(partPath: string, fn: () => T): T;
2917
3074
  resolveRelationship(rId: string): string | undefined;
2918
3075
  resolveWorksheetRel(wsPath: string, rId: string): string | undefined;
2919
3076
  getWorksheetRelsByType(wsPath: string, typeFragment: string): Array<{
@@ -2922,7 +3079,6 @@ declare class XlsxReadContext implements ReadContext {
2922
3079
  }>;
2923
3080
  getPart(path: string): Element | undefined;
2924
3081
  getRaw(path: string): Uint8Array | undefined;
2925
- resolveStyle(styleIndex: number): StyleOptions | undefined;
2926
3082
  }
2927
3083
  //#endregion
2928
3084
  //#region src/generate.d.ts
@@ -2930,5 +3086,5 @@ declare function generateWorkbook<T extends OutputType$1 = "nodebuffer">(options
2930
3086
  declare function generateWorkbookSync<T extends OutputType$1 = "nodebuffer">(options: WorkbookOptions, packerOptions?: PackerOptions$1<T>): OutputByType$1[T];
2931
3087
  declare function generateWorkbookStream(options: WorkbookOptions, packerOptions?: PackerOptions$1): ReadableStream<Uint8Array>;
2932
3088
  //#endregion
2933
- export { type AlignmentOptions, type AnchorType, type BorderOptions, type BorderSideOptions, type CalcChainOptions, type CellFillOptions, type CellOptions, type CellStyleXfOptions, type CfvoOptions, type CfvoType, type ChartsheetDescriptorOptions, type ChartsheetHeaderFooterOptions, type ChartsheetOptions, type ChartsheetPageMargins, type ChartsheetPageSetup, type ChartsheetProtectionOptions, type ColorScaleOptions, type ColumnOptions, type CommentsDocOptions, type CompressionOptions, type ConditionalFormatOptions, type ConditionalFormatRule, type ConnectionOptions, type ConnectionTextFieldOptions, type ConnectionsOptions, type ConnectorOptions, type ConsolidateFunction, type CorePropertiesOptions, type CustomCellStyleOptions, type CustomTableStyleOptions, type CustomWorkbookViewOptions, type DataBarOptions, type DataBindingOptions, type DataValidationOptions, type DatabasePropertiesOptions, type DefinedNameOptions, type DialogsheetOptions, type DialogsheetPageMargins, type DialogsheetPageSetup, type DialogsheetProtectionOptions, type DrawingAnchorOptions, type DrawingChartOptions, type DrawingContentPartOptions, type DrawingOptions, type DrawingPictureOptions, type EditAsType, type ExternalBookOptions, type ExternalCellOptions, type ExternalDefinedNameOptions, type ExternalLinkOptions, type ExternalRowOptions, type ExternalSheetDataOptions, type FileRecoveryPropertiesOptions, type FileSharingOptions, type FontOptions, type FormulaOptions, type FreezePaneOptions, type FutureMetadataBlockOptions, type FutureMetadataOptions, type GroupConnectorChildOptions, type GroupOptions, type GroupShapeChildOptions, type IconSetOptions, type IconSetType, type IgnoredErrorOptions, type MapInfoOptions, type MapOptions, type MdxFunctionType, type MdxKpiOptions, type MdxKpiProperty, type MdxMemberPropOptions, type MdxOptions, type MdxSetOptions, type MdxTupleOptions, Media, type MediaData, type MergeCellOptions, type MetadataBlockOptions, type MetadataOptions, type MetadataRecordOptions, type MetadataStringIndexOptions, type MetadataStringOptions, type MetadataTypeOptions, type OleItemOptions, type OleLinkOptions, type OutputByType, type OutputType, type PackerOptions, type ParameterOptions, type Patch, type PatchWorkbookOptions, type PhoneticPropertiesOptions, type PictureOptions, type PivotCacheDefDescriptorOptions, type PivotDataField, type PivotFilterOptions, PivotFilterType as PivotFilterTypeValue, type PivotTableDescriptorOptions, type PivotTableOptions, type ProtectedRangeOptions, type QueryTableDeletedFieldOptions, type QueryTableFieldOptions, type QueryTableOptions, type QueryTableRefreshOptions, type RevisionCellChangeOptions, type RevisionCommentOptions, type RevisionDefinedNameOptions, type RevisionEntry, type RevisionFormattingOptions, type RevisionHeaderEntry, type RevisionHeadersOptions, type RevisionInsertSheetOptions, type RevisionLogOptions, type RevisionMoveOptions, type RevisionRowColumnOptions, type RowOptions, type ScalarValue, type ScenarioCellOptions, type ScenarioDefinition, type ScenarioOptions, type SchemaOptions, type ShapeOptions, SharedStrings, type SharedStringsDocOptions, type SheetBackgroundImageOptions, type SheetProtectionOptions, type SingleXmlCellOptions, type SingleXmlCellsOptions, type StyleExtensionOptions, type StyleOptions, Styles, type StylesDocOptions, type TableColumnOptions, type TableOptions, type TableStyleInfoOptions, TableType, type TextPropertiesOptions, TotalsRowFunction, type WebPropertiesOptions, type WebPublishingOptions, type WebTableSelection, type WorkbookOptions, type WorkbookProtectionOptions, type WorksheetChartOptions, type WorksheetContext, type WorksheetOptions, type XlsxDocument, type XlsxPartRefs, XlsxReadContext, XlsxWriteContext, type XmlCellPropertiesOptions, type XmlColumnPropertiesOptions, type XmlPropertiesOptions, buildExternalReferencesXml, buildTablePartsXml, stringifyWorksheet as buildWorksheetXml, stringifyWorksheet, calcChainDesc, chartsheetDesc, columnToLetter, commentsDesc, compileWorkbook, connectionsDesc, createThemeXml, dateToSerialNumber, dialogsheetDesc, drawingDesc, externalLinkDesc, generateWorkbook, generateWorkbookStream, generateWorkbookSync, hashPassword, letterToColumn, mapInfoDesc, metadataDesc, parseWorkbook, parseXlsx, patchWorkbook, pivotCacheDefDesc, pivotCacheRecordsDesc, pivotTableDesc, queryTableDesc, sharedStringsDesc, singleXmlCellsDesc, stylesDesc, tableDesc, vmlNotesDesc, workbookDesc, worksheetDesc };
3089
+ export { type AlignmentOptions, type AnchorType, type AutoFilterOptions, type BorderOptions, type BorderSideOptions, type CalcChainOptions, type CellFillOptions, type CellOptions, type CellStyleXfOptions, type CfvoOptions, type CfvoType, type ChartsheetDescriptorOptions, type ChartsheetOptions, type ChartsheetPageSetup, type ChartsheetProtectionOptions, type ColorFilterOptions, type ColorScaleOptions, type ColumnOptions, type CommentOptions, type CommentsDocOptions, type CompressionOptions, type ConditionalFormatOptions, type ConditionalFormatRule, type ConnectionOptions, type ConnectionTextFieldOptions, type ConnectionsOptions, type ConnectorOptions, type ConsolidateFunction, type CorePropertiesOptions, type CustomCellStyleOptions, type CustomFilterEntry, type CustomFilterOperator, type CustomFiltersOptions, type CustomTableStyleOptions, type CustomWorkbookViewOptions, type DataBarOptions, type DataBindingOptions, type DataValidationOptions, type DatabasePropertiesOptions, type DateGroupFilterOptions, type DefinedNameOptions, type DialogsheetOptions, type DrawingAnchorOptions, type DrawingChartOptions, type DrawingContentPartOptions, type DrawingOptions, type DrawingPictureOptions, type DynamicFilterOptions, type EditAsType, type ExternalBookOptions, type ExternalCellOptions, type ExternalDefinedNameOptions, type ExternalLinkOptions, type ExternalRowOptions, type ExternalSheetDataOptions, type FileRecoveryPropertiesOptions, type FileSharingOptions, type FilterColumnOptions, type FilterItemsOptions, type FontOptions, type FormulaIssue, type FormulaOptions, type FreezePaneOptions, type FutureMetadataBlockOptions, type FutureMetadataOptions, type GroupConnectorChildOptions, type GroupOptions, type GroupShapeChildOptions, type HeaderFooterOptions, type HyperlinkOptions, type IconFilterOptions, type IconSetOptions, type IconSetType, type IgnoredErrorOptions, type MapInfoOptions, type MapOptions, type MdxFunctionType, type MdxKpiOptions, type MdxKpiProperty, type MdxMemberPropOptions, type MdxOptions, type MdxSetOptions, type MdxTupleOptions, Media, type MediaData, type MergeCellOptions, type MetadataBlockOptions, type MetadataOptions, type MetadataRecordOptions, type MetadataStringIndexOptions, type MetadataStringOptions, type MetadataTypeOptions, type NoteAnchorOptions, type OleItemOptions, type OleLinkOptions, type OutputByType, type OutputType, type PackerOptions, type PageMarginsOptions, type PageSetupOptions, type ParameterOptions, type Patch, type PatchWorkbookOptions, type PhoneticPropertiesOptions, type PictureOptions, type PivotCacheDefDescriptorOptions, type PivotDataField, type PivotFilterOptions, PivotFilterType as PivotFilterTypeValue, type PivotPageFieldOptions, type PivotTableDescriptorOptions, type PivotTableOptions, type PrintOptions, type ProtectedRangeOptions, type QueryTableDeletedFieldOptions, type QueryTableFieldOptions, type QueryTableOptions, type QueryTableRefreshOptions, type RevisionCellChangeOptions, type RevisionCommentOptions, type RevisionDefinedNameOptions, type RevisionEntry, type RevisionFormattingOptions, type RevisionHeaderEntry, type RevisionHeadersOptions, type RevisionInsertSheetOptions, type RevisionLogOptions, type RevisionMoveOptions, type RevisionRowColumnOptions, type RowOptions, type ScalarValue, type ScenarioCellOptions, type ScenarioDefinition, type ScenarioOptions, type SchemaOptions, type ShapeOptions, SharedStrings, type SharedStringsDocOptions, type SheetBackgroundImageOptions, type SheetProtectionOptions, type SheetViewOptions, type SingleXmlCellOptions, type SingleXmlCellsOptions, type SortCondition, type SortStateOptions, type StyleExtensionOptions, type StyleOptions, Styles, type StylesDocOptions, type TableColumnOptions, type TableOptions, type TableStyleInfoOptions, TableType, type TextPropertiesOptions, type Top10FilterOptions, TotalsRowFunction, type WebPropertiesOptions, type WebPublishingOptions, type WebTableSelection, type WorkbookOptions, type WorkbookProtectionOptions, type WorksheetChartOptions, type WorksheetContext, type WorksheetOptions, type XlsxDocument, type XlsxPartRefs, XlsxReadContext, XlsxWriteContext, type XmlCellPropertiesOptions, type XmlColumnPropertiesOptions, type XmlPropertiesOptions, buildExternalReferencesXml, buildTablePartsXml, stringifyWorksheet as buildWorksheetXml, stringifyWorksheet, calcChainDesc, chartsheetDesc, columnToLetter, commentsDesc, compileWorkbook, connectionsDesc, createThemeXml, dateToSerialNumber, dialogsheetDesc, drawingDesc, externalLinkDesc, generateWorkbook, generateWorkbookStream, generateWorkbookSync, hashPassword, letterToColumn, lintWorkbookFormulas, mapInfoDesc, metadataDesc, parseWorkbook, parseXlsx, patchWorkbook, pickAnchorOptions, pivotCacheDefDesc, pivotCacheRecordsDesc, pivotTableDesc, queryTableDesc, sharedStringsDesc, singleXmlCellsDesc, stylesDesc, tableDesc, vmlNotesDesc, workbookDesc, worksheetDesc };
2934
3090
  //# sourceMappingURL=index.d.mts.map