@mescius/spread-sheets 19.1.5 → 19.2.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.
@@ -3897,6 +3897,19 @@ declare namespace GC{
3897
3897
  * ```
3898
3898
  */
3899
3899
  getIndexes(): string[];
3900
+ /**
3901
+ * Refreshes the remote data of the data manager table.
3902
+ * This method forces a reload of the underlying remote data source.
3903
+ * It uses the same reload flow as `fetch(true)`, but marks the operation as originating from `refreshRemoteData` for listeners or host integrations.
3904
+ * @returns {Promise<any>} A promise that resolves when the remote data refresh is complete.
3905
+ * @example
3906
+ * ```javascript
3907
+ * const dm = spread.dataManager();
3908
+ * const products = dm.tables.products;
3909
+ * await products.refreshRemoteData();
3910
+ * ```
3911
+ */
3912
+ refreshRemoteData(): Promise<any>;
3900
3913
  /**
3901
3914
  * Removes a view.
3902
3915
  * @param {string} name - The name of the view to be removed.
@@ -4956,6 +4969,7 @@ declare namespace GC{
4956
4969
  /**
4957
4970
  * Provides the base class from which the classes that represent expression tree nodes are derived. This is an abstract class.
4958
4971
  * @class
4972
+ * @param {GC.Spread.CalcEngine.ExpressionType} type The type of the Expression
4959
4973
  * @example
4960
4974
  * ```javascript
4961
4975
  * // the below code will return a Expression
@@ -6030,6 +6044,17 @@ declare namespace GC{
6030
6044
  * ```
6031
6045
  */
6032
6046
  NumberFormat: GC.Spread.Common.INumberFormat;
6047
+ /**
6048
+ * The paper kind be used to specify the paper size.
6049
+ * @type {number}
6050
+ * @example
6051
+ * ```javascript
6052
+ * //This example set the paperKind of CultureInfo:
6053
+ * var culture = new GC.Spread.Common.CultureInfo();
6054
+ * culture.paperKind = 9; // GC.Spread.Sheets.Print.PaperKind.a4
6055
+ * ```
6056
+ */
6057
+ paperKind?: number;
6033
6058
  /**
6034
6059
  * The predefinedFormats is an object that describes part of the number format in format dialog.
6035
6060
  * When opening the format dialog, designer read predefinedFormats in all CultureInfos to display culture related formats.
@@ -6131,7 +6156,7 @@ declare namespace GC{
6131
6156
  * Adds the cultureInfo or custom language into the culture manager.
6132
6157
  * @static
6133
6158
  * @param {string} cultureName The culture name to set.
6134
- * @param {GC.Spread.Common.CultureInfo} cultureInfo The cultureInfo set to the culture.
6159
+ * @param {GC.Spread.Common.CultureInfo} culture The culture information to add.
6135
6160
  * @param {object} language The custom language set to the culture. If already set, it will overwrite the old language.
6136
6161
  * @example
6137
6162
  * ```javascript
@@ -6411,7 +6436,7 @@ declare namespace GC{
6411
6436
  fromJSON(settings: Object): void;
6412
6437
  /**
6413
6438
  * Parses the specified text. This function should be overwritten.
6414
- * @param {string} text The text.
6439
+ * @param {string} str The formatted text to parse.
6415
6440
  * @returns {Object} The parsed object.
6416
6441
  * @example
6417
6442
  * ```javascript
@@ -6530,7 +6555,7 @@ declare namespace GC{
6530
6555
  formatString(value?: string): string | GC.Spread.Formatter.GeneralFormatter;
6531
6556
  /**
6532
6557
  * Parses the specified text.
6533
- * @param {string} text The text.
6558
+ * @param {string} str The text to parse.
6534
6559
  * @returns {Object} The parsed object.
6535
6560
  * @example
6536
6561
  * ```javascript
@@ -6546,6 +6571,12 @@ declare namespace GC{
6546
6571
 
6547
6572
  namespace Pivot{
6548
6573
 
6574
+ export interface IPivotDataSource{
6575
+ source: string;
6576
+ autoRefresh?: boolean;
6577
+ }
6578
+
6579
+
6549
6580
  export interface IPivotItemInfo{
6550
6581
  fieldName: string;
6551
6582
  fieldItem: string;
@@ -6618,6 +6649,18 @@ declare namespace GC{
6618
6649
  }
6619
6650
 
6620
6651
 
6652
+ /**
6653
+ * @typedef {object} GC.Spread.Pivot.IDimensionSubtotalsInfo
6654
+ * @property {boolean} useDefault whether to use the default subtotal behavior.
6655
+ * @property {GC.Pivot.SubtotalType[]} types the custom subtotal types for the source field.
6656
+ */
6657
+ export type IDimensionSubtotalsInfo =
6658
+ {
6659
+ useDefault: boolean;
6660
+ types: GC.Pivot.SubtotalType[];
6661
+ }
6662
+
6663
+
6621
6664
  /**
6622
6665
  * @typedef {object} GC.Spread.Pivot.IFieldInfo - the field info of a pivot table field
6623
6666
  * @property {string} fieldName the field name
@@ -6750,12 +6793,14 @@ declare namespace GC{
6750
6793
  * @typedef {object} GC.Spread.Pivot.IPivotReference
6751
6794
  * @property {string} fieldName
6752
6795
  * @property {boolean} [subtotal]
6796
+ * @property {GC.Pivot.SubtotalType[]} [subtotalTypes] the custom subtotal types to match in the pivot area.
6753
6797
  * @property {string[]} [items]
6754
6798
  */
6755
6799
  export type IPivotReference =
6756
6800
  {
6757
6801
  fieldName: string;
6758
6802
  subtotal?: boolean;
6803
+ subtotalTypes?: GC.Pivot.SubtotalType[];
6759
6804
  items?: string[];
6760
6805
  }
6761
6806
 
@@ -6792,7 +6837,7 @@ declare namespace GC{
6792
6837
  * @property {boolean} [fillDownLabels]
6793
6838
  * @property {boolean} [insertBlankLineAfterEachItem]
6794
6839
  * @property {GC.Spread.Pivot.GrandTotalPosition} grandTotalPosition
6795
- * @property {GC.Spread.Pivot.SubtotalsPosition} subtotalsPosition
6840
+ * @property {GC.Spread.Pivot.SubtotalsPosition} subtotalsPosition the subtotal position of pivot table.
6796
6841
  * @property {GC.Spread.Pivot.DisplayFields} displayFieldsInPageFilterArea
6797
6842
  * @property {number} reportFilterFieldsPerColumn
6798
6843
  * @property {boolean} [bandRows]
@@ -6929,6 +6974,7 @@ declare namespace GC{
6929
6974
  * @property {GC.Spread.Pivot.IPivotStyle} [styles] the pivot area styles of pivot table
6930
6975
  * @property {object} [collapseItems] the collapse info of pivot table
6931
6976
  * @property {GC.Spread.Pivot.ISerializeShowDataAsInfo[]} [showDataAsList] the show data as info of pivot table
6977
+ * @property {Object.<string, GC.Spread.Pivot.IDimensionSubtotalsInfo>} [dimensionSubtotalsInfo] the custom subtotal info of pivot table source fields.
6932
6978
  */
6933
6979
  export type ISerializeInfo =
6934
6980
  {
@@ -6941,6 +6987,7 @@ declare namespace GC{
6941
6987
  styles?: GC.Spread.Pivot.IPivotStyle[];
6942
6988
  collapseItems?: object;
6943
6989
  showDataAsList?: GC.Spread.Pivot.ISerializeShowDataAsInfo[];
6990
+ dimensionSubtotalsInfo?: { [sourceName: string]: GC.Spread.Pivot.IDimensionSubtotalsInfo };
6944
6991
  showNoDataInfo?: object
6945
6992
  }
6946
6993
 
@@ -6997,6 +7044,14 @@ declare namespace GC{
6997
7044
  }
6998
7045
  }
6999
7046
 
7047
+
7048
+ /**
7049
+ * @typedef GC.Spread.Pivot.PivotSource
7050
+ * A source reference string or a DataManager-backed Pivot source descriptor. A source reference string uses the current string source resolver, such as a worksheet range reference, table name, or TableSheet name.
7051
+ */
7052
+ export type PivotSource =
7053
+ string | GC.Spread.Pivot.IPivotDataSource
7054
+
7000
7055
  /**
7001
7056
  * Indicates whether PivotTable total contains the value of calcItem.
7002
7057
  */
@@ -7382,6 +7437,8 @@ declare namespace GC{
7382
7437
  * @param {number} col Indicates the pivot table start column.
7383
7438
  * @param {GC.Spread.Pivot.PivotTableLayoutType} layout Indicates the pivot table layout type.
7384
7439
  * @param {string | GC.Spread.Pivot.PivotTableTheme} style Indicates the pivot table theme style or style name.
7440
+ * @param {GC.Spread.Pivot.IPivotTableOption} options Indicates the options of the pivot table.
7441
+ * @param {any} layoutModel Deprecated since v19.2.0. Indicates the pivot table layout model.
7385
7442
  */
7386
7443
  constructor(name: string, sheet?: GC.Spread.Sheets.Worksheet, row?: number, col?: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, style?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption, layoutModel?: any);
7387
7444
  /**
@@ -7695,9 +7752,43 @@ declare namespace GC{
7695
7752
  * ```
7696
7753
  */
7697
7754
  deserialize(serializeInfo: GC.Spread.Pivot.ISerializeInfo): void;
7755
+ /**
7756
+ * @description Get or set custom subtotal information for a PivotTable source field.
7757
+ * @param {string} sourceName The name of source field.
7758
+ * @param {GC.Spread.Pivot.IDimensionSubtotalsInfo} info The custom subtotal information. If omitted, the method returns current custom subtotal information.
7759
+ * @returns {GC.Spread.Pivot.IDimensionSubtotalsInfo | void} If info is omitted, returns the current custom subtotal information; otherwise returns void.
7760
+ * @example
7761
+ * ```javascript
7762
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
7763
+ * var sourceSheet = spread.getSheet(0)
7764
+ * var sheet = spread.getSheet(1);
7765
+ * var sourceData = [["Date","Buyer","Type","Amount"],
7766
+ * ["01-Jan","Mom","Fuel",74],
7767
+ * ["15-Jan","Mom","Food",235],
7768
+ * ["17-Jan","Dad","Sports",20],
7769
+ * ["21-Jan","Kelly","Books",125]];
7770
+ * sourceSheet.setArray(0, 0, sourceData);
7771
+ * sourceSheet.tables.add('sourceData', 0, 0, 5, 4);
7772
+ * var layout = GC.Spread.Pivot.PivotTableLayoutType.compact;
7773
+ * var theme = GC.Spread.Pivot.PivotTableThemes.medium2;
7774
+ * var options = {showRowHeader: true, showColumnHeader: true};
7775
+ * sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme, options);
7776
+ * var pivotTable = sheet.pivotTables.get("pivotTable_1");
7777
+ * pivotTable.add("Date","Date",GC.Spread.Pivot.PivotTableFieldType.rowField);
7778
+ * pivotTable.add("Buyer","Buyer",GC.Spread.Pivot.PivotTableFieldType.rowField);
7779
+ * pivotTable.add("Type","Type",GC.Spread.Pivot.PivotTableFieldType.columnField);
7780
+ * pivotTable.add("Amount","Sum of Amount",GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
7781
+ * pivotTable.dimensionSubtotals("Buyer", {
7782
+ * useDefault: false,
7783
+ * types: [GC.Pivot.SubtotalType.sum, GC.Pivot.SubtotalType.average]
7784
+ * });
7785
+ * var subtotalInfo = pivotTable.dimensionSubtotals("Buyer");
7786
+ * ```
7787
+ */
7788
+ dimensionSubtotals(sourceName: string, info?: GC.Spread.Pivot.IDimensionSubtotalsInfo): GC.Spread.Pivot.IDimensionSubtotalsInfo | void;
7698
7789
  /**
7699
7790
  * Disconnect slicer with PivotTable
7700
- * @param {string} ptName name of slicer
7791
+ * @param {string} name The name of the slicer to disconnect.
7701
7792
  */
7702
7793
  disconnectSlicer(name: string): void;
7703
7794
  /**
@@ -7971,7 +8062,7 @@ declare namespace GC{
7971
8062
  getRange(): GC.Spread.Pivot.IPivotTableRange;
7972
8063
  /**
7973
8064
  * @description get PivotTable data refer
7974
- * @returns {string}
8065
+ * @returns {GC.Spread.Pivot.PivotSource}
7975
8066
  * @example
7976
8067
  * ```javascript
7977
8068
  * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
@@ -7991,7 +8082,7 @@ declare namespace GC{
7991
8082
  * pivotTable.getSource();
7992
8083
  * ```
7993
8084
  */
7994
- getSource(): string;
8085
+ getSource(): GC.Spread.Pivot.PivotSource;
7995
8086
  /**
7996
8087
  * @description get PivotTable source field information
7997
8088
  * @returns {GC.Spread.Pivot.ISourceFieldInfo[]}
@@ -8407,7 +8498,7 @@ declare namespace GC{
8407
8498
  showDataAs(fieldName: string, showDataAsInfo?: GC.Spread.Pivot.IPivotShowDataAsInfo): GC.Spread.Pivot.IPivotShowDataAsInfo | void;
8408
8499
  /**
8409
8500
  * @description set or get field 'show items with no data' information
8410
- * @param {string} fieldName The name of cache field name
8501
+ * @param {string} cacheFieldName The name of the cache field
8411
8502
  * @param {boolean} isShow The flag indicates whether items without data need to be displayed
8412
8503
  * @returns {boolean}
8413
8504
  * @example
@@ -8525,8 +8616,8 @@ declare namespace GC{
8525
8616
  subtotalType(fieldName: string, type?:GC.Pivot.SubtotalType): GC.Pivot.SubtotalType | void;
8526
8617
  /**
8527
8618
  * @description set or get whether the field displays subtotal information.
8528
- * @param {string} fieldName Indicates the field name.
8529
- * @param {boolean} position Indicates whether to display subtotal information for the field.
8619
+ * @param {string} fieldName The name of the field.
8620
+ * @param {boolean} isVisible Whether to display subtotals for the field.
8530
8621
  * @returns {boolean}
8531
8622
  * @example
8532
8623
  * ```javascript
@@ -8710,6 +8801,7 @@ declare namespace GC{
8710
8801
  updateFieldName(oldName: string, newName: string): void;
8711
8802
  /**
8712
8803
  * @description refresh pivotTable data source
8804
+ * @param {GC.Spread.Pivot.PivotSource} source Indicates the new source for the pivot table. If omitted, the current PivotCache is refreshed from its current source.
8713
8805
  * @returns {void}
8714
8806
  * @example
8715
8807
  * ```javascript
@@ -8743,7 +8835,7 @@ declare namespace GC{
8743
8835
  * pivotTable.updateSource('newSourceData');
8744
8836
  * ```
8745
8837
  */
8746
- updateSource(source?: string): void;
8838
+ updateSource(source?: GC.Spread.Pivot.PivotSource): void;
8747
8839
  /**
8748
8840
  * Get or set value filter info for a field.
8749
8841
  * @param {string} fieldName Indicates the target field name of pivot table.
@@ -11466,6 +11558,8 @@ declare namespace GC{
11466
11558
  /**
11467
11559
  * Represents a PivotTableViewManager.
11468
11560
  * @class
11561
+ * @param {Function} applyCallback The callback used to apply a saved view configuration to the pivot table.
11562
+ * @param {Function} saveCallback The callback used to retrieve the current pivot table configuration for saving as a view.
11469
11563
  */
11470
11564
  constructor(applyCallback: Function, saveCallback: Function);
11471
11565
  /**
@@ -11950,6 +12044,10 @@ declare namespace GC{
11950
12044
 
11951
12045
 
11952
12046
  /**
12047
+ * @typedef GC.Spread.Report.SheetNameGenerator
12048
+ * @param {number} pageIndex - The zero-based index of the report page.
12049
+ * @returns {string} The worksheet name for the report page.
12050
+ * @description The callback used to generate a worksheet name for each report page.
11953
12051
  */
11954
12052
  export type SheetNameGenerator =
11955
12053
  (pageIndex: number) => string
@@ -12152,7 +12250,7 @@ declare namespace GC{
12152
12250
  /**
12153
12251
  * Generate the every page of the current report as a worksheet, and return them in an array.
12154
12252
  * @param {boolean} addToSpread Control whether add the page sheets to the current spread.
12155
- * @param {Function} sheetNameGenerator The optional sheet name generator.
12253
+ * @param {GC.Spread.Report.SheetNameGenerator} sheetNameGenerator The optional sheet name generator.
12156
12254
  * @returns {GC.Spread.Sheets.Worksheet[]} Return the generated worksheets.
12157
12255
  * @example
12158
12256
  * ```javascript
@@ -13143,6 +13241,12 @@ declare namespace GC{
13143
13241
  }
13144
13242
 
13145
13243
 
13244
+ export interface IBackgroundImageOption{
13245
+ layout?: 'repeat' | 'none';
13246
+ paintOrder?: 'normal' | 'over-content';
13247
+ }
13248
+
13249
+
13146
13250
  export interface IBaseSpreadOption{
13147
13251
  width?: number;
13148
13252
  height?: number;
@@ -13716,6 +13820,22 @@ declare namespace GC{
13716
13820
  }
13717
13821
 
13718
13822
 
13823
+ export interface IFocusCellOptions{
13824
+ /**
13825
+ * Whether to highlight the active cell's row and column.
13826
+ */
13827
+ enabled?: boolean;
13828
+ /**
13829
+ * The color of the focus cell highlight bands.
13830
+ */
13831
+ color?: string;
13832
+ /**
13833
+ * The opacity of the focus cell highlight bands [0-1]. Ignored when the color already contains alpha channel.
13834
+ */
13835
+ opacity?: number;
13836
+ }
13837
+
13838
+
13719
13839
  export interface IFontColorSortInfo{
13720
13840
  order: "top" | "bottom";
13721
13841
  fontColor?: string;
@@ -14169,6 +14289,10 @@ declare namespace GC{
14169
14289
  * True if the user can edit floating objects.
14170
14290
  */
14171
14291
  allowEditObjects?: boolean;
14292
+ /**
14293
+ * True if the user can edit locked scenario overrides on a protected worksheet.
14294
+ */
14295
+ allowEditScenarios?: boolean;
14172
14296
  /**
14173
14297
  * True if the user can resize rows.
14174
14298
  */
@@ -14373,6 +14497,42 @@ declare namespace GC{
14373
14497
  }
14374
14498
 
14375
14499
 
14500
+ export interface IScenarioChangedEventArgs{
14501
+ /**
14502
+ * The scenario action that has completed.
14503
+ */
14504
+ action: GC.Spread.Sheets.Scenarios.ScenarioActionType;
14505
+ /**
14506
+ * The scenario that changed.
14507
+ */
14508
+ scenario: GC.Spread.Sheets.Scenarios.IScenario;
14509
+ /**
14510
+ * The original scenario before update. Available only when the action is "update".
14511
+ */
14512
+ originScenario?: GC.Spread.Sheets.Scenarios.IScenario;
14513
+ }
14514
+
14515
+
14516
+ export interface IScenarioChangingEventArgs{
14517
+ /**
14518
+ * The scenario action that is about to occur.
14519
+ */
14520
+ action: GC.Spread.Sheets.Scenarios.ScenarioActionType;
14521
+ /**
14522
+ * The scenario that is about to change.
14523
+ */
14524
+ scenario: GC.Spread.Sheets.Scenarios.IScenario;
14525
+ /**
14526
+ * The original scenario before update. Available only when the action is "update".
14527
+ */
14528
+ originScenario?: GC.Spread.Sheets.Scenarios.IScenario;
14529
+ /**
14530
+ * Indicates whether the operation should be canceled.
14531
+ */
14532
+ cancel: boolean;
14533
+ }
14534
+
14535
+
14376
14536
  export interface ISelectionChangedEventArgs{
14377
14537
  sheet: GC.Spread.Sheets.Worksheet;
14378
14538
  sheetName: string;
@@ -14422,6 +14582,10 @@ declare namespace GC{
14422
14582
  * Whether to save the r1c1 formula in the file.
14423
14583
  */
14424
14584
  saveR1C1Formula?: boolean;
14585
+ /**
14586
+ * Whether to include PivotCache data for PivotTables created from an external Pivot source.
14587
+ */
14588
+ saveExternalSourcePivotCache?: boolean;
14425
14589
  }
14426
14590
 
14427
14591
 
@@ -14440,6 +14604,12 @@ declare namespace GC{
14440
14604
  }
14441
14605
 
14442
14606
 
14607
+ export interface ISetBorderRadiusOptions{
14608
+ all?: boolean;
14609
+ outer?: boolean;
14610
+ }
14611
+
14612
+
14443
14613
  export interface IShapeChangedEventArgs{
14444
14614
  sheet: GC.Spread.Sheets.Worksheet;
14445
14615
  sheetName: string;
@@ -14970,6 +15140,10 @@ declare namespace GC{
14970
15140
  * All built-in file icons.
14971
15141
  */
14972
15142
  builtInFileIcons?: GC.Spread.Sheets.IBuiltInFileIcons;
15143
+ /**
15144
+ * The focus cell settings for highlighting the active cell's row and column bands.
15145
+ */
15146
+ focusCell?: GC.Spread.Sheets.IFocusCellOptions;
14973
15147
  }
14974
15148
 
14975
15149
 
@@ -15233,6 +15407,10 @@ declare namespace GC{
15233
15407
  * The scrollbar appearance, contains skin and mobile two enums. The default value is GC.Spread.Sheets.ScrollbarAppearance.skin.
15234
15408
  */
15235
15409
  scrollbarAppearance?: GC.Spread.Sheets.ScrollbarAppearance;
15410
+ /**
15411
+ * Specifies the display mode when date/number data width is longer than column width. The default value is GC.Spread.Sheets.NumbersFitMode.mask.
15412
+ */
15413
+ numbersFitMode?: GC.Spread.Sheets.NumbersFitMode;
15236
15414
  /**
15237
15415
  * Whether paste skip invisible range. The default value is false.
15238
15416
  */
@@ -15261,6 +15439,10 @@ declare namespace GC{
15261
15439
  * All built-in file icons.
15262
15440
  */
15263
15441
  builtInFileIcons: GC.Spread.Sheets.IBuiltInFileIcons;
15442
+ /**
15443
+ * The focus cell settings for highlighting the active cell's row and column bands.
15444
+ */
15445
+ focusCell: GC.Spread.Sheets.IFocusCellOptions;
15264
15446
  }
15265
15447
 
15266
15448
 
@@ -15476,6 +15658,7 @@ declare namespace GC{
15476
15658
  * @property {boolean} [rowHeadersAsFrozenColumns] - Whether to treat the row headers as frozen columns when converting the workbook to json, default false.
15477
15659
  * @property {boolean} [columnHeadersAsFrozenRows] - Whether to treat the column headers as frozen rows when converting the workbook to json, default false.
15478
15660
  * @property {boolean} [includeAutoMergedCells] - Whether to include the automatically merged cells when converting the workbook to json, default false.
15661
+ * @property {boolean} [saveExternalSourcePivotCache] - Whether to include PivotCache data for PivotTables created from an external Pivot source.
15479
15662
  */
15480
15663
  export type ExportSSJsonOptions =
15481
15664
  {
@@ -15487,6 +15670,7 @@ declare namespace GC{
15487
15670
  columnHeadersAsFrozenRows?: boolean;
15488
15671
  includeAutoMergedCells?: boolean;
15489
15672
  saveR1C1Formula?: boolean;
15673
+ saveExternalSourcePivotCache?: boolean;
15490
15674
  }
15491
15675
 
15492
15676
 
@@ -15713,6 +15897,7 @@ declare namespace GC{
15713
15897
  * @property {boolean} [includeUnusedNames] - Whether to include the unused custom name when do save, default true.
15714
15898
  * @property {boolean} [includeEmptyRegionCells] - Whether to include any empty cells(cells with no data or only style) outside the used data range, default true.
15715
15899
  * @property {boolean} [saveR1C1Formula] - Whether to save the r1c1 formula in the file, only works in sjs file type, default false.
15900
+ * @property {boolean} [saveExternalSourcePivotCache] - Whether to include PivotCache data for PivotTables created from an external Pivot source.
15716
15901
  */
15717
15902
  export type SaveOptions =
15718
15903
  {
@@ -15725,6 +15910,7 @@ declare namespace GC{
15725
15910
  includeAutoMergedCells?: boolean;
15726
15911
  includeCalcModelCache?: boolean;
15727
15912
  saveR1C1Formula?: boolean;
15913
+ saveExternalSourcePivotCache?: boolean;
15728
15914
  }
15729
15915
 
15730
15916
 
@@ -16372,10 +16558,14 @@ declare namespace GC{
16372
16558
  * Indicates the type of data is an alternative text.
16373
16559
  */
16374
16560
  altText= 4096,
16561
+ /**
16562
+ * Indicates the type of data is scenario.
16563
+ */
16564
+ scenario= 32768,
16375
16565
  /**
16376
16566
  * Indicates all types of data.
16377
16567
  */
16378
- all= 32767
16568
+ all= 65535
16379
16569
  }
16380
16570
 
16381
16571
  /**
@@ -18269,6 +18459,27 @@ declare namespace GC{
18269
18459
  * ```
18270
18460
  */
18271
18461
  borderLeft(value?: GC.Spread.Sheets.LineBorder): any;
18462
+ /**
18463
+ * Gets or sets the border radius shorthand.
18464
+ * @param {string} value The border radius shorthand. When four values are provided, they map to top-left, top-right, bottom-right, and bottom-left. One value applies to all corners; two values apply to top-left/bottom-right and top-right/bottom-left; three values apply to top-left, top-right/bottom-left, and bottom-right.
18465
+ * @returns {string|GC.Spread.Sheets.CellRange} If no value is set, returns the value of the border radius shorthand; otherwise, returns the cell.
18466
+ * @example
18467
+ * ```javascript
18468
+ * // Apply 10 to all corners.
18469
+ * activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderRadius('10');
18470
+ * ```
18471
+ * @example
18472
+ * ```javascript
18473
+ * // Apply 10 to top-left/bottom-right and 20 to top-right/bottom-left.
18474
+ * activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderRadius('10 20');
18475
+ * ```
18476
+ * @example
18477
+ * ```javascript
18478
+ * // Apply 10, 20, 30, and 40 to top-left, top-right, bottom-right, and bottom-left.
18479
+ * activeSheet.getCell(1,1).borderRadius('10 20 30 40');
18480
+ * ```
18481
+ */
18482
+ borderRadius(value?: string): any;
18272
18483
  /**
18273
18484
  * Gets or sets the right border of the cell.
18274
18485
  * @param {GC.Spread.Sheets.LineBorder} value The cell right border line.
@@ -18706,17 +18917,17 @@ declare namespace GC{
18706
18917
  * Sets the border for the specified area.
18707
18918
  * @param {GC.Spread.Sheets.LineBorder} border The border line.
18708
18919
  * @param {Object} option Determines which part of the cell range to set, the option object contains {all:true, left:true, top:true, right:true, bottom:true, diagonalUp:true, diagonalDown:true, outline:true,inside:true, innerHorizontal:true, innerVertical:true}
18709
- * @param {boolean} [options.all] - all border.
18710
- * @param {boolean} [options.left] - left border.
18711
- * @param {boolean} [options.top] - top border.
18712
- * @param {boolean} [options.right] - right border.
18713
- * @param {boolean} [options.bottom] - bottom border.
18714
- * @param {boolean} [options.outline] - outline border.
18715
- * @param {boolean} [options.inside] - inside border.
18716
- * @param {boolean} [options.innerHorizontal] - innerHorizontal border.
18717
- * @param {boolean} [options.innerVertical] - innerVertical border.
18718
- * @param {boolean} [options.diagonalUp] - diagonalUp border.
18719
- * @param {boolean} [options.diagonalDown] - diagonalDown border.
18920
+ * @param {boolean} [option.all] - all border.
18921
+ * @param {boolean} [option.left] - left border.
18922
+ * @param {boolean} [option.top] - top border.
18923
+ * @param {boolean} [option.right] - right border.
18924
+ * @param {boolean} [option.bottom] - bottom border.
18925
+ * @param {boolean} [option.outline] - outline border.
18926
+ * @param {boolean} [option.inside] - inside border.
18927
+ * @param {boolean} [option.innerHorizontal] - innerHorizontal border.
18928
+ * @param {boolean} [option.innerVertical] - innerVertical border.
18929
+ * @param {boolean} [option.diagonalUp] - diagonalUp border.
18930
+ * @param {boolean} [option.diagonalDown] - diagonalDown border.
18720
18931
  * @example
18721
18932
  * ```javascript
18722
18933
  * //This example creates borders.
@@ -18738,6 +18949,24 @@ declare namespace GC{
18738
18949
  * ```
18739
18950
  */
18740
18951
  setBorder(border: GC.Spread.Sheets.LineBorder, option: GC.Spread.Sheets.ISetBorderOptions): void;
18952
+ /**
18953
+ * Sets the border radius for the specified area using range-relative semantics.
18954
+ * @param {string|undefined} value The border radius shorthand string with one to four non-negative numbers, or undefined to clear the border radius. When four values are provided, they map to top-left, top-right, bottom-right, and bottom-left. One value applies to all corners; two values apply to top-left/bottom-right and top-right/bottom-left; three values apply to top-left, top-right/bottom-left, and bottom-right. Other values are ignored.
18955
+ * @param {Object} option Determines how the value is applied.
18956
+ * @param {boolean} [option.all] Applies the same valid shorthand to every cell in the target range, or clears every cell when value is undefined.
18957
+ * @param {boolean} [option.outer] Applies the value only to the visible outer-corner cells of the target range. Valid shorthand is expanded to four logical corners, and if multiple logical corners map to the same target cell, they are merged into a single shorthand in the current operation. Undefined clears the visible outer-corner cells. If no visible outer frame exists, the operation is a no-op.
18958
+ * @example
18959
+ * ```javascript
18960
+ * // Apply 8 to top-left/bottom-right and 12 to top-right/bottom-left for all cells in the range.
18961
+ * sheet.getRange(1, 1, 2, 2).setBorderRadius("8 12", { all: true });
18962
+ * ```
18963
+ * @example
18964
+ * ```javascript
18965
+ * // Apply 8, 12, 16, and 20 to the visible top-left, top-right, bottom-right, and bottom-left outer corners of the range.
18966
+ * sheet.getRange(0, 0, 3, 3).setBorderRadius("8 12 16 20", { outer: true });
18967
+ * ```
18968
+ */
18969
+ setBorderRadius(value: string | undefined, option: GC.Spread.Sheets.ISetBorderRadiusOptions): void;
18741
18970
  /**
18742
18971
  * Sets the style for the cell.
18743
18972
  * @param {GC.Spread.Sheets.Style} value The style.
@@ -21036,6 +21265,41 @@ declare namespace GC{
21036
21265
  * ```
21037
21266
  */
21038
21267
  static RowOperation: string;
21268
+ /**
21269
+ * Occurs when a scenario has changed.
21270
+ * @name GC.Spread.Sheets.Workbook#ScenarioChanged
21271
+ * @event
21272
+ * @param eventParam *string* `action` The scenario action. The value is "add", "update", "remove", "apply", "restore", "activate", or "deactivate".
21273
+ * @param eventParam *{@link GC.Spread.Sheets.Scenarios.IScenario}* `scenario` The scenario that triggered the event.
21274
+ * @param eventParam *{@link GC.Spread.Sheets.Scenarios.IScenario}* `[originScenario]` The original scenario before update. This value is available only when the action is "update".
21275
+ * @example
21276
+ * ```javascript
21277
+ * //This example logs scenario changes.
21278
+ * spread.bind(GC.Spread.Sheets.Events.ScenarioChanged, function (sender, args) {
21279
+ * console.log(args.action, args.scenario.name);
21280
+ * });
21281
+ * ```
21282
+ */
21283
+ static ScenarioChanged: string;
21284
+ /**
21285
+ * Occurs when a scenario is about to change.
21286
+ * @name GC.Spread.Sheets.Workbook#ScenarioChanging
21287
+ * @event
21288
+ * @param eventParam *string* `action` The scenario action. The value is "add", "update", "remove", "apply", "restore", "activate", or "deactivate".
21289
+ * @param eventParam *{@link GC.Spread.Sheets.Scenarios.IScenario}* `scenario` The scenario that is about to be changed.
21290
+ * @param eventParam *{@link GC.Spread.Sheets.Scenarios.IScenario}* `[originScenario]` The original scenario before update. This value is available only when the action is "update".
21291
+ * @param eventParam *boolean* `cancel` A value that indicates whether the operation should be canceled.
21292
+ * @example
21293
+ * ```javascript
21294
+ * //This example prevents the specified scenario from being removed.
21295
+ * spread.bind(GC.Spread.Sheets.Events.ScenarioChanging, function (sender, args) {
21296
+ * if (args.action === "remove" && args.scenario.name === "Base Plan") {
21297
+ * args.cancel = true;
21298
+ * }
21299
+ * });
21300
+ * ```
21301
+ */
21302
+ static ScenarioChanging: string;
21039
21303
  /**
21040
21304
  * Occurs when the selection of cells on the sheet has changed.
21041
21305
  * @name GC.Spread.Sheets.Worksheet#SelectionChanged
@@ -21570,6 +21834,91 @@ declare namespace GC{
21570
21834
  * ```
21571
21835
  */
21572
21836
  static TableRowsChanged: string;
21837
+ /**
21838
+ * Occurs when a column has just been cleared from filter.
21839
+ * @name GC.Spread.Sheets.TableSheet#TableSheetFilterCleared
21840
+ * @event
21841
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21842
+ * @param eventParam *string* `sheetName` The sheet's name.
21843
+ * @param eventParam *number* `col` The index of the column has just been cleared from filter.
21844
+ */
21845
+ static TableSheetFilterCleared: string;
21846
+ /**
21847
+ * Occurs when a column is about to be cleared from filter.
21848
+ * @name GC.Spread.Sheets.TableSheet#TableSheetFilterClearing
21849
+ * @event
21850
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21851
+ * @param eventParam *string* `sheetName` The sheet's name.
21852
+ * @param eventParam *number* `col` The index of the column to be cleared from filter.
21853
+ * @param eventParam *boolean* `cancel` Whether the operation should be canceled.
21854
+ */
21855
+ static TableSheetFilterClearing: string;
21856
+ /**
21857
+ * Occurs when a column has just been filtered.
21858
+ * @name GC.Spread.Sheets.TableSheet#TableSheetFiltered
21859
+ * @event
21860
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21861
+ * @param eventParam *string* `sheetName` The sheet's name.
21862
+ * @param eventParam *number* `col` The index of the column to be filtered.
21863
+ * @param eventParam *Array* `values` The values by which to filter the column.
21864
+ * @param eventParam *Object* `condition` The condition rule info by which to filter the column.
21865
+ * @param eventParam *Array* `paths` The paths by which to filter the column.
21866
+ */
21867
+ static TableSheetFiltered: string;
21868
+ /**
21869
+ * Occurs when a column is about to be filtered.
21870
+ * @name GC.Spread.Sheets.TableSheet#TableSheetFiltering
21871
+ * @event
21872
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21873
+ * @param eventParam *string* `sheetName` The sheet's name.
21874
+ * @param eventParam *number* `col` The index of the column to be filtered.
21875
+ * @param eventParam *Array* `values` The values by which to filter the column.
21876
+ * @param eventParam *Object* `condition` The condition rule info by which to filter the column.
21877
+ * @param eventParam *Array* `paths` The paths by which to filter the column.
21878
+ * @param eventParam *boolean* `cancel` Whether the operation should be canceled.
21879
+ */
21880
+ static TableSheetFiltering: string;
21881
+ /**
21882
+ * Occurs when a column has just been cleared from sort.
21883
+ * @name GC.Spread.Sheets.TableSheet#TableSheetSortCleared
21884
+ * @event
21885
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21886
+ * @param eventParam *string* `sheetName` The sheet's name.
21887
+ * @param eventParam *number* `col` The index of the column has just been cleared from sort.
21888
+ */
21889
+ static TableSheetSortCleared: string;
21890
+ /**
21891
+ * Occurs when a column is about to be cleared from sort.
21892
+ * @name GC.Spread.Sheets.TableSheet#TableSheetSortClearing
21893
+ * @event
21894
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21895
+ * @param eventParam *string* `sheetName` The sheet's name.
21896
+ * @param eventParam *number* `col` The index of the column to be cleared from sort.
21897
+ * @param eventParam *boolean* `cancel` Whether the operation should be canceled.
21898
+ */
21899
+ static TableSheetSortClearing: string;
21900
+ /**
21901
+ * Occurs when a column has just been sorted.
21902
+ * @name GC.Spread.Sheets.TableSheet#TableSheetSorted
21903
+ * @event
21904
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21905
+ * @param eventParam *string* `sheetName` The sheet's name.
21906
+ * @param eventParam *number* `col` The index of the column to be sorted.
21907
+ * @param eventParam *boolean* `ascending` Whether the sort is ascending.
21908
+ */
21909
+ static TableSheetSorted: string;
21910
+ /**
21911
+ * Occurs when a column is about to be sorted.
21912
+ * @name GC.Spread.Sheets.TableSheet#TableSheetSorting
21913
+ * @event
21914
+ * @param eventParam *{@link GC.Spread.Sheets.TableSheet.TableSheet}* `sheet` The sheet that triggered the event.
21915
+ * @param eventParam *string* `sheetName` The sheet's name.
21916
+ * @param eventParam *number* `col` The index of the column to be sorted.
21917
+ * @param eventParam *boolean* `ascending` Whether the sort is ascending.
21918
+ * @param eventParam *boolean* `cancel` Whether the operation should be canceled.
21919
+ * @param eventParam *string | Function* `compare` The customize function to use when sorting.
21920
+ */
21921
+ static TableSheetSorting: string;
21573
21922
  /**
21574
21923
  * Occurs when any threaded comment has changed.
21575
21924
  * @name GC.Spread.Sheets.Worksheet#ThreadedCommentChanged
@@ -21891,6 +22240,7 @@ declare namespace GC{
21891
22240
  getRow(): number;
21892
22241
  /**
21893
22242
  * Gets/Sets the readonly status of the custom named expression.
22243
+ * @param {boolean} value Sets the readonly status of the custom named expression.
21894
22244
  * @returns {boolean} The readonly status.
21895
22245
  */
21896
22246
  isReadOnly(value?: boolean): boolean;
@@ -21915,7 +22265,7 @@ declare namespace GC{
21915
22265
  /**
21916
22266
  * @description Add a pivot table to current worksheet.
21917
22267
  * @param {string} name Indicates the pivot table name, it should be unique in the whole workbook.
21918
- * @param {string} sourceData Indicates the sourceData is using for pivot table. It supports three types: a table name or a table sheet name or the formula which references a range absolutely.
22268
+ * @param {GC.Spread.Pivot.PivotSource} sourceData Indicates the source data used for the pivot table. It can be a source reference string or a DataManager-backed Pivot source descriptor.
21919
22269
  * @param {number} row Indicates the pivot table start row position.
21920
22270
  * @param {number} col Indicates the pivot table start col position.
21921
22271
  * @param {GC.Spread.Pivot.PivotTableLayoutType} layout Indicates the pivot table layout.
@@ -21960,7 +22310,7 @@ declare namespace GC{
21960
22310
  * sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme);
21961
22311
  * ```
21962
22312
  */
21963
- add(name: string, sourceData: string, row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
22313
+ add(name: string, sourceData: GC.Spread.Pivot.PivotSource, row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
21964
22314
  /**
21965
22315
  * @description Get all pivot table in current worksheet.
21966
22316
  * @return {GC.Spread.Pivot.PivotTable[]} return all pivot table in current worksheet.
@@ -22296,13 +22646,13 @@ declare namespace GC{
22296
22646
  * @param {GC.Spread.Sheets.Rect} rect The rectangle.
22297
22647
  * @returns {GC.Spread.Sheets.Rect} The intersecting rectangle. If the two rectangles do not intersect, returns null.
22298
22648
  */
22299
- getIntersectRect(x: number, y: number, width: number, height: number): GC.Spread.Sheets.Rect;
22649
+ getIntersectRect(rect: GC.Spread.Sheets.Rect): GC.Spread.Sheets.Rect;
22300
22650
  /**
22301
22651
  * Indicates whether the specified rectangle intersects with the current rectangle.
22302
22652
  * @param {number} x The <i>x</i>-coordinate of the top-left corner of the rectangle.
22303
22653
  * @param {number} y The <i>y</i>-coordinate of the top-left corner of the rectangle.
22304
- * @param {number} w The width of the rectangle.
22305
- * @param {number} h The height of the rectangle.
22654
+ * @param {number} width The width of the rectangle.
22655
+ * @param {number} height The height of the rectangle.
22306
22656
  * @returns {boolean} `true` if the specified rectangle intersects with the current rectangle; otherwise, `false`.
22307
22657
  */
22308
22658
  intersect(x: number, y: number, width: number, height: number): boolean;
@@ -22378,16 +22728,14 @@ declare namespace GC{
22378
22728
  * @param {string} font The font.
22379
22729
  * @param {string} themeFont The font theme.
22380
22730
  * @param {string|GC.Spread.Formatter.GeneralFormatter} formatter The formatting object.
22381
- * @param {GC.Spread.Sheets.IMaskType} mask The mask object for input mask.
22382
22731
  * @param {GC.Spread.Sheets.LineBorder} borderLeft The left border.
22383
22732
  * @param {GC.Spread.Sheets.LineBorder} borderTop The top border.
22384
22733
  * @param {GC.Spread.Sheets.LineBorder} borderRight The right border.
22385
22734
  * @param {GC.Spread.Sheets.LineBorder} borderBottom The bottom border.
22386
- * @param {GC.Spread.Sheets.LineBorder} diagonalDown The diagonal with LeftTop to bottomRight.
22387
- * @param {GC.Spread.Sheets.LineBorder} diagonalUp The diagonal with topRight to bottomLeft.
22388
22735
  * @param {boolean} locked Whether the cell, row, or column is locked.
22389
22736
  * @param {number} textIndent The text indent amount.
22390
22737
  * @param {boolean} wordWrap Whether words wrap within the cell or cells.
22738
+ * @param {boolean} showEllipsis Whether to display an ellipsis when the cell content cannot be fully displayed.
22391
22739
  * @param {boolean} shrinkToFit Whether content shrinks to fit the cell or cells.
22392
22740
  * @param {string} backgroundImage The background image to display.
22393
22741
  * @param {GC.Spread.Sheets.CellTypes.Base} cellType The cell type.
@@ -22400,13 +22748,22 @@ declare namespace GC{
22400
22748
  * @param {string} watermark Specifies the watermark content.
22401
22749
  * @param {string} cellPadding Specifies the cell padding.
22402
22750
  * @param {GC.Spread.Sheets.ILabelOptions} labelOptions Specifies the cell label options.
22751
+ * @param {boolean} quotePrefix Whether the cell value should be treated as text.
22752
+ * @param {GC.Spread.Sheets.LineBorder} diagonalDown The diagonal with LeftTop to bottomRight.
22753
+ * @param {GC.Spread.Sheets.LineBorder} diagonalUp The diagonal with topRight to bottomLeft.
22403
22754
  * @param {boolean} isVerticalText Whether to set the cell's text vertical.
22755
+ * @param {GC.Spread.Sheets.ICellButton[]} cellButtons Specifies the cell buttons.
22756
+ * @param {GC.Spread.Sheets.IDropdown[]} dropdown Specifies the cell dropdowns.
22404
22757
  * @param {number} textOrientation the cell text rotation angle.
22758
+ * @param {GC.Spread.Sheets.TextDecorationType} decoration Specifies the text decoration.
22759
+ * @param {GC.Spread.Sheets.IMaskType} mask The mask object for input mask.
22405
22760
  * @param {string} fontStyle Specifies the font style.
22406
22761
  * @param {string} fontWeight Specifies the font weight.
22407
22762
  * @param {string} fontSize Specifies the font size.
22408
22763
  * @param {string} fontFamily Specifies the font family.
22764
+ * @param {boolean} hidden Whether the cell content is hidden.
22409
22765
  * @param {GC.Spread.Sheets.TextDirectionType} textDirection Specifies the direction of the text.
22766
+ * @param {string} borderRadius Specifies the border radius shorthand. When four values are provided, they map to top-left, top-right, bottom-right, and bottom-left. One value applies to all corners; two values apply to top-left/bottom-right and top-right/bottom-left; three values apply to top-left, top-right/bottom-left, and bottom-right.
22410
22767
  * @example
22411
22768
  * ```javascript
22412
22769
  * //This example uses a style with rules.
@@ -22455,7 +22812,7 @@ declare namespace GC{
22455
22812
  * sheet.conditionalFormats.addAverageRule(GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above, style, [new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
22456
22813
  * ```
22457
22814
  */
22458
- constructor(backColor?: string | GC.Spread.Sheets.IPatternFill | GC.Spread.Sheets.IGradientFill | GC.Spread.Sheets.IGradientPathFill, foreColor?: string, hAlign?: GC.Spread.Sheets.HorizontalAlign, vAlign?: GC.Spread.Sheets.VerticalAlign, font?: string, themeFont?: string, formatter?: string | GC.Spread.Formatter.GeneralFormatter, borderLeft?: GC.Spread.Sheets.LineBorder, borderTop?: GC.Spread.Sheets.LineBorder, borderRight?: GC.Spread.Sheets.LineBorder, borderBottom?: GC.Spread.Sheets.LineBorder, locked?: boolean, textIndent?: number, wordWrap?: boolean, showEllipsis?: boolean, shrinkToFit?: boolean, backgroundImage?: string, cellType?: GC.Spread.Sheets.CellTypes.Base, backgroundImageLayout?: GC.Spread.Sheets.ImageLayout, tabStop?: boolean, textDecoration?: GC.Spread.Sheets.TextDecorationType, imeMode?: GC.Spread.Sheets.ImeMode, name?: string, parentName?: string, watermark?: string, cellPadding?: string, labelOptions?: GC.Spread.Sheets.ILabelOptions, quotePrefix?: boolean, diagonalDown?: GC.Spread.Sheets.LineBorder, diagonalUp?: GC.Spread.Sheets.LineBorder, isVerticalText?: boolean, cellButtons?: GC.Spread.Sheets.ICellButton[], dropdown?: GC.Spread.Sheets.IDropdown[], textOrientation?: number, decoration?: GC.Spread.Sheets.TextDecorationType, mask?: GC.Spread.Sheets.IMaskType, fontStyle?: string, fontWeight?: string, fontSize?: string, fontFamily?: string, hidden?: boolean, textDirection?: GC.Spread.Sheets.TextDirectionType);
22815
+ constructor(backColor?: string | GC.Spread.Sheets.IPatternFill | GC.Spread.Sheets.IGradientFill | GC.Spread.Sheets.IGradientPathFill, foreColor?: string, hAlign?: GC.Spread.Sheets.HorizontalAlign, vAlign?: GC.Spread.Sheets.VerticalAlign, font?: string, themeFont?: string, formatter?: string | GC.Spread.Formatter.GeneralFormatter, borderLeft?: GC.Spread.Sheets.LineBorder, borderTop?: GC.Spread.Sheets.LineBorder, borderRight?: GC.Spread.Sheets.LineBorder, borderBottom?: GC.Spread.Sheets.LineBorder, locked?: boolean, textIndent?: number, wordWrap?: boolean, showEllipsis?: boolean, shrinkToFit?: boolean, backgroundImage?: string, cellType?: GC.Spread.Sheets.CellTypes.Base, backgroundImageLayout?: GC.Spread.Sheets.ImageLayout, tabStop?: boolean, textDecoration?: GC.Spread.Sheets.TextDecorationType, imeMode?: GC.Spread.Sheets.ImeMode, name?: string, parentName?: string, watermark?: string, cellPadding?: string, labelOptions?: GC.Spread.Sheets.ILabelOptions, quotePrefix?: boolean, diagonalDown?: GC.Spread.Sheets.LineBorder, diagonalUp?: GC.Spread.Sheets.LineBorder, isVerticalText?: boolean, cellButtons?: GC.Spread.Sheets.ICellButton[], dropdown?: GC.Spread.Sheets.IDropdown[], textOrientation?: number, decoration?: GC.Spread.Sheets.TextDecorationType, mask?: GC.Spread.Sheets.IMaskType, fontStyle?: string, fontWeight?: string, fontSize?: string, fontFamily?: string, hidden?: boolean, textDirection?: GC.Spread.Sheets.TextDirectionType, borderRadius?: string);
22459
22816
  /**
22460
22817
  * Indicates whether the cell can enter edit mode for editing.
22461
22818
  * @type {boolean}
@@ -22642,6 +22999,34 @@ declare namespace GC{
22642
22999
  * ```
22643
23000
  */
22644
23001
  borderLeft: GC.Spread.Sheets.LineBorder | undefined;
23002
+ /**
23003
+ * Indicates the border radius shorthand.
23004
+ * When four values are provided, they map to top-left, top-right, bottom-right, and bottom-left.
23005
+ * One value applies to all corners; two values apply to top-left/bottom-right and top-right/bottom-left; three values apply to top-left, top-right/bottom-left, and bottom-right.
23006
+ * @type {string}
23007
+ * @example
23008
+ * ```javascript
23009
+ * //This example applies 10 to all corners.
23010
+ * var style = new GC.Spread.Sheets.Style();
23011
+ * style.borderRadius = "10";
23012
+ * activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
23013
+ * ```
23014
+ * @example
23015
+ * ```javascript
23016
+ * //This example applies 10 to top-left/bottom-right and 20 to top-right/bottom-left.
23017
+ * var style = new GC.Spread.Sheets.Style();
23018
+ * style.borderRadius = "10 20";
23019
+ * activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
23020
+ * ```
23021
+ * @example
23022
+ * ```javascript
23023
+ * //This example applies 10, 20, 30, and 40 to top-left, top-right, bottom-right, and bottom-left.
23024
+ * var style = new GC.Spread.Sheets.Style();
23025
+ * style.borderRadius = "10 20 30 40";
23026
+ * activeSheet.setStyle(1,1,style,GC.Spread.Sheets.SheetArea.viewport);
23027
+ * ```
23028
+ */
23029
+ borderRadius: string | undefined;
22645
23030
  /**
22646
23031
  * Indicates the right border line.
22647
23032
  * @type {GC.Spread.Sheets.LineBorder}
@@ -23341,6 +23726,23 @@ declare namespace GC{
23341
23726
  * ```
23342
23727
  */
23343
23728
  font(value?: GC.Spread.Sheets.ThemeFont): any;
23729
+ /**
23730
+ * Gets or sets the heading font of the theme.
23731
+ * @param {string} value The heading font.
23732
+ * @returns {string|GC.Spread.Sheets.Theme} If no value is set, returns the heading font; otherwise, returns the theme.
23733
+ * @deprecated since version 18.1.0, please use 'headingFont' instead.
23734
+ * @example
23735
+ * ```javascript
23736
+ * ```
23737
+ * var custom = new GC.Spread.Sheets.Theme("Custom");
23738
+ * custom.headerFont('cursive');
23739
+ * sheet.currentTheme(custom);
23740
+ * sheet.getCell(0, 0).themeFont('Headings');
23741
+ * sheet.setValue(0, 0, 'hello world!'); // The font of the cell will be 'cursive'.
23742
+ * ```
23743
+ * ```
23744
+ */
23745
+ headerFont(value?: string): any;
23344
23746
  /**
23345
23747
  * Gets or sets the heading font of the theme depending on the culture.
23346
23748
  * @param {string} value The heading font.
@@ -23986,6 +24388,7 @@ declare namespace GC{
23986
24388
  * @param {GC.Spread.Sheets.ResizeMode} [options.rowResizeMode] - Specifies the way to resize row. The default value is GC.Spread.Sheets.ResizeMode.normal.
23987
24389
  * @param {Array} [options.customList] - The list for user to customize drag fill, prioritize matching this list in each fill. Each array item is type of string array. For example, [["Custom1", "C1"], ["Custom2", "C2", "C3"]]. When user drag fill "Custom1", the filled value is "C1"; when user drag fill "Custom2", the filled values are "C2", "C3".
23988
24390
  * @param {GC.Spread.Sheets.ScrollbarAppearance} [options.scrollbarAppearance] - The scrollbar appearance, contains skin and mobile two enums. The default value is GC.Spread.Sheets.ScrollbarAppearance.skin.
24391
+ * @param {GC.Spread.Sheets.NumbersFitMode} [options.numbersFitMode] - Specifies the display mode when date/number data width is longer than column width. The default value is GC.Spread.Sheets.NumbersFitMode.mask.
23989
24392
  * @param {boolean} [options.pasteSkipInvisibleRange] - Whether paste skip invisible range. The default value is false.
23990
24393
  * @param {boolean} [options.allowAutoExtendFilterRange] - Whether allow auto extend filter range like excel. The default value is false.
23991
24394
  * @param {boolean} [options.allowInvalidFormula] - Whether allow input invalid formula string. The default value is false.
@@ -23993,6 +24396,7 @@ declare namespace GC{
23993
24396
  * @param {GC.Spread.Pivot.PivotAreaReference} [options.pivotAreaReference ] - Whether automatically generate the getPivotData formula or cell reference when choose pivot table data area. The default value is GC.Spread.Pivot.PivotAreaReference.getPivotData.
23994
24397
  * @param {GC.Spread.Sheets.SheetTabStyles} [options.defaultSheetTabStyles] - All default state styles for sheet tabs.
23995
24398
  * @param {GC.Spread.Sheets.IBuiltInFileIcons} [options.builtInFileIcons] - All built-in file icons.
24399
+ * @param {GC.Spread.Sheets.IFocusCellOptions} [options.focusCell] - The focus cell settings for highlighting the active cell's row and column bands.
23996
24400
  * @example
23997
24401
  * ```javascript
23998
24402
  * var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount:3, font:"12pt Arial"});
@@ -24128,6 +24532,7 @@ declare namespace GC{
24128
24532
  * @property {GC.Spread.Sheets.ResizeMode} rowResizeMode - Specifies the way to resize row. The default value is GC.Spread.Sheets.ResizeMode.normal.
24129
24533
  * @property {Array} customList - The list for user to customize drag fill, prioritize matching this list in each fill. Each array item is type of string array.
24130
24534
  * @property {GC.Spread.Sheets.ScrollbarAppearance} scrollbarAppearance - The scrollbar appearance, contains skin and mobile two enums. The default value is GC.Spread.Sheets.ScrollbarAppearance.skin.
24535
+ * @property {GC.Spread.Sheets.NumbersFitMode} numbersFitMode - Specifies the display mode when date/number data width is longer than column width. The default value is GC.Spread.Sheets.NumbersFitMode.mask.
24131
24536
  * @property {boolean} pasteSkipInvisibleRange - Whether paste skip invisible range. The default value is false.
24132
24537
  * @property {boolean} allowAutoExtendFilterRange - Whether allow auto extend filter range like excel. The default value is false.
24133
24538
  * @property {boolean} allowInvalidFormula - Whether allow input invalid formula string. The default value is false.
@@ -24135,6 +24540,7 @@ declare namespace GC{
24135
24540
  * @property {GC.Spread.Pivot.PivotAreaReference} pivotAreaReference - Whether automatically generate the getPivotData formula or cell reference when choose pivot table data area. The default value is GC.Spread.Pivot.PivotAreaReference.getPivotData.
24136
24541
  * @property {GC.Spread.Sheets.SheetTabStyles} defaultSheetTabStyles - All default state styles for sheet tabs.
24137
24542
  * @property {GC.Spread.Sheets.IBuiltInFileIcons} [options.builtInFileIcons] - All built-in file icons.
24543
+ * @property {GC.Spread.Sheets.IFocusCellOptions} focusCell - The focus cell settings for highlighting the active cell's row and column bands.
24138
24544
  * @example
24139
24545
  * ```javascript
24140
24546
  * // var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:5,showHorizontalScrollbar:false});
@@ -24144,6 +24550,16 @@ declare namespace GC{
24144
24550
  * ```
24145
24551
  */
24146
24552
  options: IWorkbookOptions;
24553
+ /**
24554
+ * Gets the scenario manager of the workbook.
24555
+ * @type {GC.Spread.Sheets.Scenarios.ScenarioManager}
24556
+ * @example
24557
+ * ```javascript
24558
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
24559
+ * var scenarioManager = spread.scenarioManager;
24560
+ * ```
24561
+ */
24562
+ scenarioManager: GC.Spread.Sheets.Scenarios.ScenarioManager;
24147
24563
  /**
24148
24564
  * Represents the sheet collection.
24149
24565
  * @type {GC.Spread.Sheets.Worksheet[]}
@@ -24358,7 +24774,7 @@ declare namespace GC{
24358
24774
  dataManager(): GC.Data.DataManager;
24359
24775
  /**
24360
24776
  * set or get the default pivot table theme.
24361
- * @param {string} name the default name of the pivot table theme
24777
+ * @param {string} themeName The name of the pivot table theme to use as the default.
24362
24778
  * @returns {GC.Spread.Pivot.PivotTableTheme | undefined}
24363
24779
  * @example
24364
24780
  * ```javascript
@@ -24374,7 +24790,7 @@ declare namespace GC{
24374
24790
  defaultPivotTableTheme(themeName?: string): GC.Spread.Pivot.PivotTableTheme | undefined;
24375
24791
  /**
24376
24792
  * set or get the default slicer theme.
24377
- * @param {string} name the default name of the slicer theme
24793
+ * @param {string} themeName The name of the slicer theme to use as the default.
24378
24794
  * @returns {GC.Spread.Sheets.Slicers.SlicerStyle | undefined}
24379
24795
  * @example
24380
24796
  * ```javascript
@@ -24390,7 +24806,7 @@ declare namespace GC{
24390
24806
  defaultSlicerTheme(themeName?: string): GC.Spread.Sheets.Slicers.SlicerStyle | undefined;
24391
24807
  /**
24392
24808
  * set or get the default table theme.
24393
- * @param {string} name the default name of the table theme
24809
+ * @param {string} themeName The name of the table theme to use as the default.
24394
24810
  * @returns {GC.Spread.Sheets.Tables.TableTheme | undefined}
24395
24811
  * @example
24396
24812
  * ```javascript
@@ -24406,7 +24822,7 @@ declare namespace GC{
24406
24822
  defaultTableTheme(themeName?: string): GC.Spread.Sheets.Tables.TableTheme | undefined;
24407
24823
  /**
24408
24824
  * set or get the default timeLine theme.
24409
- * @param {string} name the default name of the timeLine theme
24825
+ * @param {string} themeName The name of the timeline theme to use as the default.
24410
24826
  * @returns {GC.Spread.Sheets.Slicers.TimelineStyle | undefined}
24411
24827
  * @example
24412
24828
  * ```javascript
@@ -24713,8 +25129,8 @@ declare namespace GC{
24713
25129
  /**
24714
25130
  * Imports the object state from the excel or ssJson or csv file or javascript file.
24715
25131
  * @param {File} file - The ssJson or csv or Excel file or javascript file for import.
24716
- * @param {function} [successCallBack] - The success callback when import file complete, accept json as argument.
24717
- * @param {function} [errorCallBack] - The error callback when import file got error.
25132
+ * @param {function} successCallback - The success callback when import file complete, accept json as argument.
25133
+ * @param {function} errorCallback - The error callback when import file got error.
24718
25134
  * @param {GC.Spread.Sheets.ImportOptions} importOptions - The import options.
24719
25135
  * @example
24720
25136
  * ```javascript
@@ -24807,8 +25223,8 @@ declare namespace GC{
24807
25223
  /**
24808
25224
  * Loads the object state from the sjs zipped file.
24809
25225
  * @param {Blob} file - The zipped spreadsheet data file.
24810
- * @param {function} successCallBack - The success callback when import file complete, accept json as argument.
24811
- * @param {function} errorCallBack - The error callback when import file got error.
25226
+ * @param {function} successCallback - The success callback when import file complete, accept json as argument.
25227
+ * @param {function} errorCallback - The error callback when import file got error.
24812
25228
  * @param {GC.Spread.Sheets.OpenOptions} openOptions - The deserialization options.
24813
25229
  * @example
24814
25230
  * ```javascript
@@ -25362,6 +25778,7 @@ declare namespace GC{
25362
25778
  * @property {boolean} [protectionOptions.allowSort] - True if the user can sort ranges.
25363
25779
  * @property {boolean} [protectionOptions.allowFilter] - True if the user can filter ranges.
25364
25780
  * @property {boolean} [protectionOptions.allowEditObjects] - True if the user can edit floating objects.
25781
+ * @property {boolean} [protectionOptions.allowEditScenarios] - True if the user can edit locked scenario overrides on a protected worksheet.
25365
25782
  * @property {boolean} [protectionOptions.allowResizeRows] - True if the user can resize rows.
25366
25783
  * @property {boolean} [protectionOptions.allowResizeColumns] - True if the user can resize columns.
25367
25784
  * @property {boolean} [protectionOptions.allowDragInsertRows] - True if the user can drag to insert rows.
@@ -25608,7 +26025,7 @@ declare namespace GC{
25608
26025
  /**
25609
26026
  * Adds a span of cells to this sheet in the specified sheet area.
25610
26027
  * @param {number} row The row index of the cell at which to start the span.
25611
- * @param {number} column The column index of the cell at which to start the span.
26028
+ * @param {number} col The column index of the cell at which to start the span.
25612
26029
  * @param {number} rowCount The number of rows to span.
25613
26030
  * @param {number} colCount The number of columns to span.
25614
26031
  * @param {GC.Spread.Sheets.SheetArea} sheetArea The sheet area. If this parameter is not given, it defaults to `viewport`.
@@ -25658,7 +26075,7 @@ declare namespace GC{
25658
26075
  applyNamedCellTemplate(name: string, address: string): void;
25659
26076
  /**
25660
26077
  * Automatically fits the viewport column.
25661
- * @property {number} column The column index.
26078
+ * @param {number} column The zero-based index of the column to automatically fit.
25662
26079
  * @example
25663
26080
  * ```javascript
25664
26081
  * //This example sets the column width based on the text.
@@ -25669,7 +26086,7 @@ declare namespace GC{
25669
26086
  autoFitColumn(column: number): void;
25670
26087
  /**
25671
26088
  * Automatically fits the viewport row.
25672
- * @property {number} row The row index.
26089
+ * @param {number} row The zero-based index of the row to automatically fit.
25673
26090
  * @example
25674
26091
  * ```javascript
25675
26092
  * //This example sets the row height based on the text.
@@ -25696,16 +26113,19 @@ declare namespace GC{
25696
26113
  autoMerge(range: GC.Spread.Sheets.Range, direction?: GC.Spread.Sheets.AutoMerge.AutoMergeDirection, mode?: GC.Spread.Sheets.AutoMerge.AutoMergeMode, sheetArea?: GC.Spread.Sheets.SheetArea, selectionMode?: GC.Spread.Sheets.AutoMerge.SelectionMode): GC.Spread.Sheets.AutoMerge.IRangeInfo[];
25697
26114
  /**
25698
26115
  * Get or set the background image of the worksheet, if there is no parameters, indicates return the background image of the worksheet.
25699
- * @param {src} src the url of the background image.
26116
+ * @param {string} src the url of the background image.
26117
+ * @param {GC.Spread.Sheets.IBackgroundImageOption} option The background image option.
26118
+ * @param {'repeat' | 'none'} [option.layout] The layout for the background image.
26119
+ * @param {'normal' | 'over-content'} [option.paintOrder] The paint order for the background image.
25700
26120
  * @returns {string | null} Returns url of the background image of the worksheet.
25701
26121
  * @example
25702
26122
  * ```javascript
25703
- * activeSheet.backgroundImage('./image/background.jpg');
26123
+ * activeSheet.backgroundImage('./image/background.jpg', { paintOrder: 'over-content' });
25704
26124
  * let imageUrl = activeSheet.backgroundImage();
25705
26125
  * alert(imageUrl);
25706
26126
  * ```
25707
26127
  */
25708
- backgroundImage(src?: string): string | null;
26128
+ backgroundImage(src?: string, option?: GC.Spread.Sheets.IBackgroundImageOption): string | null;
25709
26129
  /**
25710
26130
  * Binds an event to the sheet.
25711
26131
  * @param {string} type The event type.
@@ -25802,7 +26222,7 @@ declare namespace GC{
25802
26222
  * activeSheet.clear(0,0,3,3,GC.Spread.Sheets.SheetArea.viewport,GC.Spread.Sheets.StorageType.data);
25803
26223
  * ```
25804
26224
  */
25805
- clear(row: number, column: number, rowCount: number, colCount: number, area: GC.Spread.Sheets.SheetArea, storageType: GC.Spread.Sheets.StorageType): void;
26225
+ clear(row: number, column: number, rowCount: number, columnCount: number, area: GC.Spread.Sheets.SheetArea, storageType: GC.Spread.Sheets.StorageType): void;
25806
26226
  /**
25807
26227
  * Clears all custom functions.
25808
26228
  * @example
@@ -25875,7 +26295,7 @@ declare namespace GC{
25875
26295
  copyTo(fromRow: number, fromColumn: number, toRow: number, toColumn: number, rowCount: number, columnCount: number, option: GC.Spread.Sheets.CopyToOptions): void;
25876
26296
  /**
25877
26297
  * Gets or sets the current theme for the sheet.
25878
- * @param {string|GC.Spread.Common.Theme} value The theme name or the theme.
26298
+ * @param {string|GC.Spread.Sheets.Theme} value The theme name or the theme.
25879
26299
  * @returns {GC.Spread.Sheets.Theme|GC.Spread.Sheets.Worksheet} If no value is set, returns the current theme; otherwise, returns the worksheet.
25880
26300
  * @example
25881
26301
  * ```javascript
@@ -26119,7 +26539,7 @@ declare namespace GC{
26119
26539
  * @param {number} row The row index.
26120
26540
  * @param {number} column The column index.
26121
26541
  * @param {number} rowCount The row count.
26122
- * @param {number} colCount The column count.
26542
+ * @param {number} columnCount The column count.
26123
26543
  * @param {boolean} getFormula If `true`, return formulas; otherwise, return values.
26124
26544
  * @returns {Object[][]} The object array from the specified range of cells.
26125
26545
  * @example
@@ -26288,24 +26708,24 @@ declare namespace GC{
26288
26708
  getColumnWidth(col: number, sheetArea?: GC.Spread.Sheets.SheetArea, getDynamicSize?: boolean): any;
26289
26709
  /**
26290
26710
  * Gets delimited text from a range.
26291
- * @property {number} row The start row.
26292
- * @property {number} column The start column.
26293
- * @property {number} rowCount The row count.
26294
- * @property {number} columnCount The column count.
26295
- * @property {string} rowDelimiter The row delimiter that is appended to the end of the row.
26296
- * @property {string} columnDelimiter The column delimiter that is appended to the end of the column.
26711
+ * @param {number} row The zero-based starting row index of the range to export.
26712
+ * @param {number} column The zero-based starting column index of the range to export.
26713
+ * @param {number} rowCount The number of rows to export.
26714
+ * @param {number} columnCount The number of columns to export.
26715
+ * @param {string} rowDelimiter The delimiter to insert between rows.
26716
+ * @param {string} columnDelimiter The delimiter to insert between columns.
26297
26717
  * @returns {string} The text from the range with the specified delimiters.
26298
26718
  */
26299
26719
  getCsv(row: number, column: number, rowCount: number, columnCount: number, rowDelimiter: string, columnDelimiter: string): string;
26300
26720
  /**
26301
26721
  * Gets a custom function.
26302
- * @param {string} fnName The custom function name.
26722
+ * @param {string} name The custom function name.
26303
26723
  * @returns {GC.Spread.CalcEngine.Functions.Function} The custom function.
26304
26724
  */
26305
26725
  getCustomFunction(name: string): void;
26306
26726
  /**
26307
26727
  * Gets the specified custom name information.
26308
- * @param {string} fnName The custom name.
26728
+ * @param {string} name The custom name.
26309
26729
  * @returns {GC.Spread.Sheets.NameInfo} The information for the specified custom name.
26310
26730
  * @example
26311
26731
  * ```javascript
@@ -26736,7 +27156,7 @@ declare namespace GC{
26736
27156
  * //sheet.removeSparkline(0, 5);
26737
27157
  * ```
26738
27158
  */
26739
- getSparkline(row: number, column: number): GC.Spread.Sheets.Sparklines.Sparkline;
27159
+ getSparkline(row: number, col: number): GC.Spread.Sheets.Sparklines.Sparkline;
26740
27160
  /**
26741
27161
  * Gets the style information for a cell, row, column, or the sheet default based on the provided indices.
26742
27162
  * Special Index Behavior:
@@ -27113,8 +27533,8 @@ declare namespace GC{
27113
27533
  */
27114
27534
  printInfo(value?: GC.Spread.Sheets.Print.PrintInfo): any;
27115
27535
  /**
27116
- * Protects a worksheet. Do nothing if the worksheet has already been protected.
27117
- * @property {string} password Sheet protection password.
27536
+ * Protects a worksheet. Does nothing if the worksheet is already protected.
27537
+ * @param {string} password The worksheet protection password. If omitted, the worksheet is protected without a password.
27118
27538
  * @example
27119
27539
  * ```javascript
27120
27540
  * let password = "fe4c4be8"
@@ -27139,7 +27559,7 @@ declare namespace GC{
27139
27559
  recalcAll(refreshAll?: boolean): void;
27140
27560
  /**
27141
27561
  * Removes a custom function.
27142
- * @param {string} fnName The custom function name.
27562
+ * @param {string} name The custom function name.
27143
27563
  * @example
27144
27564
  * ```javascript
27145
27565
  * //This example uses the removeCustomFunction method.
@@ -27158,7 +27578,7 @@ declare namespace GC{
27158
27578
  removeCustomFunction(name: string): void;
27159
27579
  /**
27160
27580
  * Removes the specified custom name.
27161
- * @param {string} fnName The custom name.
27581
+ * @param {string} name The custom name.
27162
27582
  * @example
27163
27583
  * ```javascript
27164
27584
  * //This example uses the removeCustomName method.
@@ -27569,26 +27989,36 @@ declare namespace GC{
27569
27989
  setColumnWidth(col: number, value: number | string, sheetArea?: GC.Spread.Sheets.SheetArea): void;
27570
27990
  /**
27571
27991
  * Sets delimited text (CSV) in the sheet.
27572
- * @property {number} row The start row.
27573
- * @property {number} column The start column.
27574
- * @property {string} text The delimited text.
27575
- * @property {string} rowDelimiter The row delimiter.
27576
- * @property {string} columnDelimiter The column delimiter.
27992
+ * @param {number} row The zero-based row index at which to start importing.
27993
+ * @param {number} column The zero-based column index at which to start importing.
27994
+ * @param {string} text The delimited text to import.
27995
+ * @param {string} rowDelimiter The delimiter used to separate rows in the text.
27996
+ * @param {string} columnDelimiter The delimiter used to separate columns in the text.
27577
27997
  */
27578
27998
  setCsv(row: number, column: number, text: string, rowDelimiter: string, columnDelimiter: string): void;
27579
27999
  /**
27580
28000
  * Sets the data source that populates the sheet.
27581
- * @param {Object} data The data source.
28001
+ * @param {Object | GC.Data.Table | string} data The data source. A string represents the Data Manager table name.
27582
28002
  * @param {boolean} reset `true` if the sheet is reset; otherwise, `false`.
27583
28003
  * @example
27584
28004
  * ```javascript
28005
+ * // This example sets a normal data source for the sheet.
27585
28006
  * var test = [
27586
- * { "Series0": 2, "Series1": 1 },
27587
- * { "Series0": 4, "Series1": 2 },
27588
- * { "Series0": 3, "Series1": 4 }
27589
- * ];
28007
+ * { "Series0": 2, "Series1": 1 },
28008
+ * { "Series0": 4, "Series1": 2 },
28009
+ * { "Series0": 3, "Series1": 4 }
28010
+ * ];
27590
28011
  * activeSheet.autoGenerateColumns = true;
27591
28012
  * activeSheet.setDataSource(test, true);
28013
+ *
28014
+ * // Set the data source with GC.Data.Table.
28015
+ * var personsTable = dataManager.addTable("persons", {
28016
+ * data: [
28017
+ * { name: "Wang feng", age: 25, address: { postcode: "710075" } },
28018
+ * { name: "Li lei", age: 26, address: { postcode: "710076" } }
28019
+ * ]
28020
+ * });
28021
+ * activeSheet.setDataSource(personsTable);
27592
28022
  * ```
27593
28023
  */
27594
28024
  setDataSource(data: any, reset?: boolean): void;
@@ -28194,8 +28624,8 @@ declare namespace GC{
28194
28624
  ungroupSparkline(group: GC.Spread.Sheets.Sparklines.SparklineGroup): void;
28195
28625
  /**
28196
28626
  * Unprotects a worksheet.
28197
- * @property {string} password Sheet protection password.
28198
- * @returns {boolean} Return true if password is correct or isProtect is false, otherwise return false.
28627
+ * @param {string} password The worksheet protection password. Omit it if the worksheet was protected without a password.
28628
+ * @returns {boolean} `true` if the worksheet is already unprotected or the password is correct; otherwise, `false`.
28199
28629
  * @example
28200
28630
  * ```javascript
28201
28631
  * let password = "fe4c4be8"
@@ -28462,22 +28892,55 @@ declare namespace GC{
28462
28892
  export class CellBindingSource{
28463
28893
  /**
28464
28894
  * Represents a source for cell binding.
28465
- * @param {Object} source The data source.
28895
+ * @param {Object | GC.Data.Table | string} source The data source, a Data Manager table, or a Data Manager table name.
28896
+ * @param {number} activeRecordIndex The active record index for the current cell binding source. The default value is 0.
28466
28897
  * @class
28467
28898
  * @example
28468
28899
  * ```javascript
28469
- * var person = {name: "Wang feng", age: 25, address: {postcode: "710075"}};
28900
+ * // Bind a normal data source.
28901
+ * var person = { name: "Wang feng", age: 25, address: { postcode: "710075" } };
28470
28902
  * var source = new GC.Spread.Sheets.Bindings.CellBindingSource(person);
28471
28903
  * activeSheet.setBindingPath(0, 0, "name");
28472
28904
  * activeSheet.setBindingPath(1, 1, "age");
28473
28905
  * activeSheet.setBindingPath(3, 3, "address.postcode");
28474
28906
  * activeSheet.setDataSource(source);
28907
+ *
28908
+ * // Bind a Data Manager table.
28909
+ * var personsTable = dataManager.addTable("persons", {
28910
+ * data: [person]
28911
+ * });
28912
+ * var source = new GC.Spread.Sheets.Bindings.CellBindingSource(personsTable);
28913
+ * activeSheet.setBindingPath(0, 0, "name");
28914
+ * activeSheet.setBindingPath(1, 1, "age");
28915
+ * activeSheet.setBindingPath(3, 3, "address.postcode");
28916
+ * activeSheet.setDataSource(source);
28475
28917
  * ```
28476
28918
  */
28477
- constructor(source: Object);
28919
+ constructor(source: Object | GC.Data.Table | string, activeRecordIndex?: number);
28478
28920
  /**
28479
- * Gets the wrapped data source for cell binding.
28480
- * @returns {Object} The original data source.
28921
+ * Gets or sets the active record index for the current cell binding source.
28922
+ * @param {number} index The active record index.
28923
+ * @returns {number} The active record index.
28924
+ * @example
28925
+ * ```javascript
28926
+ * // This example sets the active record index.
28927
+ * var personsTable = dataManager.addTable("persons", {
28928
+ * data: [
28929
+ * { name: "Wang feng", age: 25, address: { postcode: "710075" } },
28930
+ * { name: "Li lei", age: 26, address: { postcode: "710076" } }
28931
+ * ]
28932
+ * });
28933
+ * var source = new GC.Spread.Sheets.Bindings.CellBindingSource(personsTable, 1);
28934
+ * activeSheet.setDataSource(source);
28935
+ * activeSheet.setBindingPath(0, 0, "name");
28936
+ * alert(source.activeRecordIndex());
28937
+ * source.activeRecordIndex(0);
28938
+ * ```
28939
+ */
28940
+ activeRecordIndex(index?: number): number;
28941
+ /**
28942
+ * Gets the source information for cell binding.
28943
+ * @returns {Object} If the source is a Data Manager source, returns an object that contains the table name and active record index; otherwise, returns the wrapped source.
28481
28944
  * @example
28482
28945
  * ```javascript
28483
28946
  * //This example gets the name.
@@ -28488,6 +28951,15 @@ declare namespace GC{
28488
28951
  * activeSheet.setBindingPath(3, 3, "address.postcode");
28489
28952
  * activeSheet.setDataSource(source);
28490
28953
  * alert(source.getSource().name);
28954
+ *
28955
+ * //This example gets the source information for a Data Manager table.
28956
+ * var personsTable = dataManager.addTable("persons", {
28957
+ * data: [person]
28958
+ * });
28959
+ * var dataManagerSource = new GC.Spread.Sheets.Bindings.CellBindingSource(personsTable, 1);
28960
+ * var sourceInfo = dataManagerSource.getSource();
28961
+ * alert(sourceInfo.tableName);
28962
+ * alert(sourceInfo.activeRecordIndex);
28491
28963
  * ```
28492
28964
  */
28493
28965
  getSource(): Object;
@@ -28557,7 +29029,7 @@ declare namespace GC{
28557
29029
  /**
28558
29030
  * Evaluates the specified formula and return a promise of the formula result.
28559
29031
  * @param {object} context The evaluation context; in general, you should use the active sheet object.
28560
- * @param {formula} string The formula string.
29032
+ * @param {string} formula The formula string.
28561
29033
  * @param {number} baseRow The base row index of the formula.
28562
29034
  * @param {number} baseColumn The base column index of the formula.
28563
29035
  * @example
@@ -30403,8 +30875,8 @@ declare namespace GC{
30403
30875
  accept(value?: string): string;
30404
30876
  /**
30405
30877
  * Gets or sets whether to display the file clear button.
30406
- * @param {string} value Whether to display the file clear button.
30407
- * @returns {string} Returns the currently displayed file clear button.
30878
+ * @param {boolean} value Whether to display the file clear button.
30879
+ * @returns {boolean} Returns the currently displayed file clear button.
30408
30880
  * @example
30409
30881
  * ```javascript
30410
30882
  * // This example creates a file upload cell.
@@ -30416,8 +30888,8 @@ declare namespace GC{
30416
30888
  isClearEnabled(value?: boolean): boolean;
30417
30889
  /**
30418
30890
  * Gets or sets whether to display the file download button.
30419
- * @param {string} value Whether to display the file download button.
30420
- * @returns {string} Returns the currently displayed file download button.
30891
+ * @param {boolean} value Whether to display the file download button.
30892
+ * @returns {boolean} Returns the currently displayed file download button.
30421
30893
  * @example
30422
30894
  * ```javascript
30423
30895
  * // This example creates a file upload cell.
@@ -30429,8 +30901,8 @@ declare namespace GC{
30429
30901
  isDownloadEnabled(value?: boolean): boolean;
30430
30902
  /**
30431
30903
  * Gets or sets whether to display the file preview button.
30432
- * @param {string} value Whether to display the file preview button.
30433
- * @returns {string} Returns the currently displayed file preview button.
30904
+ * @param {boolean} value Whether to display the file preview button.
30905
+ * @returns {boolean} Returns the currently displayed file preview button.
30434
30906
  * @example
30435
30907
  * ```javascript
30436
30908
  * // This example creates a file upload cell.
@@ -31063,26 +31535,69 @@ declare namespace GC{
31063
31535
 
31064
31536
 
31065
31537
  export interface IAxisStyle{
31538
+ /**
31539
+ * The axis text color.
31540
+ */
31066
31541
  color?: string;
31542
+ /**
31543
+ * The axis text transparency.
31544
+ */
31067
31545
  transparency?: number;
31546
+ /**
31547
+ * The axis text font family.
31548
+ */
31068
31549
  fontFamily?: string;
31550
+ /**
31551
+ * The axis text font size.
31552
+ */
31069
31553
  fontSize?: number;
31070
31554
  }
31071
31555
 
31072
31556
 
31073
31557
  export interface IAxisTitle{
31558
+ /**
31559
+ * The axis title text.
31560
+ */
31074
31561
  text?: string;
31562
+ /**
31563
+ * The axis title text color.
31564
+ */
31075
31565
  color?: string;
31566
+ /**
31567
+ * The axis title text transparency.
31568
+ */
31076
31569
  transparency?: number;
31570
+ /**
31571
+ * The axis title text font family.
31572
+ */
31077
31573
  fontFamily?: string;
31574
+ /**
31575
+ * The axis title text font size.
31576
+ */
31078
31577
  fontSize?: number;
31578
+ /**
31579
+ * The axis title text direction.
31580
+ */
31581
+ textDirection?: GC.Spread.Sheets.Charts.TextDirection;
31079
31582
  }
31080
31583
 
31081
31584
 
31082
31585
  export interface IBorder{
31586
+ /**
31587
+ * The border color.
31588
+ */
31083
31589
  color?: string;
31590
+ /**
31591
+ * The border width.
31592
+ */
31084
31593
  width?: number;
31594
+ /**
31595
+ * The border transparency.
31596
+ */
31085
31597
  transparency?: number;
31598
+ /**
31599
+ * The border dash style.
31600
+ */
31086
31601
  dashStyle?: GC.Spread.Sheets.Charts.LineType;
31087
31602
  }
31088
31603
 
@@ -31156,6 +31671,9 @@ declare namespace GC{
31156
31671
  * whether the legend display without overlapping chart area.
31157
31672
  */
31158
31673
  showLegendWithoutOverlapping?: boolean;
31674
+ /**
31675
+ * The layout of the chart legend.
31676
+ */
31159
31677
  layout?: GC.Spread.Sheets.Charts.IChartLegendLayout
31160
31678
  }
31161
31679
 
@@ -31181,9 +31699,21 @@ declare namespace GC{
31181
31699
 
31182
31700
 
31183
31701
  export interface IChartTextStyle{
31702
+ /**
31703
+ * The chart text color.
31704
+ */
31184
31705
  color?: string;
31706
+ /**
31707
+ * The chart text font family.
31708
+ */
31185
31709
  fontFamily?: string;
31710
+ /**
31711
+ * The chart text font size.
31712
+ */
31186
31713
  fontSize?: number | string;
31714
+ /**
31715
+ * The chart text transparency.
31716
+ */
31187
31717
  transparency?: number;
31188
31718
  }
31189
31719
 
@@ -31289,9 +31819,36 @@ declare namespace GC{
31289
31819
  * The border color transparency of the series data labels.
31290
31820
  */
31291
31821
  borderColorTransparency?: number;
31822
+ /**
31823
+ * The font family of the data labels.
31824
+ */
31825
+ fontFamily?: string;
31826
+ /**
31827
+ * The font size of the data labels.
31828
+ */
31829
+ fontSize?: number;
31830
+ /**
31831
+ * Whether the data labels font is bold.
31832
+ */
31833
+ fontBold?: boolean;
31834
+ /**
31835
+ * Whether the data labels font is italic.
31836
+ */
31837
+ fontItalic?: boolean;
31838
+ /**
31839
+ * The underline type of the data labels font.
31840
+ */
31841
+ fontUnderline?: GC.Spread.Sheets.Charts.TextUnderlineType;
31842
+ /**
31843
+ * Whether the data labels font has strikethrough.
31844
+ */
31845
+ fontStrikethrough?: boolean;
31292
31846
  }
31293
31847
 
31294
31848
 
31849
+ /**
31850
+ * @update 17.1.0 Rename from IDataPointStyle to IDataPoint.
31851
+ */
31295
31852
  export interface IDataPoint{
31296
31853
  /**
31297
31854
  * The background color of the data point or symbol point.
@@ -31321,6 +31878,9 @@ declare namespace GC{
31321
31878
 
31322
31879
 
31323
31880
  export interface IDataPoints{
31881
+ /**
31882
+ * The data point style indexed by index.
31883
+ */
31324
31884
  [key: number]: GC.Spread.Sheets.Charts.IDataPoint;
31325
31885
  }
31326
31886
 
@@ -31366,9 +31926,21 @@ declare namespace GC{
31366
31926
 
31367
31927
 
31368
31928
  export interface IGridLine{
31929
+ /**
31930
+ * The grid line color.
31931
+ */
31369
31932
  color?: string;
31933
+ /**
31934
+ * The grid line transparency.
31935
+ */
31370
31936
  transparency?: number;
31937
+ /**
31938
+ * Whether the grid line is visible.
31939
+ */
31371
31940
  visible?: boolean;
31941
+ /**
31942
+ * The grid line width.
31943
+ */
31372
31944
  width?: number;
31373
31945
  }
31374
31946
 
@@ -31394,37 +31966,113 @@ declare namespace GC{
31394
31966
 
31395
31967
 
31396
31968
  export interface IHoverSymbolStyle{
31969
+ /**
31970
+ * The color of the data point symbol when hovered.
31971
+ */
31397
31972
  color?:string;
31973
+ /**
31974
+ * The transparency of the data point symbol when hovered.
31975
+ */
31398
31976
  transparency?:number;
31977
+ /**
31978
+ * The border of the data point symbol when hovered.
31979
+ */
31399
31980
  borderStyle?: GC.Spread.Sheets.Charts.IBorder;
31400
31981
  }
31401
31982
 
31402
31983
 
31403
31984
  export interface ILegacyChartPaintCallBack{
31985
+ /**
31986
+ * The callback invoked to paint an unsupported chart.
31987
+ */
31404
31988
  (chart: GC.Spread.Sheets.Charts.Chart, chartHost: HTMLElement) : void;
31405
31989
  }
31406
31990
 
31407
31991
 
31408
31992
  export interface ILineStyle{
31993
+ /**
31994
+ * The line color.
31995
+ */
31409
31996
  color?: string;
31997
+ /**
31998
+ * The line width.
31999
+ */
31410
32000
  width?: number;
32001
+ /**
32002
+ * The line transparency.
32003
+ */
31411
32004
  transparency?: number;
32005
+ /**
32006
+ * The line dash style.
32007
+ */
31412
32008
  dashStyle?: GC.Spread.Sheets.Charts.LineType;
31413
32009
  }
31414
32010
 
31415
32011
 
31416
32012
  export interface IPaintCallBack{
32013
+ /**
32014
+ * The callback invoked to paint an unsupported chart.
32015
+ */
31417
32016
  (chart: GC.Spread.Sheets.Charts.Chart, ctx: CanvasRenderingContext2D, width: number, height: number) : void;
31418
32017
  }
31419
32018
 
31420
32019
 
31421
32020
  export interface IPatternFillBackColor{
32021
+ /**
32022
+ * The pattern fill type.
32023
+ */
31422
32024
  type: GC.Spread.Sheets.Charts.PatternType;
32025
+ /**
32026
+ * The foreground color of the pattern fill.
32027
+ */
31423
32028
  foregroundColor?: string;
32029
+ /**
32030
+ * The background color of the pattern fill.
32031
+ */
31424
32032
  backgroundColor?: string;
31425
32033
  }
31426
32034
 
31427
32035
 
32036
+ export interface IPlotArea{
32037
+ /**
32038
+ * The background color of the plot area.
32039
+ */
32040
+ backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
32041
+ /**
32042
+ * The transparency of the plot area backColor.
32043
+ */
32044
+ backColorTransparency?: number;
32045
+ /**
32046
+ * The border of the plot area.
32047
+ */
32048
+ border?: GC.Spread.Sheets.Charts.IBorder;
32049
+ /**
32050
+ * The layout of the plot area.
32051
+ */
32052
+ layout?: GC.Spread.Sheets.Charts.IPlotAreaLayout;
32053
+ }
32054
+
32055
+
32056
+ export interface IPlotAreaLayout{
32057
+ /**
32058
+ * The x position of the plot area, it's percentage, and the base line is chart's left edge.
32059
+ */
32060
+ x?:number;
32061
+ /**
32062
+ * The y position of the plot area, it's percentage, and the base line is chart's top edge.
32063
+ */
32064
+ y?:number;
32065
+ /**
32066
+ * The width of the plot area, it's percentage, and it's based on the chart's width.
32067
+ */
32068
+ width?: number;
32069
+ /**
32070
+ * The height of the plot area, it's percentage, and it's based on the chart's height.
32071
+ */
32072
+ height?: number;
32073
+ }
32074
+
32075
+
31428
32076
  export interface IScaling{
31429
32077
  /**
31430
32078
  * Indicates the specified axis order. It can also accept the enum value `GC.Spread.Sheets.Charts.AxisOrientation`.
@@ -31437,6 +32085,9 @@ declare namespace GC{
31437
32085
  }
31438
32086
 
31439
32087
 
32088
+ /**
32089
+ * @update 17.1.0 Rename from ISeriesItemBase to ISeries.
32090
+ */
31440
32091
  export interface ISeries{
31441
32092
  /**
31442
32093
  * The chart type of the series.
@@ -31496,6 +32147,7 @@ declare namespace GC{
31496
32147
  bubbleSizes?: string;
31497
32148
  /**
31498
32149
  * The data labels of the series.
32150
+ * @update 16.1.0 Rename from datalabels to dataLabels.
31499
32151
  */
31500
32152
  dataLabels?: GC.Spread.Sheets.Charts.IDataLabels;
31501
32153
  /**
@@ -31542,10 +32194,25 @@ declare namespace GC{
31542
32194
 
31543
32195
 
31544
32196
  export interface ISeriesItemBorder{
32197
+ /**
32198
+ * The series item border color.
32199
+ */
31545
32200
  color?: string;
32201
+ /**
32202
+ * The transparency of the series item border color.
32203
+ */
31546
32204
  colorTransparency?: number;
32205
+ /**
32206
+ * The transparency of the series item border.
32207
+ */
31547
32208
  transparency?: number;
32209
+ /**
32210
+ * The series item border width.
32211
+ */
31548
32212
  width?: number;
32213
+ /**
32214
+ * The series item border line type.
32215
+ */
31549
32216
  lineType?: GC.Spread.Sheets.Charts.LineType;
31550
32217
  }
31551
32218
 
@@ -32399,6 +33066,48 @@ declare namespace GC{
32399
33066
  x= 10
32400
33067
  }
32401
33068
 
33069
+ /**
33070
+ * Defines text direction of the chart axis title.
33071
+ * @enum {number}
33072
+ */
33073
+ export enum TextDirection{
33074
+ /**
33075
+ * Specifies that text displays as horizontal.
33076
+ */
33077
+ horz= 0,
33078
+ /**
33079
+ * Specifies that text displays as vertical 90 degrees.
33080
+ */
33081
+ vert= 1,
33082
+ /**
33083
+ * Specifies that text displays as vertical 270 degrees.
33084
+ */
33085
+ vert270= 2,
33086
+ /**
33087
+ * Specifies that text displays as East Asian vertical right to left.
33088
+ */
33089
+ eaVert= 4,
33090
+ /**
33091
+ * Specifies that text displays as Word Art vertical right to left.
33092
+ */
33093
+ wordArtVertRtl= 6
33094
+ }
33095
+
33096
+ /**
33097
+ * Specifies the underline type of chart text.
33098
+ * @enum {number}
33099
+ */
33100
+ export enum TextUnderlineType{
33101
+ /**
33102
+ * No underline.
33103
+ */
33104
+ none= 0,
33105
+ /**
33106
+ * Single underline.
33107
+ */
33108
+ single= 1
33109
+ }
33110
+
32402
33111
  /**
32403
33112
  * Specifies the position of tick-mark labels on the specified axis.
32404
33113
  * @enum {number}
@@ -32712,6 +33421,12 @@ declare namespace GC{
32712
33421
  * @returns {string | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the name of the chart; otherwise, returns the chart.
32713
33422
  */
32714
33423
  name(value?: string): any;
33424
+ /**
33425
+ * Gets or sets the plot area style of the chart.
33426
+ * @param {GC.Spread.Sheets.Charts.IPlotArea} value The plot area style of the chart.
33427
+ * @returns {GC.Spread.Sheets.Charts.IPlotArea | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the plot area style of the chart; otherwise, returns the chart.
33428
+ */
33429
+ plotArea(value?: GC.Spread.Sheets.Charts.IPlotArea): any;
32715
33430
  /**
32716
33431
  * Refreshes the chart, in most cases does not need to call this method.
32717
33432
  */
@@ -32812,7 +33527,7 @@ declare namespace GC{
32812
33527
  * @class
32813
33528
  * @param {GC.Spread.Sheets.Worksheet} sheet The worksheet.
32814
33529
  */
32815
- constructor();
33530
+ constructor(sheet: GC.Spread.Sheets.Worksheet);
32816
33531
  /**
32817
33532
  * Adds a chart to the sheet.
32818
33533
  * @param {string} name The name of the chart that will be added to the sheet.
@@ -33079,14 +33794,6 @@ declare namespace GC{
33079
33794
  static monochromaticPalette9: GC.Spread.Sheets.Charts.ColorScheme;
33080
33795
  }
33081
33796
 
33082
- export class Points{
33083
- /**
33084
- * Represents the dataPoint collection that managers all dataPoints in a chart series.
33085
- * @class
33086
- */
33087
- constructor();
33088
- }
33089
-
33090
33797
  export class SeriesCollection{
33091
33798
  /**
33092
33799
  * Represents the series manager that managers all series in a chart.
@@ -33535,6 +34242,14 @@ declare namespace GC{
33535
34242
  * clearNamedCellTemplates
33536
34243
  */
33537
34244
  clearNamedCellTemplates= 73,
34245
+ /**
34246
+ * setSheetDataSource
34247
+ */
34248
+ setSheetDataSource= 74,
34249
+ /**
34250
+ * setValueForRemoteOp
34251
+ */
34252
+ setValueForRemoteOp= 75,
33538
34253
  /**
33539
34254
  * addExternalReference
33540
34255
  */
@@ -33651,6 +34366,14 @@ declare namespace GC{
33651
34366
  * setTableColumnProperty
33652
34367
  */
33653
34368
  setTableColumnProperty= 182,
34369
+ /**
34370
+ * setTableDataManagerBindingConfig
34371
+ */
34372
+ setTableDataManagerBindingConfig= 183,
34373
+ /**
34374
+ * setTableColumns
34375
+ */
34376
+ setTableColumns= 184,
33654
34377
  /**
33655
34378
  * addShape
33656
34379
  */
@@ -33715,6 +34438,10 @@ declare namespace GC{
33715
34438
  * updatePivotCacheField
33716
34439
  */
33717
34440
  updatePivotCacheField= 255,
34441
+ /**
34442
+ * updatePivotCacheOptions
34443
+ */
34444
+ updatePivotCacheOptions= 256,
33718
34445
  /**
33719
34446
  * addPivotTable
33720
34447
  */
@@ -33975,6 +34702,10 @@ declare namespace GC{
33975
34702
  * setPinnedRows
33976
34703
  */
33977
34704
  setPinnedRows= 448,
34705
+ /**
34706
+ * setIndexMapForDisableAutoMode
34707
+ */
34708
+ setIndexMapForDisableAutoMode= 449,
33978
34709
  /**
33979
34710
  * updateLocalRecord
33980
34711
  */
@@ -34050,7 +34781,31 @@ declare namespace GC{
34050
34781
  /**
34051
34782
  * removeRichDataImage
34052
34783
  */
34053
- removeRichDataImage= 502
34784
+ removeRichDataImage= 502,
34785
+ /**
34786
+ * setScenario
34787
+ */
34788
+ setScenario= 510,
34789
+ /**
34790
+ * setScenarioProp
34791
+ */
34792
+ setScenarioProp= 512,
34793
+ /**
34794
+ * setScenarioOverrides
34795
+ */
34796
+ setScenarioOverrides= 513,
34797
+ /**
34798
+ * setAppliedScenario
34799
+ */
34800
+ setAppliedScenario= 515,
34801
+ /**
34802
+ * setActiveScenario
34803
+ */
34804
+ setActiveScenario= 517,
34805
+ /**
34806
+ * setBaseValues
34807
+ */
34808
+ setBaseValues= 518
34054
34809
  }
34055
34810
 
34056
34811
  /**
@@ -34091,7 +34846,7 @@ declare namespace GC{
34091
34846
  constructor(workbook: GC.Spread.Sheets.Workbook);
34092
34847
  /**
34093
34848
  * Only used in collaboration case, to apply doc's op.
34094
- * @param {changeSet: GC.Spread.Sheets.Collaboration.IChangeSet} changeSet - change set
34849
+ * @param {GC.Spread.Sheets.Collaboration.IChangeSet} changeSet - change set
34095
34850
  */
34096
34851
  applyChangeSet(changeSet: GC.Spread.Sheets.Collaboration.IChangeSet): void;
34097
34852
  /**
@@ -34145,7 +34900,7 @@ declare namespace GC{
34145
34900
  getUser(): GC.Spread.Sheets.Collaboration.IUserWithPermission;
34146
34901
  /**
34147
34902
  * Only used in collaboration case, to watch change set.
34148
- * @param {changeSetHandler: GC.Spread.Sheets.Collaboration.IChangeSetHandler} onOpHandler - callback to watch change set
34903
+ * @param {GC.Spread.Sheets.Collaboration.IChangeSetHandler} onOpHandler - callback to watch change set
34149
34904
  */
34150
34905
  onChangeSet(onOpHandler: GC.Spread.Sheets.Collaboration.IChangeSetHandler): void;
34151
34906
  /**
@@ -36091,6 +36846,98 @@ declare namespace GC{
36091
36846
  * ```
36092
36847
  */
36093
36848
  var tableResize: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, tableName: string, resizeToRange: GC.Spread.Sheets.Range}, isUndo: boolean): boolean};
36849
+ /**
36850
+ * Represents the command used to add a sorting on the column.
36851
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
36852
+ * @property {function} execute - performs an execute or undo operation.
36853
+ * The arguments of the execute method are as follows.
36854
+ * @property {GC.Spread.Sheets.Workbook} context - The context of the operation.
36855
+ * @property {Object} options - The options of the operation.
36856
+ * @property {string} options.sheetName - The sheet name.
36857
+ * @property {number} options.col - The specified col.
36858
+ * @property {boolean} options.ascending - The specified ascending.
36859
+ * @property {string | Function} [options.compare] - The specified compare.
36860
+ * @property {boolean} isUndo - `true` if this is an undo operation; otherwise, `false`.
36861
+ * @example
36862
+ * ```javascript
36863
+ * //This example uses the add sort column action.
36864
+ * spread.commandManager().execute({cmd: "TableSheetAddSortColumn", sheetName: "Sheet1", col: 1, ascending: true});
36865
+ * ```
36866
+ */
36867
+ var TableSheetAddSortColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, col: number, ascending: boolean, compare?: string | Function}): any};
36868
+ /**
36869
+ * Represents the command used to filter the column.
36870
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
36871
+ * @property {function} execute - performs an execute or undo operation.
36872
+ * The arguments of the execute method are as follows.
36873
+ * @property {GC.Spread.Sheets.Workbook} context - The context of the operation.
36874
+ * @property {Object} options - The options of the operation.
36875
+ * @property {string} options.sheetName - The sheet name.
36876
+ * @property {number} options.col - The specified col.
36877
+ * @property {GC.Spread.Sheets.TableSheet.ITableSheetFilterValue[]} [options.values] - The specified values.
36878
+ * @property {GC.Spread.Sheets.TableSheet.ITableSheetFilterHierarchyPath[]} [options.paths] - The specified hierarchy paths.
36879
+ * @property {GC.Spread.Sheets.ConditionalFormatting.Condition} [options.condition] - The specified condition.
36880
+ * @property {boolean} isUndo - `true` if this is an undo operation; otherwise, `false`.
36881
+ * @example
36882
+ * ```javascript
36883
+ * //This example uses the filter column action.
36884
+ * spread.commandManager().execute({cmd: "TableSheetFilterColumn", sheetName: "Sheet1", col: 1, values: [{ value: 'New York' }]});
36885
+ * ```
36886
+ */
36887
+ var TableSheetFilterColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, col: number, values?: GC.Spread.Sheets.TableSheet.ITableSheetFilterValue[], condition?: GC.Spread.Sheets.ConditionalFormatting.Condition, paths?: GC.Spread.Sheets.TableSheet.ITableSheetFilterHierarchyPath[]}): any};
36888
+ /**
36889
+ * Represents the command used to remove the filter from the column.
36890
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
36891
+ * @property {function} execute - performs an execute or undo operation.
36892
+ * The arguments of the execute method are as follows.
36893
+ * @property {GC.Spread.Sheets.Workbook} context - The context of the operation.
36894
+ * @property {Object} options - The options of the operation.
36895
+ * @property {string} options.sheetName - The sheet name.
36896
+ * @property {number} options.col - The specified col.
36897
+ * @property {boolean} isUndo - `true` if this is an undo operation; otherwise, `false`.
36898
+ * @example
36899
+ * ```javascript
36900
+ * //This example uses the remove filter column action.
36901
+ * spread.commandManager().execute({cmd: "TableSheetRemoveFilterColumn", sheetName: "Sheet1", col: 1});
36902
+ * ```
36903
+ */
36904
+ var TableSheetRemoveFilterColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, col: number}): any};
36905
+ /**
36906
+ * Represents the command used to remove a sorting on the column.
36907
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
36908
+ * @property {function} execute - performs an execute or undo operation.
36909
+ * The arguments of the execute method are as follows.
36910
+ * @property {GC.Spread.Sheets.Workbook} context - The context of the operation.
36911
+ * @property {Object} options - The options of the operation.
36912
+ * @property {string} options.sheetName - The sheet name.
36913
+ * @property {number} options.col - The specified col.
36914
+ * @property {boolean} isUndo - `true` if this is an undo operation; otherwise, `false`.
36915
+ * @example
36916
+ * ```javascript
36917
+ * //This example uses the remove sort column action.
36918
+ * spread.commandManager().execute({cmd: "TableSheetRemoveSortColumn", sheetName: "Sheet1", col: 1});
36919
+ * ```
36920
+ */
36921
+ var TableSheetRemoveSortColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, col: number}): any};
36922
+ /**
36923
+ * Represents the command used to sort only one column.
36924
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
36925
+ * @property {function} execute - performs an execute or undo operation.
36926
+ * The arguments of the execute method are as follows.
36927
+ * @property {GC.Spread.Sheets.Workbook} context - The context of the operation.
36928
+ * @property {Object} options - The options of the operation.
36929
+ * @property {string} options.sheetName - The sheet name.
36930
+ * @property {number} options.col - The specified col.
36931
+ * @property {boolean} options.ascending - The specified ascending.
36932
+ * @property {string | Function} [options.compare] - The specified compare.
36933
+ * @property {boolean} isUndo - `true` if this is an undo operation; otherwise, `false`.
36934
+ * @example
36935
+ * ```javascript
36936
+ * //This example uses the sort column action.
36937
+ * spread.commandManager().execute({cmd: "TableSheetSortColumn", sheetName: "Sheet1", col: 1, ascending: true});
36938
+ * ```
36939
+ */
36940
+ var TableSheetSortColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, col: number, ascending: boolean, compare?: string | Function}): any};
36094
36941
  /**
36095
36942
  * Represents the command used to submit changes of the tables which bind data manager tables.
36096
36943
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
@@ -36143,9 +36990,9 @@ declare namespace GC{
36143
36990
  var zoom: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, zoomFactor: number}, isUndo: boolean): any};
36144
36991
  /**
36145
36992
  * Ends a transaction. During the transaction, the changes of the data model will be saved.
36146
- * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
36147
- * @property {Object} options The options of the operation.
36148
- * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
36993
+ * @param {GC.Spread.Sheets.Workbook} context The workbook whose transaction will be ended.
36994
+ * @param {Object} options The command options object passed to `startTransaction`; this object receives the recorded changes.
36995
+ * @param {string|string[]} [options.sheetName] The name or names of the worksheets included in the transaction.
36149
36996
  * @example
36150
36997
  * ```javascript
36151
36998
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -36176,9 +37023,9 @@ declare namespace GC{
36176
37023
  function endTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
36177
37024
  /**
36178
37025
  * Starts a transaction. During the transaction, the changes of the data model will be saved.
36179
- * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
36180
- * @property {Object} options The options of the operation.
36181
- * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
37026
+ * @param {GC.Spread.Sheets.Workbook} context The workbook whose changes will be recorded.
37027
+ * @param {Object} options The command options object to use throughout the transaction.
37028
+ * @param {string|string[]} [options.sheetName] The name or names of the worksheets included in the transaction.
36182
37029
  * @example
36183
37030
  * ```javascript
36184
37031
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -36209,9 +37056,9 @@ declare namespace GC{
36209
37056
  function startTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
36210
37057
  /**
36211
37058
  * Undo the changes made in a transaction.
36212
- * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
36213
- * @property {Object} options The options of the operation.
36214
- * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
37059
+ * @param {GC.Spread.Sheets.Workbook} context The workbook whose transaction changes will be undone.
37060
+ * @param {Object} options The command options object populated by `endTransaction`, containing the changes to undo.
37061
+ * @param {string|string[]} [options.sheetName] The name or names of the worksheets included in the transaction.
36215
37062
  * @example
36216
37063
  * ```javascript
36217
37064
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -38473,7 +39320,7 @@ declare namespace GC{
38473
39320
  * activeSheet.conditionalFormats.addIconSetRule(GC.Spread.Sheets.ConditionalFormatting.IconSetType.fourTrafficLights, [new GC.Spread.Sheets.Range(0,0,4,1)]);
38474
39321
  * ```
38475
39322
  */
38476
- addIconSetRule(iconSetTye: GC.Spread.Sheets.ConditionalFormatting.IconSetType, ranges: GC.Spread.Sheets.Range[]): GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase;
39323
+ addIconSetRule(iconSetType: GC.Spread.Sheets.ConditionalFormatting.IconSetType, ranges: GC.Spread.Sheets.Range[]): GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase;
38477
39324
  /**
38478
39325
  * Adds a row state rule to the rule collection.
38479
39326
  * @param {GC.Spread.Sheets.RowColumnStates} state The state type.
@@ -39704,9 +40551,7 @@ declare namespace GC{
39704
40551
  iconCriteria(value?: GC.Spread.Sheets.ConditionalFormatting.IconCriterion[]): GC.Spread.Sheets.ConditionalFormatting.IconCriterion[];
39705
40552
  /**
39706
40553
  * Gets or sets the icons.
39707
- * @param {object[]} [iconInfos] - Sets the iconInfos array.
39708
- * @param {GC.Spread.Sheets.ConditionalFormatting.IconSetType} iconInfos.iconSetType - The custom iconSetType
39709
- * @param {number} iconInfos.iconIndex - The custom iconIndex
40554
+ * @param {object[]} iconInfos - Sets the iconInfos array.
39710
40555
  * @returns {object[]} Returns a copy of the iconInfos array.
39711
40556
  * @example
39712
40557
  * ```javascript
@@ -39730,7 +40575,7 @@ declare namespace GC{
39730
40575
  * activeSheet.conditionalFormats.addRule(iconSetRule);
39731
40576
  * ```
39732
40577
  */
39733
- icons(value?: GC.Spread.Sheets.ConditionalFormatting.IIconInfo[]): GC.Spread.Sheets.ConditionalFormatting.IIconInfo[];
40578
+ icons(iconInfos?: GC.Spread.Sheets.ConditionalFormatting.IIconInfo[]): GC.Spread.Sheets.ConditionalFormatting.IIconInfo[];
39734
40579
  /**
39735
40580
  * Gets or sets the type of icon set.
39736
40581
  * @param {GC.Spread.Sheets.ConditionalFormatting.IconSetType} value The type of icon set.
@@ -40423,7 +41268,9 @@ declare namespace GC{
40423
41268
  */
40424
41269
  minValue(value?: number): any;
40425
41270
  /**
40426
- * Gets whether evaluation should stop if the condition evaluates to `true`.
41271
+ * Gets whether evaluation should stop if the condition evaluates to `true`. Scale rules always return `false`.
41272
+ * @param {boolean} value Ignored because this setting cannot be changed for a scale rule.
41273
+ * @returns {boolean} `false`.
40427
41274
  */
40428
41275
  stopIfTrue(value?: boolean): boolean;
40429
41276
  }
@@ -41083,7 +41930,7 @@ declare namespace GC{
41083
41930
  min?: GC.Spread.Sheets.DataCharts.IValueOption;
41084
41931
  position?: GC.Spread.Sheets.DataCharts.AxisPosition;
41085
41932
  origin?: number;
41086
- format?: GC.Spread.Sheets.DataCharts.IFormatOption;
41933
+ format?: GC.Spread.Sheets.DataCharts.IFormatOption | GC.Spread.Sheets.DataCharts.IFormatOption[];
41087
41934
  majorUnit?: GC.Spread.Sheets.DataCharts.IAxisUnitOption;
41088
41935
  overlappingLabels?: GC.Spread.Sheets.DataCharts.OverlappingLabels;
41089
41936
  dateMode?: GC.Spread.Sheets.DataCharts.DateMode;
@@ -41133,10 +41980,16 @@ declare namespace GC{
41133
41980
 
41134
41981
  export interface ICategoryEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
41135
41982
  sort?: GC.Spread.Sheets.DataCharts.ISortEncodingOption;
41983
+ dateMode?: GC.Spread.Sheets.DataCharts.DateMode;
41136
41984
  child?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
41137
41985
  }
41138
41986
 
41139
41987
 
41988
+ export interface IColorEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
41989
+ aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
41990
+ }
41991
+
41992
+
41140
41993
  export interface IConfigLegendOption{
41141
41994
  wrapping?: boolean;
41142
41995
  }
@@ -41200,8 +42053,17 @@ declare namespace GC{
41200
42053
 
41201
42054
  export interface IFunnelOption{
41202
42055
  funnelType?: GC.Spread.Sheets.DataCharts.FunnelType;
42056
+ /**
42057
+ * @deprecated Using `topWidth` to change the funnel shape is no longer supported. The funnel shape is determined by the data.
42058
+ */
41203
42059
  topWidth?: number;
42060
+ /**
42061
+ * @deprecated Using `bottomWidth` to change the funnel shape is no longer supported. The funnel shape is determined by the data.
42062
+ */
41204
42063
  bottomWidth?: number;
42064
+ /**
42065
+ * @deprecated Using `neckHeight` to change the funnel shape is no longer supported. The funnel shape is determined by the data.
42066
+ */
41205
42067
  neckHeight?: number;
41206
42068
  orientation?: GC.Spread.Sheets.DataCharts.Orientation;
41207
42069
  reversed?: boolean;
@@ -41233,6 +42095,8 @@ declare namespace GC{
41233
42095
  type?: GC.Spread.Sheets.DataCharts.LegendType;
41234
42096
  height?: number;
41235
42097
  width?: number;
42098
+ maxHeight?: number;
42099
+ maxWidth?: number;
41236
42100
  position?: GC.Spread.Sheets.DataCharts.LegendPosition;
41237
42101
  textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
41238
42102
  hAlign?: GC.Spread.Sheets.DataCharts.HAlign;
@@ -41285,6 +42149,7 @@ declare namespace GC{
41285
42149
  outerRadius?: number;
41286
42150
  lineAspect?: GC.Spread.Sheets.DataCharts.LineAspect;
41287
42151
  palette?: string[];
42152
+ usePositiveNegativeColors?: boolean;
41288
42153
  startAngle?: number;
41289
42154
  style?: GC.Spread.Sheets.DataCharts.IDataPointStyleOption;
41290
42155
  /**
@@ -41300,6 +42165,7 @@ declare namespace GC{
41300
42165
  funnel?: GC.Spread.Sheets.DataCharts.IFunnelOption;
41301
42166
  waterfall?: GC.Spread.Sheets.DataCharts.IWaterfallOption;
41302
42167
  treemap?: GC.Spread.Sheets.DataCharts.ITreemapOption;
42168
+ trellis?: GC.Spread.Sheets.DataCharts.IPlotConfigTrellisOption;
41303
42169
  }
41304
42170
 
41305
42171
 
@@ -41322,14 +42188,26 @@ declare namespace GC{
41322
42188
  }
41323
42189
 
41324
42190
 
42191
+ export interface IPlotConfigTrellisOption{
42192
+ style?: GC.Spread.Sheets.DataCharts.IStyleOption;
42193
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
42194
+ hoverStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
42195
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
42196
+ includeAxesInCells?: boolean;
42197
+ includeEmptyCells?: boolean;
42198
+ }
42199
+
42200
+
41325
42201
  export interface IPlotEncodingsOption{
41326
42202
  values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IRangeValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IStockValueEncodingOption[];
41327
42203
  category?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
41328
42204
  details?: GC.Spread.Sheets.DataCharts.IFieldBasicOption[];
41329
- color?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
42205
+ color?: GC.Spread.Sheets.DataCharts.IColorEncodingOption;
41330
42206
  size?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
41331
42207
  tooltip?: GC.Spread.Sheets.DataCharts.IContentEncodingOption[];
41332
42208
  filter?: GC.Spread.Sheets.DataCharts.IFilterOption;
42209
+ row?: GC.Spread.Sheets.DataCharts.ITrellisEncodingOption;
42210
+ column?: GC.Spread.Sheets.DataCharts.ITrellisEncodingOption;
41333
42211
  }
41334
42212
 
41335
42213
 
@@ -41458,6 +42336,12 @@ declare namespace GC{
41458
42336
  }
41459
42337
 
41460
42338
 
42339
+ export interface ITrellisEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
42340
+ sort?: GC.Spread.Sheets.DataCharts.ISortEncodingOption;
42341
+ child?: GC.Spread.Sheets.DataCharts.ITrellisEncodingOption;
42342
+ }
42343
+
42344
+
41461
42345
  export interface IValueEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
41462
42346
  aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
41463
42347
  }
@@ -41930,7 +42814,22 @@ declare namespace GC{
41930
42814
  /**
41931
42815
  year
41932
42816
  */
41933
- year= 7
42817
+ year= 7,
42818
+ /**
42819
+ quarter
42820
+ */
42821
+ quarter= 8
42822
+ }
42823
+
42824
+ /**
42825
+ * Specifies the special fields of datachart encodings.
42826
+ * @enum {string}
42827
+ */
42828
+ export enum EncodingField{
42829
+ /**
42830
+ * value names
42831
+ */
42832
+ valueNames= "VALUE_NAMES"
41934
42833
  }
41935
42834
 
41936
42835
  /**
@@ -42335,7 +43234,11 @@ declare namespace GC{
42335
43234
  /**
42336
43235
  linear
42337
43236
  */
42338
- linear= "Linear"
43237
+ linear= "Linear",
43238
+ /**
43239
+ ordinal
43240
+ */
43241
+ ordinal= "Ordinal"
42339
43242
  }
42340
43243
 
42341
43244
 
@@ -42455,6 +43358,7 @@ declare namespace GC{
42455
43358
  /**
42456
43359
  * set datachart config.
42457
43360
  * @param {object} config The config of the datachart.
43361
+ * @param {boolean} inferMissingEncodings Whether to infer missing detail or color encodings. The default value is false.
42458
43362
  * @example
42459
43363
  * ```javascript
42460
43364
  * var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
@@ -42463,7 +43367,7 @@ declare namespace GC{
42463
43367
  * datachart.setChartConfig(config);
42464
43368
  * ```
42465
43369
  */
42466
- setChartConfig(config: GC.Spread.Sheets.DataCharts.IDataChartConfig): void;
43370
+ setChartConfig(config: GC.Spread.Sheets.DataCharts.IDataChartConfig, inferMissingEncodings?: boolean): void;
42467
43371
  /**
42468
43372
  * Gets or sets the starting column index of the data chart position.
42469
43373
  * @param {number} value The starting column index of the data chart position.
@@ -42517,7 +43421,8 @@ declare namespace GC{
42517
43421
  */
42518
43422
  constructor(host: HTMLElement | string, spread: GC.Spread.Sheets.Workbook);
42519
43423
  /**
42520
- * attach the spread to the config panel.
43424
+ * Attaches the workbook to the config panel.
43425
+ * @param {GC.Spread.Sheets.Workbook} spread The workbook instance to attach.
42521
43426
  * @example
42522
43427
  * ```javascript
42523
43428
  * configPanel.attach(spread);
@@ -42558,7 +43463,7 @@ declare namespace GC{
42558
43463
  * @class
42559
43464
  * @param {GC.Spread.Sheets.Worksheet} sheet The worksheet.
42560
43465
  */
42561
- constructor();
43466
+ constructor(sheet: GC.Spread.Sheets.Worksheet);
42562
43467
  /**
42563
43468
  * Adds a datachart to the sheet.
42564
43469
  * @param {string} name The name of the datachart that will be added to the sheet.
@@ -45563,6 +46468,68 @@ declare namespace GC{
45563
46468
  }
45564
46469
 
45565
46470
 
46471
+ /**
46472
+ * Represents the configuration of a progress line on GanttChart.
46473
+ * @typedef {Object} GC.Spread.Sheets.GanttSheet.IProgressLine
46474
+ * @property {boolean} display Indicates whether to display the progress line.
46475
+ * @property {"statusDate" | "currentDate"} referenceDate Indicates the reference date mode of the progress line.
46476
+ * @property {GC.Spread.Sheets.GanttSheet.IProgressLinePathType} pathType Indicates the path type of the progress line.
46477
+ * @property {GC.Spread.Sheets.GanttSheet.GanttGridline} lineStyle Indicates the line style of the progress line.
46478
+ * @property {GC.Spread.Sheets.GanttSheet.IProgressPointStyle} pointStyle Indicates the progress-point style.
46479
+ * @property {GC.Spread.Sheets.GanttSheet.IProgressLineDateLabelStyle} [dateLabelStyle] Indicates the progress-line date-label style.
46480
+ */
46481
+ export type IProgressLine =
46482
+ {
46483
+ display: boolean;
46484
+ referenceDate: "statusDate" | "currentDate";
46485
+ pathType: GC.Spread.Sheets.GanttSheet.IProgressLinePathType;
46486
+ lineStyle: GC.Spread.Sheets.GanttSheet.GanttGridline;
46487
+ pointStyle: GC.Spread.Sheets.GanttSheet.IProgressPointStyle;
46488
+ dateLabelStyle?: GC.Spread.Sheets.GanttSheet.IProgressLineDateLabelStyle;
46489
+ }
46490
+
46491
+
46492
+ /**
46493
+ * Represents the style of a progress-line date label.
46494
+ * @typedef {Object} GC.Spread.Sheets.GanttSheet.IProgressLineDateLabelStyle
46495
+ * @property {boolean} display Indicates whether to display the progress-line date label.
46496
+ * @property {string} format Indicates the date format of the progress-line date label.
46497
+ * @property {string} font Indicates the font of the progress-line date label.
46498
+ */
46499
+ export type IProgressLineDateLabelStyle =
46500
+ {
46501
+ display: boolean;
46502
+ format: string;
46503
+ font: string;
46504
+ }
46505
+
46506
+
46507
+ /**
46508
+ * Represents the routing behavior of a progress line path.
46509
+ * @typedef {Object} GC.Spread.Sheets.GanttSheet.IProgressLinePathType
46510
+ * @property {boolean} returnToReferenceDate Indicates whether the path returns to the reference-date anchor after each progress point.
46511
+ * @property {"orthogonal" | "diagonal"} pointConnectionType Indicates whether the point connection uses orthogonal or diagonal segments.
46512
+ */
46513
+ export type IProgressLinePathType =
46514
+ {
46515
+ returnToReferenceDate: boolean;
46516
+ pointConnectionType: "orthogonal" | "diagonal";
46517
+ }
46518
+
46519
+
46520
+ /**
46521
+ * Represents the style of a progress point.
46522
+ * @typedef {Object} GC.Spread.Sheets.GanttSheet.IProgressPointStyle
46523
+ * @property {GC.Spread.Sheets.GanttSheet.ProgressPointShape} shape Indicates the shape of the progress point.
46524
+ * @property {GC.Data.ColorString} color Indicates the color of the progress point.
46525
+ */
46526
+ export type IProgressPointStyle =
46527
+ {
46528
+ shape: GC.Spread.Sheets.GanttSheet.ProgressPointShape;
46529
+ color: GC.Data.ColorString;
46530
+ }
46531
+
46532
+
45566
46533
  /**
45567
46534
  * Represents the data to create tasks. It is used in add, insert, and renew tasks methods of project.
45568
46535
  * @typedef {Object} GC.Spread.Sheets.GanttSheet.ITaskData
@@ -45608,6 +46575,33 @@ declare namespace GC{
45608
46575
  "Behind" | "None"
45609
46576
 
45610
46577
 
46578
+ /**
46579
+ * Represents how the progress line connects adjacent progress points.
46580
+ * @typedef GC.Spread.Sheets.GanttSheet.ProgressLinePointConnectionType
46581
+ * @type {"orthogonal" | "diagonal"}
46582
+ */
46583
+ export type ProgressLinePointConnectionType =
46584
+ "orthogonal" | "diagonal"
46585
+
46586
+
46587
+ /**
46588
+ * Represents which project-level date the progress line uses as its reference date.
46589
+ * @typedef GC.Spread.Sheets.GanttSheet.ProgressLineReferenceDate
46590
+ * @type {"statusDate" | "currentDate"}
46591
+ */
46592
+ export type ProgressLineReferenceDate =
46593
+ "statusDate" | "currentDate"
46594
+
46595
+
46596
+ /**
46597
+ * Represents the shape of a progress point.
46598
+ * @typedef GC.Spread.Sheets.GanttSheet.ProgressPointShape
46599
+ * @type {GC.Spread.Sheets.GanttSheet.TaskbarEndShape}
46600
+ */
46601
+ export type ProgressPointShape =
46602
+ GC.Spread.Sheets.GanttSheet.TaskbarEndShape
46603
+
46604
+
45611
46605
  /**
45612
46606
  * @typedef GC.Spread.Sheets.GanttSheet.TaskbarEndShape
45613
46607
  * @type {"arrowDown" | "arrowUp" | "caretDownTop" | "caretUpBottom" | "circle" | "circleArrowDown" | "circleArrowUp" | "circleDiamond" | "circleTriangleDown" | "circleTriangleUp" | "diamond" | "houseDown" | "houseUp" | "leftBracket" | "leftFade" | "lineShape" | "rightBracket" | "rightFade" | "square" | "star" | "triangleDown" | "triangleLeft" | "triangleRight" | "triangleUp"}
@@ -46049,10 +47043,10 @@ declare namespace GC{
46049
47043
  /**
46050
47044
  * Creates an instance of Collection.
46051
47045
  * @class
46052
- * @param {T[]} [items] The items of collection.
47046
+ * @param {T[]} items The items of collection.
46053
47047
  * @classdesc A collection of objects.
46054
47048
  */
46055
- constructor();
47049
+ constructor(items?: T[]);
46056
47050
  /**
46057
47051
  * Adds the item into list.
46058
47052
  * @param {T} item The item to add.
@@ -46090,7 +47084,7 @@ declare namespace GC{
46090
47084
  * @param {number} index The insert index.
46091
47085
  * @param {T} item The item to insert.
46092
47086
  */
46093
- insert(item: T): void;
47087
+ insert(index: number, item: T): void;
46094
47088
  /**
46095
47089
  * Get the collection list length.
46096
47090
  * @return {number} The collection list length.
@@ -46172,6 +47166,11 @@ declare namespace GC{
46172
47166
  * @type {GC.Spread.Sheets.GanttSheet.GanttGridline}
46173
47167
  */
46174
47168
  projectStart: GC.Spread.Sheets.GanttSheet.GanttGridline;
47169
+ /**
47170
+ * Gets or sets the gridline to indicate status date on GanttChart.
47171
+ * @type {GC.Spread.Sheets.GanttSheet.GanttGridline}
47172
+ */
47173
+ statusDate: GC.Spread.Sheets.GanttSheet.GanttGridline;
46175
47174
  /**
46176
47175
  * Gets or sets the gridline which aligns to the ticks on timescale top tier on GanttChart.
46177
47176
  * @type {GC.Spread.Sheets.GanttSheet.GanttGridline}
@@ -46272,6 +47271,12 @@ declare namespace GC{
46272
47271
  * @type {GC.Spread.Sheets.GanttSheet.GanttMapping}
46273
47272
  */
46274
47273
  mapping: GC.Spread.Sheets.GanttSheet.GanttMapping;
47274
+ /**
47275
+ * Gets or sets the progress-line configuration for gantt chart.
47276
+ * If undefined, no progress line is defined.
47277
+ * @type {GC.Spread.Sheets.GanttSheet.IProgressLine}
47278
+ */
47279
+ progressLine: GC.Spread.Sheets.GanttSheet.IProgressLine;
46275
47280
  /**
46276
47281
  * Gets the project to display and edit of this GanttSheet.
46277
47282
  * @readonly
@@ -46399,6 +47404,11 @@ declare namespace GC{
46399
47404
  * @type {Date}
46400
47405
  */
46401
47406
  startDate: Date;
47407
+ /**
47408
+ * Gets or sets the status date of this project. It is used by the Status Date gridline and Progress Line reference-date logic.
47409
+ * @type {Date}
47410
+ */
47411
+ statusDate: Date;
46402
47412
  /**
46403
47413
  * Gets the tasks in this project.
46404
47414
  * This is a cloned array of the internal tasks. Please use getTask if you want to get one task with the specified task number.
@@ -46514,8 +47524,8 @@ declare namespace GC{
46514
47524
  * Sorts the tasks with the specified task fields.
46515
47525
  * @param {string[]} fields Specifies the fields to sort by.
46516
47526
  * @param {boolean[]} ascendingStates Specifies the ascending states for related fields.
46517
- * @param {boolean[]} [keepStructure=true] Specifies sort result should keep the task parent-children relationship structure. The default is true.
46518
- * @param {boolean[]} [renumber=false] If true, the number of tasks will be renumbered by the sort result. The default is false.
47527
+ * @param {boolean} [keepStructure=true] Specifies sort result should keep the task parent-children relationship structure. The default is true.
47528
+ * @param {boolean} [renumber=false] If true, the number of tasks will be renumbered by the sort result. The default is false.
46519
47529
  */
46520
47530
  sort(fields: string[], ascendingStates?: boolean[], keepStructure?: boolean, renumber?: boolean): void;
46521
47531
  /**
@@ -46769,7 +47779,8 @@ declare namespace GC{
46769
47779
  */
46770
47780
  typeName: string;
46771
47781
  /**
46772
- * Initialize a TaskbarStyleRule object using a JSON object.
47782
+ * Initializes a TaskbarStyleRule object using a JSON object.
47783
+ * @param {Object} styleSetting The JSON object containing the taskbar style settings.
46773
47784
  */
46774
47785
  fromJSON(styleSetting: any): void;
46775
47786
  /**
@@ -47245,7 +48256,7 @@ declare namespace GC{
47245
48256
  * Represents name box.
47246
48257
  * @class
47247
48258
  * @param {HTMLElement | string} host The DOM Element.
47248
- * @param {GC.Spread.Sheets.Workbook} spread The workbook which the namebox bound.
48259
+ * @param {GC.Spread.Sheets.Workbook} workbook The workbook which the namebox bound.
47249
48260
  * @param {GC.Spread.Sheets.NameBox.INameBoxOptions} options options of the name box.
47250
48261
  */
47251
48262
  constructor(host: HTMLElement | string, workbook: GC.Spread.Sheets.Workbook, options?: GC.Spread.Sheets.NameBox.INameBoxOptions);
@@ -48306,7 +49317,7 @@ declare namespace GC{
48306
49317
  * Register a Font for export PDF.
48307
49318
  * @static
48308
49319
  * @param {string} name The font name.
48309
- * @param {Object} [font] The font object.
49320
+ * @param {Object} font The font object.
48310
49321
  * @param {string | ArrayBuffer} [font.normal] The normal font file in base64 string or ArrayBuffer.
48311
49322
  * @param {string | ArrayBuffer} [font.bold] The bold font file in base64 string or ArrayBuffer.
48312
49323
  * @param {string | ArrayBuffer} [font.italic] The italic font file in base64 string or ArrayBuffer.
@@ -49035,7 +50046,7 @@ declare namespace GC{
49035
50046
  * The constructor has 3 modes.<br/>
49036
50047
  * If there are 2 parameters, the parameters are width and height with a type of number;<br/>
49037
50048
  * If there is 1 parameter, the parameter is kind which is a GC.Spread.Sheets.Print.PaperKind type;<br/>
49038
- * If there is no parameter, the kind option is GC.Spread.Sheets.Print.PaperKind.letter.
50049
+ * If there is no parameter, the kind option is read from the current culture's paperKind and falls back to GC.Spread.Sheets.Print.PaperKind.letter.
49039
50050
  * @class
49040
50051
  * @param {number|GC.Spread.Sheets.Print.PaperKind} widthOrKind The width of the paper, in hundredths of an inch; or the kind of the paper and the type is GC.Spread.Sheets.Print.PaperKind.
49041
50052
  * @param {number} height The height of the paper, in hundredths of an inch.
@@ -49649,6 +50660,257 @@ declare namespace GC{
49649
50660
  }
49650
50661
  }
49651
50662
 
50663
+ namespace Scenarios{
50664
+
50665
+ export interface IOverride{
50666
+ /**
50667
+ * The cell reference in A1 notation.
50668
+ */
50669
+ ref: string;
50670
+ /**
50671
+ * The value stored for the cell.
50672
+ */
50673
+ value: GC.Spread.Sheets.Scenarios.OverrideValue;
50674
+ }
50675
+
50676
+
50677
+ export interface IOverrides{
50678
+ /**
50679
+ * The name of the target worksheet.
50680
+ */
50681
+ sheetName: string;
50682
+ /**
50683
+ * The worksheet-level description of the scenario overrides.
50684
+ */
50685
+ comment?: string;
50686
+ /**
50687
+ * Whether the overrides are hidden in protected UI contexts.
50688
+ */
50689
+ hidden?: boolean;
50690
+ /**
50691
+ * Whether the overrides are read-only in protected UI contexts.
50692
+ */
50693
+ locked?: boolean;
50694
+ /**
50695
+ * The stored cell overrides for the worksheet.
50696
+ */
50697
+ cells: GC.Spread.Sheets.Scenarios.IOverride[];
50698
+ }
50699
+
50700
+
50701
+ export interface IScenario{
50702
+ /**
50703
+ * The scenario name. It must be unique in the workbook.
50704
+ */
50705
+ name: string;
50706
+ /**
50707
+ * The id of the user who last modified the scenario definition.
50708
+ */
50709
+ userId?: string;
50710
+ /**
50711
+ * The worksheet-level overrides in the scenario.
50712
+ */
50713
+ overrides: GC.Spread.Sheets.Scenarios.IOverrides[];
50714
+ }
50715
+
50716
+
50717
+ /**
50718
+ * @typedef GC.Spread.Sheets.Scenarios.OverrideValue
50719
+ * @type {string | number | boolean | Date | null | undefined | GC.Spread.Sheets.IRichData | GC.Spread.Sheets.IImageRichData}
50720
+ * @description Represents a supported scenario cell value.
50721
+ */
50722
+ export type OverrideValue =
50723
+ string | number | boolean | Date | null | undefined | GC.Spread.Sheets.IRichData | GC.Spread.Sheets.IImageRichData
50724
+
50725
+
50726
+ /**
50727
+ * @typedef GC.Spread.Sheets.Scenarios.ScenarioActionType
50728
+ * @type {'add' | 'update' | 'remove' | 'apply' | 'restore' | 'activate' | 'deactivate'}
50729
+ * @description Represents the action type raised by scenario events.
50730
+ */
50731
+ export type ScenarioActionType =
50732
+ 'add' | 'update' | 'remove' | 'apply' | 'restore' | 'activate' | 'deactivate'
50733
+
50734
+
50735
+ export class ScenarioManager{
50736
+ /**
50737
+ * Represents a scenario manager for retrieving, updating, removing, applying, restoring, and active, deactive scenarios in a workbook.
50738
+ * @class
50739
+ * @param {GC.Spread.Sheets.Workbook} workbook The workbook that owns the scenario manager.
50740
+ * @example
50741
+ * ```javascript
50742
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
50743
+ * var scenarioManager = spread.scenarioManager;
50744
+ * ```
50745
+ */
50746
+ constructor(workbook: GC.Spread.Sheets.Workbook);
50747
+ /**
50748
+ * Gets all scenarios in the workbook.
50749
+ * @returns {GC.Spread.Sheets.Scenarios.IScenario[]} All scenarios in the workbook.
50750
+ * @example
50751
+ * ```javascript
50752
+ * var scenarios = spread.scenarioManager.all();
50753
+ * console.log(scenarios.length);
50754
+ * ```
50755
+ */
50756
+ all(): GC.Spread.Sheets.Scenarios.IScenario[];
50757
+ /**
50758
+ * Applies a scenario to the workbook.
50759
+ * @param {string} name The scenario name.
50760
+ * @returns {boolean} `true` if the scenario is applied successfully; otherwise, `false`.
50761
+ * @example
50762
+ * ```javascript
50763
+ * spread.scenarioManager.apply("Optimistic");
50764
+ * ```
50765
+ */
50766
+ apply(name: string): boolean;
50767
+ /**
50768
+ * Gets a scenario by name.
50769
+ * @param {string} name The scenario name.
50770
+ * @returns {GC.Spread.Sheets.Scenarios.IScenario | undefined} The scenario with the specified name. Returns `undefined` if the scenario does not exist.
50771
+ * @example
50772
+ * ```javascript
50773
+ * var scenario = spread.scenarioManager.get("Optimistic");
50774
+ * console.log(scenario);
50775
+ * ```
50776
+ */
50777
+ get(name: string): GC.Spread.Sheets.Scenarios.IScenario | undefined;
50778
+ /**
50779
+ * Gets the names of scenarios that are currently applied and not yet restored.
50780
+ * @returns {string[]} The applied scenario names in application order.
50781
+ * @example
50782
+ * ```javascript
50783
+ * var appliedNames = spread.scenarioManager.getAppliedScenarios();
50784
+ * console.log(appliedNames);
50785
+ * ```
50786
+ */
50787
+ getAppliedScenarios(): string[];
50788
+ /**
50789
+ * Gets a read-only snapshot of the current scenario base values.
50790
+ * @returns {GC.Spread.Sheets.Scenarios.IOverrides[]} The current base values.
50791
+ * @example
50792
+ * ```javascript
50793
+ * var baseValues = spread.scenarioManager.getBaseValues();
50794
+ * console.log(baseValues);
50795
+ * ```
50796
+ */
50797
+ getBaseValues(): GC.Spread.Sheets.Scenarios.IOverrides[];
50798
+ /**
50799
+ * Removes a scenario by name. If no name is provided, all scenarios in the workbook are removed.
50800
+ * @param {string} name The scenario name. If omitted, all scenarios are removed.
50801
+ * @returns {void}
50802
+ * @example
50803
+ * ```javascript
50804
+ * spread.scenarioManager.remove("Optimistic");
50805
+ * // Or remove all scenarios:
50806
+ * spread.scenarioManager.remove();
50807
+ * ```
50808
+ */
50809
+ remove(name?: string): void;
50810
+ /**
50811
+ * Restores previously applied scenario values to their base values.
50812
+ * @param {string} name The scenario name. If omitted, all applied scenarios are restored.
50813
+ * @returns {void}
50814
+ * @example
50815
+ * ```javascript
50816
+ * spread.scenarioManager.restore("Optimistic");
50817
+ * // Or restore all applied scenarios:
50818
+ * spread.scenarioManager.restore();
50819
+ * ```
50820
+ */
50821
+ restore(name?: string): void;
50822
+ /**
50823
+ * Updates an existing scenario definition.
50824
+ * @param {GC.Spread.Sheets.Scenarios.IScenario} scenario The scenario definition to update.
50825
+ * @returns {void}
50826
+ * @example
50827
+ * ```javascript
50828
+ * var scenario = spread.scenarioManager.get("Optimistic");
50829
+ * if (scenario) {
50830
+ * scenario.overrides[0].comment = "Updated sales growth assumption.";
50831
+ * spread.scenarioManager.set(scenario);
50832
+ * }
50833
+ * ```
50834
+ */
50835
+ set(scenario: GC.Spread.Sheets.Scenarios.IScenario): void;
50836
+ /**
50837
+ * Activates a scenario to capture subsequent cell value edits, or deactivates the current active scenario.
50838
+ * @param {string | null} name The scenario name. Pass `null` to deactivate the current active scenario.
50839
+ * @returns {boolean} `true` if the operation succeeds; otherwise, `false`.
50840
+ * @example
50841
+ * ```javascript
50842
+ * spread.scenarioManager.setActiveScenario("Optimistic");
50843
+ * activeSheet.setValue(1, 1, 1200);
50844
+ * spread.scenarioManager.setActiveScenario(null);
50845
+ * ```
50846
+ */
50847
+ setActiveScenario(name: string | null): boolean;
50848
+ }
50849
+
50850
+ export class ScenarioPanel{
50851
+ /**
50852
+ * Represents a scenario panel that displays and manages workbook scenarios.
50853
+ * @class
50854
+ * @param {HTMLElement|string} host The host element or host element id.
50855
+ * @param {GC.Spread.Sheets.Workbook} workbook The workbook associated with the scenario panel.
50856
+ * @example
50857
+ * ```javascript
50858
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
50859
+ * var scenarioPanel = new GC.Spread.Sheets.Scenarios.ScenarioPanel(document.getElementById("scenarioPanel"), spread);
50860
+ * ```
50861
+ */
50862
+ constructor(host: HTMLElement|string, workbook?: GC.Spread.Sheets.Workbook);
50863
+ /**
50864
+ * Attaches the scenario panel to a workbook.
50865
+ * @param {GC.Spread.Sheets.Workbook} workbook The workbook to attach.
50866
+ * @returns {void}
50867
+ * @example
50868
+ * ```javascript
50869
+ * scenarioPanel.attach(spread);
50870
+ * ```
50871
+ */
50872
+ attach(workbook: GC.Spread.Sheets.Workbook): void;
50873
+ /**
50874
+ * Destroys the scenario panel.
50875
+ * @returns {void}
50876
+ * @example
50877
+ * ```javascript
50878
+ * scenarioPanel.destroy();
50879
+ * ```
50880
+ */
50881
+ destroy(): void;
50882
+ /**
50883
+ * Detaches the scenario panel from the current workbook.
50884
+ * @returns {void}
50885
+ * @example
50886
+ * ```javascript
50887
+ * scenarioPanel.detach();
50888
+ * ```
50889
+ */
50890
+ detach(): void;
50891
+ /**
50892
+ * Gets the ScenarioPanel instance by the host element.
50893
+ * @param {HTMLElement|string} host The host element or the host element id.
50894
+ * @returns {GC.Spread.Sheets.Scenarios.ScenarioPanel | null} The ScenarioPanel instance.
50895
+ * @example
50896
+ * ```javascript
50897
+ * var scenarioPanel = new GC.Spread.Sheets.Scenarios.ScenarioPanel(document.getElementById("scenarioPanel"), spread);
50898
+ * var scenarioPanelInstance = GC.Spread.Sheets.Scenarios.ScenarioPanel.findControl("scenarioPanel");
50899
+ * ```
50900
+ */
50901
+ static findControl(host: HTMLElement|string): GC.Spread.Sheets.Scenarios.ScenarioPanel | null;
50902
+ /**
50903
+ * Refreshes the scenario panel view.
50904
+ * @returns {void}
50905
+ * @example
50906
+ * ```javascript
50907
+ * scenarioPanel.refresh();
50908
+ * ```
50909
+ */
50910
+ refresh(): void;
50911
+ }
50912
+ }
50913
+
49652
50914
  namespace Search{
49653
50915
  /**
49654
50916
  * Specifies the type of search flags.
@@ -52181,34 +53443,36 @@ declare namespace GC{
52181
53443
  * @class
52182
53444
  * @param {GC.Spread.Sheets.Worksheet} worksheet The host worksheet of the shape.
52183
53445
  * @param {string} name The name of the shape. If name is empty string, a unique name will be generated.
52184
- * @param {GC.Spread.Sheets.Shapes.FormControlType} Form control specific type.
53446
+ * @param {GC.Spread.Sheets.Shapes.FormControlType} formControlType The form control type.
52185
53447
  * @param {number} left The <i>x</i> location of the shape.
52186
53448
  * @param {number} top The <i>y</i> location of the shape.
52187
53449
  * @param {number} width The width of the shape.
52188
53450
  * @param {number} height The height of the shape.
52189
53451
  */
52190
- constructor(worksheet: GC.Spread.Sheets.Worksheet, formControlType: GC.Spread.Sheets.Shapes.FormControlType, left?: number, top?: number, width?: number, height?: number);
53452
+ constructor(worksheet: GC.Spread.Sheets.Worksheet, name?: string, formControlType?: GC.Spread.Sheets.Shapes.FormControlType, left?: number, top?: number, width?: number, height?: number);
52191
53453
  /**
52192
53454
  * Gets or Sets the enabled of form control shape.
52193
53455
  * @param {boolean} enabled The enabled of the form control shape.
52194
- * @returns {GC.Spread.Sheets.Shapes.FormControlType}
53456
+ * @returns {boolean} Whether the form control shape is enabled.
52195
53457
  */
52196
- enabled(v?: boolean): boolean;
53458
+ enabled(enabled?: boolean): boolean;
52197
53459
  /**
52198
53460
  * Gets FormControl specific type.
52199
53461
  * @returns {GC.Spread.Sheets.Shapes.FormControlType}
52200
53462
  */
52201
53463
  formControlType(): GC.Spread.Sheets.Shapes.FormControlType;
52202
53464
  /**
52203
- * Gets or Sets the options of form control shape.
52204
- * @returns {IFormControlShapeOptions}
53465
+ * Gets or sets the options of the form control shape.
53466
+ * @param {GC.Spread.Sheets.Shapes.IFormControlShapeOptions} options The options to set. If omitted, returns the current options.
53467
+ * @returns {GC.Spread.Sheets.Shapes.IFormControlShapeOptions} The current options when used as a getter.
52205
53468
  */
52206
- options(v?: GC.Spread.Sheets.Shapes.IFormControlShapeOptions): GC.Spread.Sheets.Shapes.IFormControlShapeOptions;
53469
+ options(options?: GC.Spread.Sheets.Shapes.IFormControlShapeOptions): GC.Spread.Sheets.Shapes.IFormControlShapeOptions;
52207
53470
  /**
52208
- * Gets or Sets the value of form control shape.
52209
- * @returns {IFormControlShapeValue}
53471
+ * Gets or sets the value of the form control shape.
53472
+ * @param {GC.Spread.Sheets.Shapes.IFormControlShapeValue} value The value to set. If omitted, returns the current value.
53473
+ * @returns {GC.Spread.Sheets.Shapes.IFormControlShapeValue} The current value when used as a getter.
52210
53474
  */
52211
- value(v?: GC.Spread.Sheets.Shapes.IFormControlShapeValue): GC.Spread.Sheets.Shapes.IFormControlShapeValue;
53475
+ value(value?: GC.Spread.Sheets.Shapes.IFormControlShapeValue): GC.Spread.Sheets.Shapes.IFormControlShapeValue;
52212
53476
  }
52213
53477
 
52214
53478
  export class GroupShape extends GC.Spread.Sheets.Shapes.ShapeBase{
@@ -53119,12 +54383,12 @@ declare namespace GC{
53119
54383
  */
53120
54384
  remove(name: string): void;
53121
54385
  /**
53122
- * Gets or sets whether to align shape to grid line or the other shapes.
53123
- * @param {GC.Spread.Sheets.SnapMode} value Whether to snap shapes to the grid line or other shapes.
53124
- * @returns {GC.Spread.Sheets.SnapMode | void} If no value is set, returns which snapMode use.
54386
+ * Gets or sets the mode used to snap shapes to grid lines or other shapes.
54387
+ * @param {GC.Spread.Sheets.Shapes.SnapMode} value The snap mode.
54388
+ * @returns {GC.Spread.Sheets.Shapes.SnapMode | void} When called without arguments, returns the current snap mode; otherwise, returns void.
53125
54389
  * @example
53126
54390
  * ```javascript
53127
- * sheet1.shapes.SnapMode(GC.Spread.Sheets.Shapes.SnapMode.grid);
54391
+ * sheet1.shapes.snapMode(GC.Spread.Sheets.Shapes.SnapMode.grid);
53128
54392
  * var snapMode = sheet1.shapes.snapMode();
53129
54393
  * ```
53130
54394
  */
@@ -60078,13 +61342,24 @@ declare namespace GC{
60078
61342
  * @param {number} rowCount The table row count.
60079
61343
  * @param {number} colCount The table column count.
60080
61344
  * @param {string | GC.Spread.Sheets.Tables.TableTheme} style The table style or style name.
60081
- * @param {Object} options The initialization options of the table.
61345
+ * @param {GC.Spread.Sheets.Tables.ITableOptions} options The initialization options of the table.
60082
61346
  * @param {boolean} [options.showHeader] - Whether to display the table header.
60083
61347
  * @param {boolean} [options.showFooter] - Whether to display a footer.
60084
61348
  * @param {boolean} [options.useFooterDropDownList] - whether to use the footer dropdown list for a total row.
60085
61349
  * @param {boolean} [options.showResizeHandle] - Whether to display the resize handle for table.
60086
61350
  */
60087
- constructor(name?: string, row?: number, col?: number, rowCount?: number, colCount?: number, style?: string | GC.Spread.Sheets.Tables.TableTheme);
61351
+ constructor(name?: string, row?: number, col?: number, rowCount?: number, colCount?: number, style?: string | GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions);
61352
+ /**
61353
+ * Adjust the table range with the bound data source. Only work for binding dataManager.
61354
+ * This method adjusts the table row range based on the current bound data row count.
61355
+ * @returns {void}
61356
+ * @example
61357
+ * ```javascript
61358
+ * const table = activeSheet.tables.findByName("Table1");
61359
+ * table.adjustTableRangeForBind();
61360
+ * ```
61361
+ */
61362
+ adjustTableRangeForBind(): void;
60088
61363
  /**
60089
61364
  * Gets or sets the allowAutoExpandState of the table. Whether to allow the table to automatically resize when manipulating data in the worksheet.
60090
61365
  * @param {boolean} allowAutoExpandState The allowAutoExpandState of the table.
@@ -60535,6 +61810,11 @@ declare namespace GC{
60535
61810
  * ```
60536
61811
  */
60537
61812
  insertRows(row: number, count: number, isInsertAfter?: boolean): void;
61813
+ /**
61814
+ * Gets whether the table layout is out of sync with the bound data manager view record count. Only invalid when bound to Remote data.
61815
+ * @returns {boolean} `true` if the bound data manager view record count is different from the table data row count; otherwise, `false`.
61816
+ */
61817
+ isTableLayoutDirty(): boolean;
60538
61818
  /**
60539
61819
  * Gets or sets a style to the table's data area.
60540
61820
  * @param {GC.Spread.Sheets.Tables.ITableLayoutStyle} value a named style or style instance.
@@ -60763,7 +62043,7 @@ declare namespace GC{
60763
62043
  * @param {string | GC.Spread.Sheets.Style} dataStyle the data style of the table column
60764
62044
  * @param {string | GC.Spread.Sheets.Style} footerStyle the footer style of the table column
60765
62045
  */
60766
- constructor(id: number, dataField?: string, name?: string, formatter?: string, cellType?: GC.Spread.Sheets.CellTypes.Base, value?: Function, dataStyle?: string | Style, headerStyle?: string | Style, footerStyle?: string | Style);
62046
+ constructor(id: number, dataField?: string, name?: string, formatter?: string, cellType?: GC.Spread.Sheets.CellTypes.Base, value?: Function, headerStyle?: string | Style, dataStyle?: string | Style, footerStyle?: string | Style);
60767
62047
  /**
60768
62048
  * Gets or sets the table column cellType for custom cell type.
60769
62049
  * @param {GC.Spread.Sheets.CellTypes.Base} value The table column cellType.
@@ -60960,7 +62240,7 @@ declare namespace GC{
60960
62240
  * activeSheet.getCell(1,2).text("T");
60961
62241
  * ```
60962
62242
  */
60963
- add(name?: string, row?: number, column?: number, rowCount?: number, columnCount?: number, style?: string | GC.Spread.Sheets.Tables.TableTheme): GC.Spread.Sheets.Tables.Table;
62243
+ add(name?: string, row?: number, column?: number, rowCount?: number, columnCount?: number, style?: string | GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions): GC.Spread.Sheets.Tables.Table;
60964
62244
  /**
60965
62245
  * Adds a range table with a specified data source to the sheet.
60966
62246
  * @param {string} name The table name.
@@ -62786,25 +64066,85 @@ declare namespace GC{
62786
64066
 
62787
64067
 
62788
64068
  export interface IRowActionOptions{
64069
+ /**
64070
+ * The row action name.
64071
+ */
62789
64072
  name?: string;
64073
+ /**
64074
+ * The row action icon list for different statuses.
64075
+ */
62790
64076
  icons?: (string | GC.Spread.Sheets.ButtonImageType)[];
64077
+ /**
64078
+ * To select an icon for different statuses.
64079
+ */
62791
64080
  iconSelector?: (item: any, index: number, context: any) => number | boolean;
64081
+ /**
64082
+ * To specify the icon size when drawing.
64083
+ */
62792
64084
  iconSize?: number | GC.Spread.Sheets.IImageSize;
64085
+ /**
64086
+ * The tooltip when hover on the row action.
64087
+ */
62793
64088
  tooltip?: string;
64089
+ /**
64090
+ * To specify the shortcut key.
64091
+ */
62794
64092
  shortcutKey?: GC.Spread.Sheets.TableSheet.IShortcutKey;
64093
+ /**
64094
+ * To specify the command name which emit a action.
64095
+ */
62795
64096
  command?: string;
62796
64097
  }
62797
64098
 
62798
64099
 
62799
64100
  export interface IShortcutKey{
64101
+ /**
64102
+ * The shortcut key
64103
+ */
62800
64104
  key?: number;
64105
+ /**
64106
+ * Whether need to combine with Ctrl key
64107
+ */
62801
64108
  ctrl?: boolean;
64109
+ /**
64110
+ * Whether need to combine with Shift key
64111
+ */
62802
64112
  shift?: boolean;
64113
+ /**
64114
+ * Whether need to combine with Alt key
64115
+ */
62803
64116
  alt?: boolean;
64117
+ /**
64118
+ * Whether need to combine with Meta key
64119
+ */
62804
64120
  meta?: boolean;
62805
64121
  }
62806
64122
 
62807
64123
 
64124
+ export interface ITableSheetConditionFilterInfo{
64125
+ field: string;
64126
+ condition: GC.Spread.Sheets.ConditionalFormatting.Condition;
64127
+ }
64128
+
64129
+
64130
+ export interface ITableSheetFilterHierarchyPath{
64131
+ path: any[];
64132
+ type?: GC.Spread.Sheets.TableSheet.TableSheetFilterDataType;
64133
+ }
64134
+
64135
+
64136
+ export interface ITableSheetFilterValue{
64137
+ value: any;
64138
+ type?: GC.Spread.Sheets.TableSheet.TableSheetFilterDataType;
64139
+ }
64140
+
64141
+
64142
+ export interface ITableSheetHierarchyFilterInfo{
64143
+ field: string;
64144
+ paths: GC.Spread.Sheets.TableSheet.ITableSheetFilterHierarchyPath[];
64145
+ }
64146
+
64147
+
62808
64148
  export interface ITableSheetOptions{
62809
64149
  /**
62810
64150
  * Whether to allow to add new empty row.
@@ -62856,6 +64196,35 @@ declare namespace GC{
62856
64196
  groupLayout?: GC.Spread.Sheets.TableSheet.IGroupLayoutOptions;
62857
64197
  }
62858
64198
 
64199
+
64200
+ export interface ITableSheetSortInfo{
64201
+ field: string;
64202
+ ascending?: boolean;
64203
+ compare?: string | ((item1: any, item2: any, ascending: boolean) => number);
64204
+ }
64205
+
64206
+
64207
+ export interface ITableSheetValueFilterInfo{
64208
+ field: string;
64209
+ values: GC.Spread.Sheets.TableSheet.ITableSheetFilterValue[];
64210
+ }
64211
+
64212
+
64213
+ /**
64214
+ * @typedef GC.Spread.Sheets.TableSheet.ITableSheetFilterInfo
64215
+ * @type {GC.Spread.Sheets.TableSheet.ITableSheetValueFilterInfo | GC.Spread.Sheets.TableSheet.ITableSheetHierarchyFilterInfo | GC.Spread.Sheets.TableSheet.ITableSheetConditionFilterInfo}
64216
+ */
64217
+ export type ITableSheetFilterInfo =
64218
+ GC.Spread.Sheets.TableSheet.ITableSheetValueFilterInfo | GC.Spread.Sheets.TableSheet.ITableSheetHierarchyFilterInfo | GC.Spread.Sheets.TableSheet.ITableSheetConditionFilterInfo
64219
+
64220
+
64221
+ /**
64222
+ * @typedef GC.Spread.Sheets.TableSheet.TableSheetFilterDataType
64223
+ * @type {"value" | "date" | "blank"}
64224
+ */
64225
+ export type TableSheetFilterDataType =
64226
+ "value" | "date" | "blank"
64227
+
62859
64228
  /**
62860
64229
  * Represents which row action is operated.
62861
64230
  * @enum {number}
@@ -63244,7 +64613,7 @@ declare namespace GC{
63244
64613
  collapseAllHierarchyLevels(): void;
63245
64614
  /**
63246
64615
  * Gets or sets the current theme for the sheet.
63247
- * @param {string|GC.Spread.Common.Theme} value The theme name or the theme.
64616
+ * @param {string|GC.Spread.Sheets.Theme} value The theme name or the theme.
63248
64617
  * @returns {GC.Spread.Sheets.Theme|void} If no value is set, returns the current theme; otherwise, returns void.
63249
64618
  * @example
63250
64619
  * ```javascript
@@ -63320,6 +64689,18 @@ declare namespace GC{
63320
64689
  * ```
63321
64690
  */
63322
64691
  expandHierarchyLevel(level: number): void;
64692
+ /**
64693
+ * Gets or sets the active filters of the table sheet.
64694
+ * @param {GC.Spread.Sheets.TableSheet.ITableSheetFilterInfo[]} filterInfos The filter definitions.
64695
+ * @returns {GC.Spread.Sheets.TableSheet.ITableSheetFilterInfo[]} Returns the active filter definitions.
64696
+ * @example
64697
+ * ```javascript
64698
+ * //This example uses the filter method.
64699
+ * tableSheet.filter([{field: 'state', values: [{value: 'New York'}]}]);
64700
+ * let filterInfos = tableSheet.filter();
64701
+ * ```
64702
+ */
64703
+ filter(filterInfos?: GC.Spread.Sheets.TableSheet.ITableSheetFilterInfo[]): GC.Spread.Sheets.TableSheet.ITableSheetFilterInfo[];
63323
64704
  /**
63324
64705
  * Gets the changes of data manager in autoSync or batch mode.
63325
64706
  * @returns {GC.Spread.Sheets.TableSheet.IDataViewChanges[]} Returns a object array, each object could contain "type", "dataItem", "oldDataItem", "column", "originalColumn", and "index".
@@ -63444,6 +64825,15 @@ declare namespace GC{
63444
64825
  * ```
63445
64826
  */
63446
64827
  promoteHierarchyLevel(row: number): void;
64828
+ /**
64829
+ * Remove the active filters of the table sheet.
64830
+ * @example
64831
+ * ```javascript
64832
+ * //This example uses the removeFilter method.
64833
+ * tableSheet.removeFilter();
64834
+ * ```
64835
+ */
64836
+ removeFilter(): void;
63447
64837
  /**
63448
64838
  * remove group status of the table sheet
63449
64839
  * @returns {void}
@@ -63466,6 +64856,15 @@ declare namespace GC{
63466
64856
  * ```
63467
64857
  */
63468
64858
  removeRow(row: number): Promise<void>;
64859
+ /**
64860
+ * Remove the active sorts of the table sheet.
64861
+ * @example
64862
+ * ```javascript
64863
+ * //This example uses the removeSort method.
64864
+ * tableSheet.removeSort();
64865
+ * ```
64866
+ */
64867
+ removeSort(): void;
63469
64868
  /**
63470
64869
  * Resets the changes of the specified row of table sheet.
63471
64870
  * @param {number} row - The row index.
@@ -63539,6 +64938,18 @@ declare namespace GC{
63539
64938
  * ```
63540
64939
  */
63541
64940
  setDefaultRowHeight(value: number, sheetArea?: GC.Spread.Sheets.SheetArea): void;
64941
+ /**
64942
+ * Gets or sets the active sorts of the table sheet.
64943
+ * @param {GC.Spread.Sheets.TableSheet.ITableSheetSortInfo[]} sortInfos The sort definitions.
64944
+ * @returns {GC.Spread.Sheets.TableSheet.ITableSheetSortInfo[]} Returns the active sort definitions.
64945
+ * @example
64946
+ * ```javascript
64947
+ * //This example uses the sort method.
64948
+ * tableSheet.sort([{field: 'state', ascending: true}]);
64949
+ * let sortInfos = tableSheet.sort();
64950
+ * ```
64951
+ */
64952
+ sort(sortInfos?: GC.Spread.Sheets.TableSheet.ITableSheetSortInfo[]): GC.Spread.Sheets.TableSheet.ITableSheetSortInfo[];
63542
64953
  /**
63543
64954
  * Submits the changes of data manager to server in batch mode, including updated rows, inserted rows and deleted rows.
63544
64955
  * @example
@@ -63550,7 +64961,7 @@ declare namespace GC{
63550
64961
  submitChanges(): Promise<void>;
63551
64962
  /**
63552
64963
  * Pin or unpin columns with specified column index array.
63553
- * @param {number} index - The array of column indexes to do pin or unpin.
64964
+ * @param {number[]} indexes - The array of column indexes to do pin or unpin.
63554
64965
  * @returns {number} Returns the count of the pinned columns.
63555
64966
  * @example
63556
64967
  * ```javascript
@@ -63558,10 +64969,10 @@ declare namespace GC{
63558
64969
  * tableSheet.togglePinnedColumns([1,2,4]);
63559
64970
  * ```
63560
64971
  */
63561
- togglePinnedColumns(index: number[]): void;
64972
+ togglePinnedColumns(indexes: number[]): number;
63562
64973
  /**
63563
64974
  * Pin or unpin rows with specified row index array.
63564
- * @param {number} index - The array of row indexes to do pin or unpin.
64975
+ * @param {number[]} indexes - The array of row indexes to do pin or unpin.
63565
64976
  * @returns {number} Returns the count of the pinned rows.
63566
64977
  * @example
63567
64978
  * ```javascript
@@ -63633,14 +65044,14 @@ declare namespace GC{
63633
65044
  namespace ThreadedComments{
63634
65045
 
63635
65046
  export interface ILinkBlock{
63636
- type: GC.Spread.Sheets.ThreadedComments.ContentType;
65047
+ type: GC.Spread.Sheets.ThreadedComments.ContentType.link;
63637
65048
  href: string;
63638
65049
  text: string;
63639
65050
  }
63640
65051
 
63641
65052
 
63642
65053
  export interface IMentionBlock{
63643
- type: GC.Spread.Sheets.ThreadedComments.ContentType;
65054
+ type: GC.Spread.Sheets.ThreadedComments.ContentType.mention;
63644
65055
  /**
63645
65056
  * the mentioned user id
63646
65057
  */
@@ -63656,7 +65067,7 @@ declare namespace GC{
63656
65067
 
63657
65068
 
63658
65069
  export interface ITextBlock{
63659
- type:GC.Spread.Sheets.ThreadedComments.ContentType;
65070
+ type:GC.Spread.Sheets.ThreadedComments.ContentType.text;
63660
65071
  value:string;
63661
65072
  }
63662
65073
 
@@ -64273,6 +65684,10 @@ declare namespace GC{
64273
65684
 
64274
65685
  export interface ISlicerDataItem{
64275
65686
  columnName: string;
65687
+ /**
65688
+ * @deprecated
65689
+ */
65690
+ rowIndex: number;
64276
65691
  row: number;
64277
65692
  data: any;
64278
65693
  }