@mescius/spread-sheets 18.1.4 → 18.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.
@@ -2023,7 +2023,6 @@ declare module GC{
2023
2023
  /**
2024
2024
  * @typedef GC.Data.ISchemaOption - The data source schema options.
2025
2025
  * @property {string} type - Supports 'json', 'csv', 'xml', 'columnJson'.
2026
- * @property {string} countPath - Data reader use this to get data source collection length, return the current data source collection length if this is not specified.
2027
2026
  * @property {string} dataPath - Data reader use this to get data source collection after parse, return entire parsed object if this is not specified.
2028
2027
  * @property {GC.Data.IColumnCollection} columns - The definitions of all columns of current table.
2029
2028
  * @property {GC.Data.IFormulaCollection} window - The definitions of all formulas of window chaining.
@@ -2035,10 +2034,6 @@ declare module GC{
2035
2034
  * Supports 'json', 'csv', 'xml', 'columnJson'.
2036
2035
  */
2037
2036
  type?: string;
2038
- /**
2039
- * Data reader use this to get data source collection length, return the current data source collection length if this is not specified.
2040
- */
2041
- countPath?: string;
2042
2037
  /**
2043
2038
  * Data reader use this to get data source collection after parse, return entire parsed object if this is not specified.
2044
2039
  */
@@ -5576,6 +5571,19 @@ declare module GC{
5576
5571
  * The formats in special category.
5577
5572
  */
5578
5573
  };
5574
+ shortcut?: {
5575
+ Number?: string;
5576
+ Currency?: string;
5577
+ Accounting?: string;
5578
+ ShortDate?: string;
5579
+ LongDate?: string;
5580
+ Time?: string;
5581
+ Percentage?: string;
5582
+ Fraction?: string;
5583
+ Scientific?: string;
5584
+ Text?: string;
5585
+ Comma?: string;
5586
+ };
5579
5587
  }
5580
5588
 
5581
5589
 
@@ -6894,7 +6902,7 @@ declare module GC{
6894
6902
  * let pivotTableStyle = spread.customPivotTableThemes.add("custom0");
6895
6903
  * let wholeTableStyle = new GC.Spread.Pivot.PivotTableStyle();
6896
6904
  * wholeTableStyle.backColor = "#0C66E4";
6897
- * tableStyle.wholeTableStyle(wholeTableStyle);
6905
+ * pivotTableStyle.wholeTableStyle(wholeTableStyle);
6898
6906
  * ```
6899
6907
  */
6900
6908
  add(theme: string | GC.Spread.Pivot.PivotTableTheme): GC.Spread.Pivot.PivotTableTheme | undefined;
@@ -7904,9 +7912,9 @@ declare module GC{
7904
7912
  * var layout = GC.Spread.Pivot.PivotTableLayoutType.compact;
7905
7913
  * var theme = GC.Spread.Pivot.PivotTableThemes.medium2;
7906
7914
  * var pivotTable = sheet.pivotTables.add("pivotTable1", 'sourceData', 1, 1, layout, theme);
7907
- * pivotTable.addCalcField("Amount", "PercentOfEach", "=Amount/454");
7915
+ * pivotTable.addCalcField("PercentOfEach", "=Amount/454");
7908
7916
  * var calcFieldsInfo = pivotTable.getCalcFields();
7909
- * pivotTable.removeCalcField(calcFieldsInfo[i].fieldName);
7917
+ * pivotTable.removeCalcField(calcFieldsInfo[0].fieldName);
7910
7918
  * ```
7911
7919
  */
7912
7920
  removeCalcField(fieldName: string): void;
@@ -11326,6 +11334,8 @@ declare module GC{
11326
11334
  export interface IReportOptions{
11327
11335
  dirtyStyle?: GC.Spread.Sheets.Style;
11328
11336
  printAllPages?: boolean;
11337
+ showHiddenRowCol?: boolean;
11338
+ hiddenRowColStyle?: GC.Spread.Sheets.Style;
11329
11339
  }
11330
11340
 
11331
11341
 
@@ -11701,6 +11711,8 @@ declare module GC{
11701
11711
  * @type {Object}
11702
11712
  * @property {GC.Spread.Sheets.Style} [dirtyStyle] The style will be used to paint the modified cells in the preview mode.
11703
11713
  * @property {boolean} [printAllPages] Indicates whether print all pages.
11714
+ * @property {boolean} [showHiddenRowCol] Indicates whether to show hidden rows or columns.
11715
+ * @property {GC.Spread.Sheets.Style} [hiddenRowColStyle] This style will be used to style the header when displaying hidden rows and columns.
11704
11716
  */
11705
11717
  options: GC.Spread.Report.IReportOptions;
11706
11718
  /**
@@ -12942,7 +12954,7 @@ declare module GC{
12942
12954
 
12943
12955
 
12944
12956
  export interface ICommandMetaData{
12945
- viewModePermission: GC.Spread.Sheets.Collaboration.PermissionTypes;
12957
+ viewModePermissions: GC.Spread.Sheets.Collaboration.PermissionTypes;
12946
12958
  }
12947
12959
 
12948
12960
 
@@ -12951,6 +12963,8 @@ declare module GC{
12951
12963
  sheetName: string;
12952
12964
  comment: Comments.Comment;
12953
12965
  propertyName: string;
12966
+ row: number;
12967
+ col: number;
12954
12968
  }
12955
12969
 
12956
12970
 
@@ -12958,6 +12972,8 @@ declare module GC{
12958
12972
  sheet: GC.Spread.Sheets.Worksheet;
12959
12973
  sheetName: string;
12960
12974
  comment: Comments.Comment;
12975
+ row: number;
12976
+ col: number;
12961
12977
  }
12962
12978
 
12963
12979
 
@@ -12966,6 +12982,8 @@ declare module GC{
12966
12982
  sheetName: string;
12967
12983
  comment: Comments.Comment;
12968
12984
  cancel: boolean;
12985
+ row: number;
12986
+ col: number;
12969
12987
  }
12970
12988
 
12971
12989
 
@@ -14639,6 +14657,15 @@ declare module GC{
14639
14657
  string|number|boolean|Date
14640
14658
 
14641
14659
 
14660
+ /**
14661
+ * @typedef GC.Spread.Sheets.ExcelFileType
14662
+ * @type {"XLSX" | "XLSM" | "XLTM"}
14663
+ * @description Represents the fileType of Excel.
14664
+ */
14665
+ export type ExcelFileType =
14666
+ "XLSX" | "XLSM" | "XLTM"
14667
+
14668
+
14642
14669
  /**
14643
14670
  * @typedef GC.Spread.Sheets.ExportCsvOptions
14644
14671
  * @property {GC.Spread.Sheets.FileType} fileType - The file type.
@@ -14713,7 +14740,9 @@ declare module GC{
14713
14740
  * @property {boolean} [includeUnusedNames] - Whether to include the unused custom name when do save, default true.
14714
14741
  * @property {boolean} [exportSharedFormula] - Whether to include the shared formula when do save, default true.
14715
14742
  * @property {boolean} [includeEmptyRegionCells] - Whether to include any empty cells(cells with no data or only style) outside the used data range, default true.
14743
+ * @property {boolean} [losslessEditing] - Whether to include lossless editing content, default true.
14716
14744
  * @property {string} [password] - Set the password to open the workbook.
14745
+ * @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The exporting excel file type ('XLSX' | 'XLSM' | 'XLTM'), default by XLSX.
14717
14746
  */
14718
14747
  export type ExportXlsxOptions =
14719
14748
  {
@@ -14728,7 +14757,9 @@ declare module GC{
14728
14757
  includeEmptyRegionCells?: boolean;
14729
14758
  includeAutoMergedCells?: boolean;
14730
14759
  includeCalcModelCache?: boolean;
14760
+ losslessEditing?: boolean;
14731
14761
  password?: string;
14762
+ excelFileType?: GC.Spread.Sheets.ExcelFileType;
14732
14763
  }
14733
14764
 
14734
14765
 
@@ -14815,6 +14846,7 @@ declare module GC{
14815
14846
  * @property {string} [password] - The password to open the workbook.
14816
14847
  * @property {GC.Spread.Sheets.OpenMode} [openMode] - The open mode of normal, lazy and incremental. By default is normal.
14817
14848
  * @property {GC.Spread.Sheets.ProgressFunctionType} [progress] - The progress callback function for each open mode.
14849
+ * @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The importing excel file type ('XLSX' | 'XLSM' | 'XLTM'), default by XLSX.
14818
14850
  */
14819
14851
  export type ImportXlsxOptions =
14820
14852
  {
@@ -14831,6 +14863,7 @@ declare module GC{
14831
14863
  password?: string;
14832
14864
  openMode?: GC.Spread.Sheets.OpenMode;
14833
14865
  progress?: GC.Spread.Sheets.ProgressFunctionType;
14866
+ excelFileType?: GC.Spread.Sheets.ExcelFileType;
14834
14867
  }
14835
14868
 
14836
14869
 
@@ -16378,7 +16411,11 @@ declare module GC{
16378
16411
  /**
16379
16412
  * Divide the values in the paste ranges by the values in the copy ranges.
16380
16413
  */
16381
- divide= 4
16414
+ divide= 4,
16415
+ /**
16416
+ * Transform the values in the paste ranges by the formula in the copy ranges.
16417
+ */
16418
+ transform= 5
16382
16419
  }
16383
16420
 
16384
16421
  /**
@@ -17028,6 +17065,29 @@ declare module GC{
17028
17065
  rightToLeft= 2
17029
17066
  }
17030
17067
 
17068
+ /**
17069
+ * Specifies the scope of transform.
17070
+ * @enum {number}
17071
+ */
17072
+ export enum TransformScope{
17073
+ /**
17074
+ * Each cell is considered as a transformation unit.
17075
+ */
17076
+ byCell= 0,
17077
+ /**
17078
+ * Each row is considered as a transformation unit.
17079
+ */
17080
+ byRow= 1,
17081
+ /**
17082
+ * Each column is considered as a transformation unit.
17083
+ */
17084
+ byColumn= 2,
17085
+ /**
17086
+ * The entire cell range is considered as one transformation unit.
17087
+ */
17088
+ byRange= 3
17089
+ }
17090
+
17031
17091
  /**
17032
17092
  * Worksheet used range
17033
17093
  * @enum {number}
@@ -24553,7 +24613,7 @@ declare module GC{
24553
24613
  addSpans(spans: GC.Spread.Sheets.IRange[], sheetArea?: GC.Spread.Sheets.SheetArea): void;
24554
24614
  /**
24555
24615
  * Automatically fits the viewport column.
24556
- * @param {number} column The column index.
24616
+ * @property {number} column The column index.
24557
24617
  * @example
24558
24618
  * ```javascript
24559
24619
  * //This example sets the column width based on the text.
@@ -24564,7 +24624,7 @@ declare module GC{
24564
24624
  autoFitColumn(column: number): void;
24565
24625
  /**
24566
24626
  * Automatically fits the viewport row.
24567
- * @param {number} row The row index.
24627
+ * @property {number} row The row index.
24568
24628
  * @example
24569
24629
  * ```javascript
24570
24630
  * //This example sets the row height based on the text.
@@ -25183,12 +25243,12 @@ declare module GC{
25183
25243
  getColumnWidth(col: number, sheetArea?: GC.Spread.Sheets.SheetArea, getDynamicSize?: boolean): any;
25184
25244
  /**
25185
25245
  * Gets delimited text from a range.
25186
- * @param {number} row The start row.
25187
- * @param {number} column The start column.
25188
- * @param {number} rowCount The row count.
25189
- * @param {number} columnCount The column count.
25190
- * @param {string} rowDelimiter The row delimiter that is appended to the end of the row.
25191
- * @param {string} columnDelimiter The column delimiter that is appended to the end of the column.
25246
+ * @property {number} row The start row.
25247
+ * @property {number} column The start column.
25248
+ * @property {number} rowCount The row count.
25249
+ * @property {number} columnCount The column count.
25250
+ * @property {string} rowDelimiter The row delimiter that is appended to the end of the row.
25251
+ * @property {string} columnDelimiter The column delimiter that is appended to the end of the column.
25192
25252
  * @returns {string} The text from the range with the specified delimiters.
25193
25253
  */
25194
25254
  getCsv(row: number, column: number, rowCount: number, columnCount: number, rowDelimiter: string, columnDelimiter: string): string;
@@ -25441,6 +25501,11 @@ declare module GC{
25441
25501
  * ```
25442
25502
  */
25443
25503
  getHyperlink(row: number, col: number, sheetArea?: GC.Spread.Sheets.SheetArea): GC.Spread.Sheets.IHyperlink;
25504
+ /**
25505
+ * Get the id of the worksheet
25506
+ * @returns {string} The id of the worksheet
25507
+ */
25508
+ getId(): string;
25444
25509
  /**
25445
25510
  * Gets the inserted row collection.
25446
25511
  * @returns {Object[]} The inserted rows collection, the item in array contains two properties, row.row: specifies insert row index, row.item: specifies insert data item.
@@ -25860,7 +25925,7 @@ declare module GC{
25860
25925
  groupSparkline(sparklines: Sparklines.Sparkline[]): GC.Spread.Sheets.Sparklines.SparklineGroup;
25861
25926
  /**
25862
25927
  * Get whether worksheet has set a password for protection.
25863
- * @param {string} password Sheet protection password.
25928
+ * @property {string} password Sheet protection password.
25864
25929
  * @returns {boolean} Returns true if the password is set, otherwise false
25865
25930
  * @example
25866
25931
  * ```javascript
@@ -25997,7 +26062,7 @@ declare module GC{
25997
26062
  printInfo(value?: GC.Spread.Sheets.Print.PrintInfo): any;
25998
26063
  /**
25999
26064
  * Protects a worksheet. Do nothing if the worksheet has already been protected.
26000
- * @param {string} password Sheet protection password.
26065
+ * @property {string} password Sheet protection password.
26001
26066
  * @example
26002
26067
  * ```javascript
26003
26068
  * let password = "fe4c4be8"
@@ -26034,8 +26099,8 @@ declare module GC{
26034
26099
  * myfunc.prototype.evaluate = function (args) {
26035
26100
  * return 100;
26036
26101
  * }
26037
- * spread.addCustomFunction(new myfunc());
26038
- * //spread.removeCustomFunction("myfunc");
26102
+ * activeSheet.addCustomFunction(new myfunc());
26103
+ * activeSheet.removeCustomFunction("myfunc");
26039
26104
  * ```
26040
26105
  */
26041
26106
  removeCustomFunction(name: string): void;
@@ -26452,11 +26517,11 @@ declare module GC{
26452
26517
  setColumnWidth(col: number, value: number | string, sheetArea?: GC.Spread.Sheets.SheetArea): void;
26453
26518
  /**
26454
26519
  * Sets delimited text (CSV) in the sheet.
26455
- * @param {number} row The start row.
26456
- * @param {number} column The start column.
26457
- * @param {string} text The delimited text.
26458
- * @param {string} rowDelimiter The row delimiter.
26459
- * @param {string} columnDelimiter The column delimiter.
26520
+ * @property {number} row The start row.
26521
+ * @property {number} column The start column.
26522
+ * @property {string} text The delimited text.
26523
+ * @property {string} rowDelimiter The row delimiter.
26524
+ * @property {string} columnDelimiter The column delimiter.
26460
26525
  */
26461
26526
  setCsv(row: number, column: number, text: string, rowDelimiter: string, columnDelimiter: string): void;
26462
26527
  /**
@@ -26549,13 +26614,16 @@ declare module GC{
26549
26614
  * Sets a formula in a specified cell in the specified sheet area.
26550
26615
  * @param {number} row The row index.
26551
26616
  * @param {number} col The column index.
26552
- * @param {string|null} value The formula to place in the specified cell.
26553
- * @param {GC.Spread.Sheets.SheetArea} [sheetArea] The sheet area. If you do not provide this parameter, it defaults to `viewport`.
26617
+ * @param {string|null} value The formula to place in the specified cell. If `null`, the formula in the cell will be cleared.
26618
+ * @param {GC.Spread.Sheets.SheetArea} [sheetArea] The sheet area. If not provided, defaults to `viewport`.
26554
26619
  * @example
26555
26620
  * ```javascript
26556
- * //This example sets the formula for the specified cell.
26621
+ * // This example sets the formula for the specified cell.
26557
26622
  * activeSheet.setValue(0, 2, 3);
26558
- * activeSheet.setFormula(1,1,"C1+D1",GC.Spread.Sheets.SheetArea.viewport);
26623
+ * activeSheet.setFormula(1, 1, "C1+D1");
26624
+ *
26625
+ * // This example clears the formula in the specified cell.
26626
+ * activeSheet.setFormula(1, 1, null);
26559
26627
  * ```
26560
26628
  */
26561
26629
  setFormula(row: number, col: number, value: string | null, sheetArea?: GC.Spread.Sheets.SheetArea): void;
@@ -27056,7 +27124,7 @@ declare module GC{
27056
27124
  ungroupSparkline(group: GC.Spread.Sheets.Sparklines.SparklineGroup): void;
27057
27125
  /**
27058
27126
  * Unprotects a worksheet.
27059
- * @param {string} password Sheet protection password.
27127
+ * @property {string} password Sheet protection password.
27060
27128
  * @returns {boolean} Return true if password is correct or isProtect is false, otherwise return false.
27061
27129
  * @example
27062
27130
  * ```javascript
@@ -27398,6 +27466,23 @@ declare module GC{
27398
27466
  * @returns {object} The evaluated formula result.
27399
27467
  */
27400
27468
  function evaluateFormula(context: Object, formula: string, baseRow?: number, baseColumn?: number, useR1C1?: boolean, preserveArrayResult?: boolean): any;
27469
+ /**
27470
+ * Evaluates the specified formula and return a promise of the formula result.
27471
+ * @param {object} context The evaluation context; in general, you should use the active sheet object.
27472
+ * @param {formula} string The formula string.
27473
+ * @param {number} [baseRow] The base row index of the formula.
27474
+ * @param {number} [baseColumn] The base column index of the formula.
27475
+ * @example
27476
+ * ```javascript
27477
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
27478
+ * sheet = spread.getSheet(0);
27479
+ * sheet.setValue(0, 0, 1);
27480
+ * // Using evaluateFormulaAsync() method to evaluate formula without setting formula in sheet's cell
27481
+ * GC.Spread.Sheets.CalcEngine.evaluateFormulaAsync(sheet, 'WEBSERVICE("http://*.com/name/"&A1)', 0, 0).then(function (result) {console.log(result)});
27482
+ * ```
27483
+ * @returns {Promise<any>} The Promise of formula result.
27484
+ */
27485
+ function evaluateFormulaAsync(context: Object, formula: string, baseRow?: number, baseColumn?: number): Promise<any>;
27401
27486
  /**
27402
27487
  * Unparse the specified expression tree to formula string.
27403
27488
  * @param {object} context The context; in general, you should use the active sheet object.
@@ -27676,6 +27761,21 @@ declare module GC{
27676
27761
  vertical?: number;
27677
27762
  }
27678
27763
 
27764
+
27765
+ export interface IToggleOptions{
27766
+ width?: number;
27767
+ height?: number;
27768
+ trackColorOn?: string;
27769
+ trackColorOff?: string;
27770
+ sliderColorOn?: string;
27771
+ sliderColorOff?: string;
27772
+ sliderMargin?: number;
27773
+ animationDuration?: number;
27774
+ trackRadius?: number;
27775
+ sliderRadius?: number;
27776
+ autoSize?: boolean;
27777
+ }
27778
+
27679
27779
  /**
27680
27780
  * Specifies the text alignment for check box cells.
27681
27781
  * @enum {number}
@@ -27709,7 +27809,11 @@ declare module GC{
27709
27809
  /**
27710
27810
  * Specifies text is to the right of the check box.
27711
27811
  */
27712
- right= 3
27812
+ right= 3,
27813
+ /**
27814
+ * Specifies text is inside the toggle button.
27815
+ */
27816
+ inside= 4
27713
27817
  }
27714
27818
 
27715
27819
  /**
@@ -27894,7 +27998,11 @@ declare module GC{
27894
27998
  /**
27895
27999
  * Specifies text is on the right.
27896
28000
  */
27897
- right= 3
28001
+ right= 3,
28002
+ /**
28003
+ * Specifies text is inside the toggle button.
28004
+ */
28005
+ inside= 4
27898
28006
  }
27899
28007
 
27900
28008
 
@@ -28518,6 +28626,23 @@ declare module GC{
28518
28626
  * ```
28519
28627
  */
28520
28628
  isThreeState(value?: boolean): any;
28629
+ /**
28630
+ * Gets or sets a value that indicates the mode of the checkbox cell type.
28631
+ * @param {'checkbox' | 'toggle'} value The mode of the checkbox cell type.
28632
+ * @returns {'checkbox' | 'toggle' | GC.Spread.Sheets.CellTypes.CheckBox} If no value is set, returns the mode of the checkbox cell type.
28633
+ * @example
28634
+ * ```javascript
28635
+ * // This example creates a check box cell.
28636
+ * var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
28637
+ * cellType1.caption("caption");
28638
+ * cellType1.textTrue("true");
28639
+ * cellType1.textFalse("false");
28640
+ * cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
28641
+ * cellType1.mode("toggle");
28642
+ * activeSheet.getCell(1, 1).cellType(cellType1);
28643
+ * ```
28644
+ */
28645
+ mode(value?: 'checkbox' | 'toggle'): any;
28521
28646
  /**
28522
28647
  * Gets or sets the text alignment relative to the check box.
28523
28648
  * @param {GC.Spread.Sheets.CellTypes.CheckBoxTextAlign} value The text alignment relative to the check box.
@@ -28594,6 +28719,35 @@ declare module GC{
28594
28719
  * ```
28595
28720
  */
28596
28721
  textTrue(value?: string): any;
28722
+ /**
28723
+ * Gets or sets a value that indicates the toggle options
28724
+ * @param {GC.Spread.Sheets.CellTypes.IToggleOptions} value The toggle options.
28725
+ * @returns {GC.Spread.Sheets.CellTypes.IToggleOptions | GC.Spread.Sheets.CellTypes.CheckBox} If no value is set, returns the toggle options.
28726
+ * @example
28727
+ * ```javascript
28728
+ * // This example creates a check box cell.
28729
+ * var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
28730
+ * cellType1.caption("caption");
28731
+ * cellType1.textTrue("ON");
28732
+ * cellType1.textFalse("OFF");
28733
+ * cellType1.mode("toggle");
28734
+ * cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.inside);
28735
+ * cellType1.toggleOptions({
28736
+ * width: 60,
28737
+ * height: 30,
28738
+ * trackColorOn: '#4CAF50',
28739
+ * trackColorOff: '#767577',
28740
+ * sliderColorOn: '#ffffff',
28741
+ * sliderColorOff: '#ffffff',
28742
+ * sliderMargin: 2,
28743
+ * animationDuration: 100,
28744
+ * trackRadius: 8,
28745
+ * sliderRadius: 4
28746
+ * });
28747
+ * activeSheet.getCell(1, 1).cellType(cellType1);
28748
+ * ```
28749
+ */
28750
+ toggleOptions(value?: GC.Spread.Sheets.CellTypes.IToggleOptions): any;
28597
28751
  }
28598
28752
 
28599
28753
  export class CheckBoxList extends Base{
@@ -28709,6 +28863,20 @@ declare module GC{
28709
28863
  * ```
28710
28864
  */
28711
28865
  maxRowCount(value?: number): any;
28866
+ /**
28867
+ * Gets or sets a value that indicates the mode of the checkbox list cell type.
28868
+ * @param {'checkbox' | 'toggle'} value The mode of the checkbox list cell type.
28869
+ * @returns {'checkbox' | 'toggle' | GC.Spread.Sheets.CellTypes.CheckBoxList} If no value is set, returns the mode of the checkbox list cell type.
28870
+ * @example
28871
+ * ```javascript
28872
+ * // This example creates a check box list cell.
28873
+ * var cellType = new GC.Spread.Sheets.CellTypes.CheckBoxList();
28874
+ * cellType.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
28875
+ * cellType.mode("toggle");
28876
+ * activeSheet.getCell(2, 2).cellType(cellType);
28877
+ * ```
28878
+ */
28879
+ mode(value?: 'checkbox' | 'toggle'): any;
28712
28880
  /**
28713
28881
  * Gets or sets the text of checkbox's position, only support left and right .
28714
28882
  * @param {GC.Spread.Sheets.CellTypes.TextAlign} value the text of checkbox's position.
@@ -28723,6 +28891,32 @@ declare module GC{
28723
28891
  * ```
28724
28892
  */
28725
28893
  textAlign(value?: GC.Spread.Sheets.CellTypes.TextAlign): any;
28894
+ /**
28895
+ * Gets or sets a value that indicates the toggle options
28896
+ * @param {GC.Spread.Sheets.CellTypes.IToggleOptions} value The toggle options.
28897
+ * @returns {GC.Spread.Sheets.CellTypes.IToggleOptions | GC.Spread.Sheets.CellTypes.CheckBoxList} If no value is set, returns the toggle options.
28898
+ * @example
28899
+ * ```javascript
28900
+ * // This example creates a check box list cell.
28901
+ * var cellType = new GC.Spread.Sheets.CellTypes.CheckBoxList();
28902
+ * cellType.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
28903
+ * cellType.mode("toggle");
28904
+ * cellType.toggleOptions({
28905
+ * width: 60,
28906
+ * height: 30,
28907
+ * trackColorOn: '#4CAF50',
28908
+ * trackColorOff: '#767577',
28909
+ * sliderColorOn: '#ffffff',
28910
+ * sliderColorOff: '#ffffff',
28911
+ * sliderMargin: 2,
28912
+ * animationDuration: 100,
28913
+ * trackRadius: 8,
28914
+ * sliderRadius: 4
28915
+ * });
28916
+ * activeSheet.getCell(2, 2).cellType(cellType);
28917
+ * ```
28918
+ */
28919
+ toggleOptions(value?: GC.Spread.Sheets.CellTypes.IToggleOptions): any;
28726
28920
  }
28727
28921
 
28728
28922
  export class ColumnHeader extends Base{
@@ -31681,7 +31875,7 @@ declare module GC{
31681
31875
  * // This example shows how to add a new series.
31682
31876
  * var dataRange = "A1:D4";
31683
31877
  * var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
31684
- * chart.series.add({
31878
+ * chart.series().add({
31685
31879
  * chartType: GC.Spread.Sheets.Charts.ChartType.columnClustered,
31686
31880
  * axisGroup: GC.Spread.Sheets.Charts.AxisGroup.primary,
31687
31881
  * backColor: {
@@ -31715,7 +31909,7 @@ declare module GC{
31715
31909
  * // This example shows how to remove a specified series.
31716
31910
  * var dataRange = "A1:D4";
31717
31911
  * var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
31718
- * chart.series.remove(0);
31912
+ * chart.series().remove(0);
31719
31913
  * ```
31720
31914
  */
31721
31915
  remove(index: number): void;
@@ -32008,10 +32202,6 @@ declare module GC{
32008
32202
  * setFrozen
32009
32203
  */
32010
32204
  setFrozen= 43,
32011
- /**
32012
- * setFreeAreaCount
32013
- */
32014
- setFreeAreaCount= 44,
32015
32205
  /**
32016
32206
  * setAxisSize
32017
32207
  */
@@ -32024,10 +32214,6 @@ declare module GC{
32024
32214
  * setAxisOptions
32025
32215
  */
32026
32216
  setAxisOptions= 47,
32027
- /**
32028
- * setHeaderFitMode
32029
- */
32030
- setHeaderFitMode= 48,
32031
32217
  /**
32032
32218
  * setWorksheetOptions
32033
32219
  */
@@ -32056,6 +32242,38 @@ declare module GC{
32056
32242
  * setWorkbookProperty
32057
32243
  */
32058
32244
  setWorkbookProperty= 55,
32245
+ /**
32246
+ * setSheetBackgroundImage
32247
+ */
32248
+ setSheetBackgroundImage= 56,
32249
+ /**
32250
+ * setCustomFunction
32251
+ */
32252
+ setCustomFunction= 57,
32253
+ /**
32254
+ * setSheetScopeCustomFunction
32255
+ */
32256
+ setSheetScopeCustomFunction= 58,
32257
+ /**
32258
+ * clearCustomFunction
32259
+ */
32260
+ clearCustomFunction= 59,
32261
+ /**
32262
+ * clearSheetScopeCustomFunction
32263
+ */
32264
+ clearSheetScopeCustomFunction= 60,
32265
+ /**
32266
+ * updateSheetDefaultsOptions
32267
+ */
32268
+ updateSheetDefaultsOptions= 61,
32269
+ /**
32270
+ * setFormatStringName
32271
+ */
32272
+ setFormatStringName= 62,
32273
+ /**
32274
+ * clearFormatStringName
32275
+ */
32276
+ clearFormatStringName= 63,
32059
32277
  /**
32060
32278
  * addExternalReference
32061
32279
  */
@@ -32076,14 +32294,6 @@ declare module GC{
32076
32294
  * setFilter
32077
32295
  */
32078
32296
  setFilter= 121,
32079
- /**
32080
- * filterItemMap
32081
- */
32082
- filterItemMap= 122,
32083
- /**
32084
- * filteredColumns
32085
- */
32086
- filteredColumns= 123,
32087
32297
  /**
32088
32298
  * updateFilterSortInfo
32089
32299
  */
@@ -32097,25 +32307,9 @@ declare module GC{
32097
32307
  */
32098
32308
  updateFilterRange= 126,
32099
32309
  /**
32100
- * filterRowVisibleInfo
32101
- */
32102
- filterRowVisibleInfo= 127,
32103
- /**
32104
- * addGroup
32105
- */
32106
- addGroup= 141,
32107
- /**
32108
- * removeGroup
32109
- */
32110
- removeGroup= 142,
32111
- /**
32112
- * resetGroup
32310
+ * updateFilterData
32113
32311
  */
32114
- resetGroup= 143,
32115
- /**
32116
- * updateCollapsed
32117
- */
32118
- updateCollapsed= 144,
32312
+ updateFilterData= 128,
32119
32313
  /**
32120
32314
  * setDirection
32121
32315
  */
@@ -32220,14 +32414,6 @@ declare module GC{
32220
32414
  * updateShapeTransform
32221
32415
  */
32222
32416
  updateShapeTransform= 206,
32223
- /**
32224
- * addChildShape
32225
- */
32226
- addChildShape= 207,
32227
- /**
32228
- * removeChildShape
32229
- */
32230
- removeChildShape= 208,
32231
32417
  /**
32232
32418
  * reorderChildShape
32233
32419
  */
@@ -32447,6 +32633,19 @@ declare module GC{
32447
32633
  * @param {changeSet: GC.Spread.Sheets.Collaboration.IChangeSet} changeSet - change set
32448
32634
  */
32449
32635
  applyChangeSet(changeSet: GC.Spread.Sheets.Collaboration.IChangeSet): void;
32636
+ /**
32637
+ * Ends the current batch operation, finalizing the collection of operations into a single ChangeSet.
32638
+ * This method must be called after `startBatchOp` to complete the batch process.
32639
+ *
32640
+ * @example
32641
+ * ```javascript
32642
+ * spread.collaboration.startBatchOp();
32643
+ * sheet.setValue(0, 1, "World");
32644
+ * sheet.setFormula(0, 2, "=SUM(A1:B1)");
32645
+ * spread.collaboration.endBatchOp(); // The value and formula changes are merged into one ChangeSet.
32646
+ * ```
32647
+ */
32648
+ endBatchOp(): void;
32450
32649
  /**
32451
32650
  * Only used in collaboration case, to restore the snapshot to workbook state.
32452
32651
  * @param {object} snapshot - snapshot object
@@ -32540,6 +32739,19 @@ declare module GC{
32540
32739
  * ```
32541
32740
  */
32542
32741
  setUser(user: GC.Spread.Sheets.Collaboration.IUser): void;
32742
+ /**
32743
+ * Starts a batch operation, allowing multiple operations to be grouped and merged into a single ChangeSet.
32744
+ * When called, all operations performed until `endBatchOp` is invoked are collected and treated as a single atomic change in the SpreadJS workbook.
32745
+ *
32746
+ * @example
32747
+ * ```javascript
32748
+ * spread.collaboration.startBatchOp();
32749
+ * sheet.setValue(0, 0, "Hello");
32750
+ * sheet.setFormula(0, 2, "=SUM(A1:B1)");
32751
+ * spread.collaboration.endBatchOp(); // All operations above are merged into a single ChangeSet.
32752
+ * ```
32753
+ */
32754
+ startBatchOp(): void;
32543
32755
  /**
32544
32756
  * Only used in collaboration case, to save workbook state to snapshot.
32545
32757
  * @return {object} snapshot - snapshot object
@@ -32554,13 +32766,13 @@ declare module GC{
32554
32766
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32555
32767
  * @property {function} execute - performs an execute or undo operation.
32556
32768
  * The arguments of the execute method are as follows.
32557
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32558
- * @param {Object} options The options of the operation.
32559
- * @param {string} options.sheetName The sheet name.
32560
- * @param {Array} options.columns The resize columns; each item is an object which has a col.
32561
- * @param {boolean} options.rowHeader Whether the resized columns are in the row header area.
32562
- * @param {GC.Spread.Sheets.AutoFitType} options.autoFitType Whether the auto-fit action includes the header text.
32563
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32769
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32770
+ * @property {Object} options The options of the operation.
32771
+ * @property {string} options.sheetName The sheet name.
32772
+ * @property {Array} options.columns The resize columns; each item is an object which has a col.
32773
+ * @property {boolean} options.rowHeader Whether the resized columns are in the row header area.
32774
+ * @property {GC.Spread.Sheets.AutoFitType} options.autoFitType Whether the auto-fit action includes the header text.
32775
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32564
32776
  * @example
32565
32777
  * ```javascript
32566
32778
  * var columns = [ { col: 3 } ];
@@ -32574,13 +32786,13 @@ declare module GC{
32574
32786
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32575
32787
  * @property {function} execute - performs an execute or undo operation.
32576
32788
  * The arguments of the execute method are as follows.
32577
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32578
- * @param {Object} options The options of the operation.
32579
- * @param {string} options.sheetName The sheet name.
32580
- * @param {Array} options.rows The resize rows; each item is an object which has a row.
32581
- * @param {boolean} options.columnHeader Whether the resized rows are in the column header area.
32582
- * @param {GC.Spread.Sheets.AutoFitType} options.autoFitType Whether the auto-fit action includes the header text.
32583
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32789
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32790
+ * @property {Object} options The options of the operation.
32791
+ * @property {string} options.sheetName The sheet name.
32792
+ * @property {Array} options.rows The resize rows; each item is an object which has a row.
32793
+ * @property {boolean} options.columnHeader Whether the resized rows are in the column header area.
32794
+ * @property {GC.Spread.Sheets.AutoFitType} options.autoFitType Whether the auto-fit action includes the header text.
32795
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32584
32796
  * @example
32585
32797
  * ```javascript
32586
32798
  * spread.options.allowUndo = true;
@@ -32594,10 +32806,10 @@ declare module GC{
32594
32806
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32595
32807
  * @property {function} execute - performs an execute or undo operation.
32596
32808
  * The arguments of the execute method are as follows.
32597
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32598
- * @param {Object} options The options of the operation.
32599
- * @param {string} options.sheetName The sheet name.
32600
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32809
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32810
+ * @property {Object} options The options of the operation.
32811
+ * @property {string} options.sheetName The sheet name.
32812
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32601
32813
  * @example
32602
32814
  * ```javascript
32603
32815
  * // stop cell editing with invoking command
@@ -32615,10 +32827,10 @@ declare module GC{
32615
32827
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32616
32828
  * @property {function} execute - performs an execute or undo operation.
32617
32829
  * The arguments of the execute method are as follows.
32618
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32619
- * @param {Object} options The options of the operation.
32620
- * @param {string} options.sheetName The sheet name.
32621
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32830
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32831
+ * @property {Object} options The options of the operation.
32832
+ * @property {string} options.sheetName The sheet name.
32833
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32622
32834
  * @example
32623
32835
  * ```javascript
32624
32836
  * // start editing a cell with invoking command
@@ -32631,10 +32843,10 @@ declare module GC{
32631
32843
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32632
32844
  * @property {function} execute - performs an execute or undo operation.
32633
32845
  * The arguments of the execute method are as follows.
32634
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32635
- * @param {Object} options The options of the operation.
32636
- * @param {string} options.sheetName The sheet name.
32637
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32846
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32847
+ * @property {Object} options The options of the operation.
32848
+ * @property {string} options.sheetName The sheet name.
32849
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32638
32850
  * //This example uses the changeFormulaReference action to switch the formula reference.
32639
32851
  * spread.commandManager().execute({cmd: "changeFormulaReference", sheetName: "Sheet1"});
32640
32852
  */
@@ -32644,10 +32856,10 @@ declare module GC{
32644
32856
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32645
32857
  * @property {function} execute - performs an execute or undo operation.
32646
32858
  * The arguments of the execute method are as follows.
32647
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32648
- * @param {Object} options The options of the operation.
32649
- * @param {string} options.sheetName The sheet name.
32650
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32859
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32860
+ * @property {Object} options The options of the operation.
32861
+ * @property {string} options.sheetName The sheet name.
32862
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32651
32863
  * @example
32652
32864
  * ```javascript
32653
32865
  * // clear selected cells with the tab key
@@ -32663,10 +32875,10 @@ declare module GC{
32663
32875
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32664
32876
  * @property {function} execute - performs an execute or undo operation.
32665
32877
  * The arguments of the execute method are as follows.
32666
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32667
- * @param {Object} options The options of the operation.
32668
- * @param {string} options.sheetName The sheet name.
32669
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32878
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32879
+ * @property {Object} options The options of the operation.
32880
+ * @property {string} options.sheetName The sheet name.
32881
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32670
32882
  * @example
32671
32883
  * ```javascript
32672
32884
  * // clear active cell and enter edit mode with invoking command
@@ -32679,11 +32891,11 @@ declare module GC{
32679
32891
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32680
32892
  * @property {function} execute - performs an execute or undo operation.
32681
32893
  * The arguments of the execute method are as follows.
32682
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32683
- * @param {Object} options The options of the operation.
32684
- * @param {string} options.sheetName The sheet name.
32685
- * @param {Array} options.ranges The clear cell value ranges whose item type is GC.Spread.Sheets.Range.
32686
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32894
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32895
+ * @property {Object} options The options of the operation.
32896
+ * @property {string} options.sheetName The sheet name.
32897
+ * @property {Array} options.ranges The clear cell value ranges whose item type is GC.Spread.Sheets.Range.
32898
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32687
32899
  * @example
32688
32900
  * ```javascript
32689
32901
  * spread.options.allowUndo = true;
@@ -32696,16 +32908,16 @@ declare module GC{
32696
32908
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32697
32909
  * @property {function} execute - performs an execute or undo operation.
32698
32910
  * The arguments of the execute method are as follows.
32699
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32700
- * @param {Object} options The options of the operation.
32701
- * @param {string} options.sheetName The sheet name.
32702
- * @param {GC.Spread.Sheets.Worksheet} options.fromSheet The source sheet.
32703
- * @param {Array} options.fromRanges The source range array which item type is GC.Spread.Sheets.Range.
32704
- * @param {Array} options.pastedRanges The target range array which item type is GC.Spread.Sheets.Range.
32705
- * @param {boolean} options.isCutting Whether the operation is cutting or copying.
32706
- * @param {string} options.clipboardText The text on the clipboard.
32707
- * @param {GC.Spread.Sheets.ClipboardPasteOptions} options.pasteOption The Clipboard pasting option that indicates which content to paste.
32708
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32911
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32912
+ * @property {Object} options The options of the operation.
32913
+ * @property {string} options.sheetName The sheet name.
32914
+ * @property {GC.Spread.Sheets.Worksheet} options.fromSheet The source sheet.
32915
+ * @property {Array} options.fromRanges The source range array which item type is GC.Spread.Sheets.Range.
32916
+ * @property {Array} options.pastedRanges The target range array which item type is GC.Spread.Sheets.Range.
32917
+ * @property {boolean} options.isCutting Whether the operation is cutting or copying.
32918
+ * @property {string} options.clipboardText The text on the clipboard.
32919
+ * @property {GC.Spread.Sheets.ClipboardPasteOptions} options.pasteOption The Clipboard pasting option that indicates which content to paste.
32920
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32709
32921
  * @example
32710
32922
  * ```javascript
32711
32923
  * //This example uses the clipboardPaste method.
@@ -32717,16 +32929,7 @@ declare module GC{
32717
32929
  * activeSheet.setFormula(2, 1, "=B1+B2", GC.Spread.Sheets.SheetArea.viewport);
32718
32930
  * var fromRange = [new GC.Spread.Sheets.Range(0, 0, 3, 2)];
32719
32931
  * var toRanges = [new GC.Spread.Sheets.Range(5, 0, 3, 2)];
32720
- * $("#button1").click(function () {
32721
- * //Cut Paste Action
32722
- * spread.commandManager().execute({cmd: "clipboardPaste", sheetName: "Sheet1", fromSheet: activeSheet, fromRanges: fromRange, pastedRanges: toRanges, isCutting: true, clipboardText: "", pasteOption: GC.Spread.Sheets.ClipboardPasteOptions.all});
32723
- * });
32724
- * $("#button2").click(function () {
32725
- * spread.commandManager().execute({cmd: "clipboardPaste", sheetName: "Sheet1", fromSheet: activeSheet, fromRanges: fromRange, pastedRanges: toRanges, isCutting: false, clipboardText: "", pasteOption: GC.Spread.Sheets.ClipboardPasteOptions.all});
32726
- * });
32727
- * //Add button controls to page
32728
- * &lt;input type="button" id="button1" value="button1"/&gt;
32729
- * &lt;input type="button" id="button2" value="button2"/&gt;
32932
+ * spread.commandManager().execute({cmd: "clipboardPaste", sheetName: "Sheet1", fromSheet: activeSheet, fromRanges: fromRange, pastedRanges: toRanges, isCutting: true, clipboardText: "", pasteOption: GC.Spread.Sheets.ClipboardPasteOptions.all});
32730
32933
  * ```
32731
32934
  */
32732
32935
  var clipboardPaste: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, fromSheet: GC.Spread.Sheets.Worksheet, fromRanges: GC.Spread.Sheets.Range[], pastedRanges: GC.Spread.Sheets.Range[], isCutting: boolean, clipboardText: string, pasteOption: GC.Spread.Sheets.ClipboardPasteOptions}, isUndo: boolean): any};
@@ -32735,10 +32938,10 @@ declare module GC{
32735
32938
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32736
32939
  * @property {function} execute - performs an execute or undo operation.
32737
32940
  * The arguments of the execute method are as follows.
32738
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32739
- * @param {Object} options The options of the operation.
32740
- * @param {string} options.sheetName The sheet name.
32741
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32941
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32942
+ * @property {Object} options The options of the operation.
32943
+ * @property {string} options.sheetName The sheet name.
32944
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32742
32945
  * @example
32743
32946
  * ```javascript
32744
32947
  * // commit the cell editing and sets the array formula to the active range with invoking command
@@ -32751,10 +32954,10 @@ declare module GC{
32751
32954
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32752
32955
  * @property {function} execute - performs an execute or undo operation.
32753
32956
  * The arguments of the execute method are as follows.
32754
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32755
- * @param {Object} options The options of the operation.
32756
- * @param {string} options.sheetName The sheet name.
32757
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32957
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32958
+ * @property {Object} options The options of the operation.
32959
+ * @property {string} options.sheetName The sheet name.
32960
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32758
32961
  * @example
32759
32962
  * ```javascript
32760
32963
  * // stop cell editing and moves the active cell to the next row with invoking command
@@ -32772,10 +32975,10 @@ declare module GC{
32772
32975
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32773
32976
  * @property {function} execute - performs an execute or undo operation.
32774
32977
  * The arguments of the execute method are as follows.
32775
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32776
- * @param {Object} options The options of the operation.
32777
- * @param {string} options.sheetName The sheet name.
32778
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32978
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
32979
+ * @property {Object} options The options of the operation.
32980
+ * @property {string} options.sheetName The sheet name.
32981
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32779
32982
  * @example
32780
32983
  * ```javascript
32781
32984
  * // stop cell editing and moves the active cell to the previous row with invoking command
@@ -32793,10 +32996,10 @@ declare module GC{
32793
32996
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32794
32997
  * @property {function} execute - performs an execute or undo operation.
32795
32998
  * The arguments of the execute method are as follows.
32796
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32797
- * @param {Object} options The options of the operation.
32798
- * @param {string} options.sheetName The sheet name.
32799
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32999
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33000
+ * @property {Object} options The options of the operation.
33001
+ * @property {string} options.sheetName The sheet name.
33002
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32800
33003
  * @example
32801
33004
  * ```javascript
32802
33005
  * // copy the selected items text to the Clipboard with invoking command
@@ -32809,12 +33012,12 @@ declare module GC{
32809
33012
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32810
33013
  * @property {function} execute - performs an execute or undo operation.
32811
33014
  * The arguments of the execute method are as follows.
32812
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32813
- * @param {Object} options The options of the operation.
32814
- * @param {string} options.sheetName The clone sheet name.
32815
- * @param {number} options.targetIndex The target index.
32816
- * @param {number} options.newName The new sheet name.
32817
- * @param {boolean} options.includeBindingSource Whether to bind data source to clone sheet
33015
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33016
+ * @property {Object} options The options of the operation.
33017
+ * @property {string} options.sheetName The clone sheet name.
33018
+ * @property {number} options.targetIndex The target index.
33019
+ * @property {number} options.newName The new sheet name.
33020
+ * @property {boolean} options.includeBindingSource Whether to bind data source to clone sheet
32818
33021
  * @example
32819
33022
  * ```javascript
32820
33023
  * //This example copy a sheet.
@@ -32827,10 +33030,10 @@ declare module GC{
32827
33030
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32828
33031
  * @property {function} execute - performs an execute or undo operation.
32829
33032
  * The arguments of the execute method are as follows.
32830
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32831
- * @param {Object} options The options of the operation.
32832
- * @param {string} options.sheetName The sheet name.
32833
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33033
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33034
+ * @property {Object} options The options of the operation.
33035
+ * @property {string} options.sheetName The sheet name.
33036
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32834
33037
  * @example
32835
33038
  * ```javascript
32836
33039
  * // cut the selected items text to the Clipboard with invoking command
@@ -32843,12 +33046,12 @@ declare module GC{
32843
33046
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32844
33047
  * @property {function} execute - performs an execute or undo operation.
32845
33048
  * The arguments of the execute method are as follows.
32846
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32847
- * @param {Object} options The options of the operation.
32848
- * @param {string} options.sheetName The sheet name.
32849
- * @param {number} [options.col] The specified col for inserting, optional.
32850
- * @param {GC.Data.IColumn} options.column The defined column.
32851
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33049
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33050
+ * @property {Object} options The options of the operation.
33051
+ * @property {string} options.sheetName The sheet name.
33052
+ * @property {number} [options.col] The specified col for inserting, optional.
33053
+ * @property {GC.Data.IColumn} options.column The defined column.
33054
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32852
33055
  * @example
32853
33056
  * ```javascript
32854
33057
  * //This example uses the define column action.
@@ -32862,10 +33065,10 @@ declare module GC{
32862
33065
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32863
33066
  * @property {function} execute - performs an execute or undo operation.
32864
33067
  * The arguments of the execute method are as follows.
32865
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32866
- * @param {Object} options The options of the operation.
32867
- * @param {string} options.sheetName The sheet name.
32868
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33068
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33069
+ * @property {Object} options The options of the operation.
33070
+ * @property {string} options.sheetName The sheet name.
33071
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32869
33072
  * @example
32870
33073
  * ```javascript
32871
33074
  * // delete the floating objects with invoking command
@@ -32878,13 +33081,13 @@ declare module GC{
32878
33081
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32879
33082
  * @property {function} execute - performs an execute or undo operation.
32880
33083
  * The arguments of the execute method are as follows.
32881
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32882
- * @param {Object} options The options of the operation.
32883
- * @param {string} options.sheetName The sheet name.
32884
- * @param {Array} options.floatingObjects The names array of floating objects.
32885
- * @param {number} options.offsetX The horizontal offset.
32886
- * @param {number} options.offsetY The vertical offset.
32887
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise `false`.
33084
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33085
+ * @property {Object} options The options of the operation.
33086
+ * @property {string} options.sheetName The sheet name.
33087
+ * @property {Array} options.floatingObjects The names array of floating objects.
33088
+ * @property {number} options.offsetX The horizontal offset.
33089
+ * @property {number} options.offsetY The vertical offset.
33090
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise `false`.
32888
33091
  * @example
32889
33092
  * ```javascript
32890
33093
  * // copy floating objects with invoking command
@@ -32904,19 +33107,19 @@ declare module GC{
32904
33107
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32905
33108
  * @property {function} execute - performs an execute or undo operation.
32906
33109
  * The arguments of the execute method are as follows.
32907
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32908
- * commandOptions {Object} The options of the operation.
32909
- * commandOptions.sheetName {string} The sheet name.
32910
- * commandOptions.fromRow {number} The source row index for the drag drop.
32911
- * commandOptions.fromColumn {number} The source column index for the drag drop.
32912
- * commandOptions.toRow {number} The destination row index for the drag drop.
32913
- * commandOptions.toColumn {number} The destination column index for the drag drop.
32914
- * commandOptions.rowCount {number} The row count for the drag drop.
32915
- * commandOptions.columnCount {number} The column count for the drag drop.
32916
- * commandOptions.copy {boolean} If set to `true` copy; otherwise, cut if `false`.
32917
- * commandOptions.insert {boolean} If set to `true` inserts the drag data in the drop row or column.
32918
- * commandOptions.option {GC.Spread.Sheets.CopyToOptions} Indicates the content type to drag and drop.
32919
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33110
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33111
+ * @property {Object} commandOptions The options of the operation.
33112
+ * @property {string} commandOptions.sheetName The sheet name.
33113
+ * @property {number} commandOptions.fromRow The source row index for the drag drop.
33114
+ * @property {number} commandOptions.fromColumn The source column index for the drag drop.
33115
+ * @property {number} commandOptions.toRow The destination row index for the drag drop.
33116
+ * @property {number} commandOptions.toColumn The destination column index for the drag drop.
33117
+ * @property {number} commandOptions.rowCount The row count for the drag drop.
33118
+ * @property {number} commandOptions.columnCount The column count for the drag drop.
33119
+ * @property {boolean} commandOptions.copy If set to `true` copy; otherwise, cut if `false`.
33120
+ * @property {boolean} commandOptions.insert If set to `true` inserts the drag data in the drop row or column.
33121
+ * @property {GC.Spread.Sheets.CopyToOptions} commandOptions.option Indicates the content type to drag and drop.
33122
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32920
33123
  * @example
32921
33124
  * ```javascript
32922
33125
  * spread.options.allowUndo = true;
@@ -32929,14 +33132,14 @@ declare module GC{
32929
33132
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32930
33133
  * @property {function} execute - performs an execute or undo operation.
32931
33134
  * The arguments of the execute method are as follows.
32932
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32933
- * @param {Object} options The options of the operation.
32934
- * @param {string} options.sheetName The sheet name.
32935
- * @param {number} options.row The row index of the cell.
32936
- * @param {number} options.col The column index of the cell.
32937
- * @param {Object} options.newValue The new value of the cell.
32938
- * @param {boolean} options.autoFormat Whether to format the new value automatically.
32939
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33135
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33136
+ * @property {Object} options The options of the operation.
33137
+ * @property {string} options.sheetName The sheet name.
33138
+ * @property {number} options.row The row index of the cell.
33139
+ * @property {number} options.col The column index of the cell.
33140
+ * @property {Object} options.newValue The new value of the cell.
33141
+ * @property {boolean} options.autoFormat Whether to format the new value automatically.
33142
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32940
33143
  * @example
32941
33144
  * ```javascript
32942
33145
  * // apply a new value to a cell with invoking command
@@ -32949,13 +33152,13 @@ declare module GC{
32949
33152
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32950
33153
  * @property {function} execute - performs an execute or undo operation.
32951
33154
  * The arguments of the execute method are as follows.
32952
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32953
- * @param {Object} options The options of the operation.
32954
- * @param {string} options.sheetName The sheet name.
32955
- * @param {number} options.index The outline summary index.
32956
- * @param {number} options.level The outline level.
32957
- * @param {boolean} options.collapsed Whether to make the outline collapsed or expanded.
32958
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33155
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33156
+ * @property {Object} options The options of the operation.
33157
+ * @property {string} options.sheetName The sheet name.
33158
+ * @property {number} options.index The outline summary index.
33159
+ * @property {number} options.level The outline level.
33160
+ * @property {boolean} options.collapsed Whether to make the outline collapsed or expanded.
33161
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32959
33162
  * @example
32960
33163
  * ```javascript
32961
33164
  * // collapse a column range group with invoking command
@@ -32968,11 +33171,11 @@ declare module GC{
32968
33171
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32969
33172
  * @property {function} execute - performs an execute or undo operation.
32970
33173
  * The arguments of the execute method are as follows.
32971
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32972
- * @param {Object} options The options of the operation.
32973
- * @param {string} options.sheetName The sheet name.
32974
- * @param {number} options.level The outline level.
32975
- * @param {boolean} isUndo `true` if this an undo operation; otherwise, `false`.
33174
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33175
+ * @property {Object} options The options of the operation.
33176
+ * @property {string} options.sheetName The sheet name.
33177
+ * @property {number} options.level The outline level.
33178
+ * @property {boolean} isUndo `true` if this an undo operation; otherwise, `false`.
32976
33179
  * @example
32977
33180
  * ```javascript
32978
33181
  * // expand or collapse a column range group with invoking command
@@ -32985,13 +33188,13 @@ declare module GC{
32985
33188
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32986
33189
  * @property {function} execute - performs an execute or undo operation.
32987
33190
  * The arguments of the execute method are as follows.
32988
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32989
- * @param {Object} options The options of the operation.
32990
- * @param {string} options.sheetName The sheet name.
32991
- * @param {number} options.index The outline summary index.
32992
- * @param {number} options.level The outline level.
32993
- * @param {boolean} options.collapsed Whether to make the outline collapsed or expanded.
32994
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33191
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33192
+ * @property {Object} options The options of the operation.
33193
+ * @property {string} options.sheetName The sheet name.
33194
+ * @property {number} options.index The outline summary index.
33195
+ * @property {number} options.level The outline level.
33196
+ * @property {boolean} options.collapsed Whether to make the outline collapsed or expanded.
33197
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32995
33198
  * @example
32996
33199
  * ```javascript
32997
33200
  * // expand a row range group with invoking command
@@ -33004,11 +33207,11 @@ declare module GC{
33004
33207
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33005
33208
  * @property {function} execute - performs an execute or undo operation.
33006
33209
  * The arguments of the execute method are as follows.
33007
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33008
- * @param {Object} options The options of the operation.
33009
- * @param {string} options.sheetName The sheet name.
33010
- * @param {number} options.level The outline level.
33011
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33210
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33211
+ * @property {Object} options The options of the operation.
33212
+ * @property {string} options.sheetName The sheet name.
33213
+ * @property {number} options.level The outline level.
33214
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33012
33215
  * @example
33013
33216
  * ```javascript
33014
33217
  * // expand or collapse a row range group with invoking command
@@ -33021,14 +33224,14 @@ declare module GC{
33021
33224
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33022
33225
  * @property {function} execute - performs an execute or undo operation.
33023
33226
  * The arguments of the execute method are as follows.
33024
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33025
- * @param {Object} options The options of the operation.
33026
- * @param {string} options.sheetName The sheet name.
33027
- * @param {GC.Spread.Sheets.Range} options.startRange The start range.
33028
- * @param {GC.Spread.Sheets.Range} options.fillRange The fill range.
33029
- * @param {GC.Spread.Sheets.Fill.AutoFillType} options.autoFillType The auto fill type.
33030
- * @param {GC.Spread.Sheets.Fill.FillDirection} options.fillDirection The fill direction.
33031
- * @param {boolean} isUndo `true` if an undo operation; otherwise, `false`.
33227
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33228
+ * @property {Object} options The options of the operation.
33229
+ * @property {string} options.sheetName The sheet name.
33230
+ * @property {GC.Spread.Sheets.Range} options.startRange The start range.
33231
+ * @property {GC.Spread.Sheets.Range} options.fillRange The fill range.
33232
+ * @property {GC.Spread.Sheets.Fill.AutoFillType} options.autoFillType The auto fill type.
33233
+ * @property {GC.Spread.Sheets.Fill.FillDirection} options.fillDirection The fill direction.
33234
+ * @property {boolean} isUndo `true` if an undo operation; otherwise, `false`.
33032
33235
  * @example
33033
33236
  * ```javascript
33034
33237
  * spread.options.allowUndo = true;
@@ -33043,12 +33246,12 @@ declare module GC{
33043
33246
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33044
33247
  * @property {function} execute - performs an execute or undo operation.
33045
33248
  * The arguments of the execute method are as follows.
33046
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33047
- * @param {Object} options The options of the operation.
33048
- * @param {string} options.sheetName The sheet name.
33049
- * @param {number} options.col The specified col.
33050
- * @param {GC.Data.IColumn} options.column The modified column.
33051
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33249
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33250
+ * @property {Object} options The options of the operation.
33251
+ * @property {string} options.sheetName The sheet name.
33252
+ * @property {number} options.col The specified col.
33253
+ * @property {GC.Data.IColumn} options.column The modified column.
33254
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33052
33255
  * @example
33053
33256
  * ```javascript
33054
33257
  * //This example uses the modify column action.
@@ -33062,13 +33265,13 @@ declare module GC{
33062
33265
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33063
33266
  * @property {function} execute - performs an execute or undo operation.
33064
33267
  * The arguments of the execute method are as follows.
33065
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33066
- * @param {Object} options The options of the operation.
33067
- * @param {string} options.sheetName The sheet name.
33068
- * @param {Array} options.floatingObjects The names array of floating objects.
33069
- * @param {number} options.offsetX The horizontal offset.
33070
- * @param {number} options.offsetY The vertical offset.
33071
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33268
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33269
+ * @property {Object} options The options of the operation.
33270
+ * @property {string} options.sheetName The sheet name.
33271
+ * @property {Array} options.floatingObjects The names array of floating objects.
33272
+ * @property {number} options.offsetX The horizontal offset.
33273
+ * @property {number} options.offsetY The vertical offset.
33274
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33072
33275
  * @example
33073
33276
  * ```javascript
33074
33277
  * // move floating objects with invoking command
@@ -33081,10 +33284,10 @@ declare module GC{
33081
33284
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33082
33285
  * @property {function} execute - performs an execute or undo operation.
33083
33286
  * The arguments of the execute method are as follows.
33084
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33085
- * @param {Object} options The options of the operation.
33086
- * @param {string} options.sheetName The sheet name.
33087
- * @param {number} options.targetIndex The target index.
33287
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33288
+ * @property {Object} options The options of the operation.
33289
+ * @property {string} options.sheetName The sheet name.
33290
+ * @property {number} options.targetIndex The target index.
33088
33291
  * @example
33089
33292
  * ```javascript
33090
33293
  * //This example move a sheet.
@@ -33097,10 +33300,10 @@ declare module GC{
33097
33300
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33098
33301
  * @property {function} execute - performs an execute or undo operation.
33099
33302
  * The arguments of the execute method are as follows.
33100
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33101
- * @param {Object} options The options of the operation.
33102
- * @param {string} options.sheetName The sheet name.
33103
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33303
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33304
+ * @property {Object} options The options of the operation.
33305
+ * @property {string} options.sheetName The sheet name.
33306
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33104
33307
  * @example
33105
33308
  * ```javascript
33106
33309
  * //This example maps the moveToNextCell action.
@@ -33117,10 +33320,10 @@ declare module GC{
33117
33320
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33118
33321
  * @property {function} execute - performs an execute or undo operation.
33119
33322
  * The arguments of the execute method are as follows.
33120
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33121
- * @param {Object} options The options of the operation.
33122
- * @param {string} options.sheetName The sheet name.
33123
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33323
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33324
+ * @property {Object} options The options of the operation.
33325
+ * @property {string} options.sheetName The sheet name.
33326
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33124
33327
  * @example
33125
33328
  * ```javascript
33126
33329
  * //This example maps the moveToNextCellThenControl action.
@@ -33134,10 +33337,10 @@ declare module GC{
33134
33337
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33135
33338
  * @property {function} execute - performs an execute or undo operation.
33136
33339
  * The arguments of the execute method are as follows.
33137
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33138
- * @param {Object} options The options of the operation.
33139
- * @param {string} options.sheetName The sheet name.
33140
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33340
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33341
+ * @property {Object} options The options of the operation.
33342
+ * @property {string} options.sheetName The sheet name.
33343
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33141
33344
  * @example
33142
33345
  * ```javascript
33143
33346
  * //This example uses the moveToPreviousCell action.
@@ -33153,10 +33356,10 @@ declare module GC{
33153
33356
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33154
33357
  * @property {function} execute - performs an execute or undo operation.
33155
33358
  * The arguments of the execute method are as follows.
33156
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33157
- * @param {Object} options The options of the operation.
33158
- * @param {string} options.sheetName The sheet name.
33159
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33359
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33360
+ * @property {Object} options The options of the operation.
33361
+ * @property {string} options.sheetName The sheet name.
33362
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33160
33363
  * @example
33161
33364
  * ```javascript
33162
33365
  * //This example maps the moveToPreviousCellThenControl action.
@@ -33170,10 +33373,10 @@ declare module GC{
33170
33373
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33171
33374
  * @property {function} execute - performs an execute or undo operation.
33172
33375
  * The arguments of the execute method are as follows.
33173
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33174
- * @param {Object} options The options of the operation.
33175
- * @param {string} options.sheetName The sheet name.
33176
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33376
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33377
+ * @property {Object} options The options of the operation.
33378
+ * @property {string} options.sheetName The sheet name.
33379
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33177
33380
  * @example
33178
33381
  * ```javascript
33179
33382
  * //This example maps the navigationBottom action to the Tab key.
@@ -33187,10 +33390,10 @@ declare module GC{
33187
33390
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33188
33391
  * @property {function} execute - performs an execute or undo operation.
33189
33392
  * The arguments of the execute method are as follows.
33190
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33191
- * @param {Object} options The options of the operation.
33192
- * @param {string} options.sheetName The sheet name.
33193
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33393
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33394
+ * @property {Object} options The options of the operation.
33395
+ * @property {string} options.sheetName The sheet name.
33396
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33194
33397
  * @example
33195
33398
  * ```javascript
33196
33399
  * //This example maps the navigationDown key.
@@ -33204,10 +33407,10 @@ declare module GC{
33204
33407
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33205
33408
  * @property {function} execute - performs an execute or undo operation.
33206
33409
  * The arguments of the execute method are as follows.
33207
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33208
- * @param {Object} options The options of the operation.
33209
- * @param {string} options.sheetName The sheet name.
33210
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33410
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33411
+ * @property {Object} options The options of the operation.
33412
+ * @property {string} options.sheetName The sheet name.
33413
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33211
33414
  * @example
33212
33415
  * ```javascript
33213
33416
  * //This example uses the navigationEnd method.
@@ -33220,10 +33423,10 @@ declare module GC{
33220
33423
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33221
33424
  * @property {function} execute - performs an execute or undo operation.
33222
33425
  * The arguments of the execute method are as follows.
33223
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33224
- * @param {Object} options The options of the operation.
33225
- * @param {string} options.sheetName The sheet name.
33226
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33426
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33427
+ * @property {Object} options The options of the operation.
33428
+ * @property {string} options.sheetName The sheet name.
33429
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33227
33430
  * @example
33228
33431
  * ```javascript
33229
33432
  * //This example uses the navigationEnd2 action.
@@ -33236,10 +33439,10 @@ declare module GC{
33236
33439
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33237
33440
  * @property {function} execute - performs an execute or undo operation.
33238
33441
  * The arguments of the execute method are as follows.
33239
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33240
- * @param {Object} options The options of the operation.
33241
- * @param {string} options.sheetName The sheet name.
33242
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33442
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33443
+ * @property {Object} options The options of the operation.
33444
+ * @property {string} options.sheetName The sheet name.
33445
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33243
33446
  * @example
33244
33447
  * ```javascript
33245
33448
  * //This example uses the navigationFirst action.
@@ -33252,10 +33455,10 @@ declare module GC{
33252
33455
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33253
33456
  * @property {function} execute - performs an execute or undo operation.
33254
33457
  * The arguments of the execute method are as follows.
33255
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33256
- * @param {Object} options The options of the operation.
33257
- * @param {string} options.sheetName The sheet name.
33258
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33458
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33459
+ * @property {Object} options The options of the operation.
33460
+ * @property {string} options.sheetName The sheet name.
33461
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33259
33462
  * @example
33260
33463
  * ```javascript
33261
33464
  * //This example uses the navigationHome action.
@@ -33268,10 +33471,10 @@ declare module GC{
33268
33471
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33269
33472
  * @property {function} execute - performs an execute or undo operation.
33270
33473
  * The arguments of the execute method are as follows.
33271
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33272
- * @param {Object} options The options of the operation.
33273
- * @param {string} options.sheetName The sheet name.
33274
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33474
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33475
+ * @property {Object} options The options of the operation.
33476
+ * @property {string} options.sheetName The sheet name.
33477
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33275
33478
  * @example
33276
33479
  * ```javascript
33277
33480
  * //This example uses the navigationHome2 action.
@@ -33284,10 +33487,10 @@ declare module GC{
33284
33487
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33285
33488
  * @property {function} execute - performs an execute or undo operation.
33286
33489
  * The arguments of the execute method are as follows.
33287
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33288
- * @param {Object} options The options of the operation.
33289
- * @param {string} options.sheetName The sheet name.
33290
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33490
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33491
+ * @property {Object} options The options of the operation.
33492
+ * @property {string} options.sheetName The sheet name.
33493
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33291
33494
  * @example
33292
33495
  * ```javascript
33293
33496
  * //This example uses the navigationLast action.
@@ -33300,10 +33503,10 @@ declare module GC{
33300
33503
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33301
33504
  * @property {function} execute - performs an execute or undo operation.
33302
33505
  * The arguments of the execute method are as follows.
33303
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33304
- * @param {Object} options The options of the operation.
33305
- * @param {string} options.sheetName The sheet name.
33306
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33506
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33507
+ * @property {Object} options The options of the operation.
33508
+ * @property {string} options.sheetName The sheet name.
33509
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33307
33510
  * @example
33308
33511
  * ```javascript
33309
33512
  * //This example uses the navigationLeft action.
@@ -33316,10 +33519,10 @@ declare module GC{
33316
33519
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33317
33520
  * @property {function} execute - performs an execute or undo operation.
33318
33521
  * The arguments of the execute method are as follows.
33319
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33320
- * @param {Object} options The options of the operation.
33321
- * @param {string} options.sheetName The sheet name.
33322
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33522
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33523
+ * @property {Object} options The options of the operation.
33524
+ * @property {string} options.sheetName The sheet name.
33525
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33323
33526
  * @example
33324
33527
  * ```javascript
33325
33528
  * //This example uses the navigationNextSheet action.
@@ -33332,10 +33535,10 @@ declare module GC{
33332
33535
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33333
33536
  * @property {function} execute - performs an execute or undo operation.
33334
33537
  * The arguments of the execute method are as follows.
33335
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33336
- * @param {Object} options The options of the operation.
33337
- * @param {string} options.sheetName The sheet name.
33338
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33538
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33539
+ * @property {Object} options The options of the operation.
33540
+ * @property {string} options.sheetName The sheet name.
33541
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33339
33542
  * @example
33340
33543
  * ```javascript
33341
33544
  * //This example uses the navigationPageDown action.
@@ -33348,10 +33551,10 @@ declare module GC{
33348
33551
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33349
33552
  * @property {function} execute - performs an execute or undo operation.
33350
33553
  * The arguments of the execute method are as follows.
33351
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33352
- * @param {Object} options The options of the operation.
33353
- * @param {string} options.sheetName The sheet name.
33354
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33554
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33555
+ * @property {Object} options The options of the operation.
33556
+ * @property {string} options.sheetName The sheet name.
33557
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33355
33558
  * @example
33356
33559
  * ```javascript
33357
33560
  * //This example uses the navigationPageUp action.
@@ -33364,10 +33567,10 @@ declare module GC{
33364
33567
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33365
33568
  * @property {function} execute - performs an execute or undo operation.
33366
33569
  * The arguments of the execute method are as follows.
33367
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33368
- * @param {Object} options The options of the operation.
33369
- * @param {string} options.sheetName The sheet name.
33370
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33570
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33571
+ * @property {Object} options The options of the operation.
33572
+ * @property {string} options.sheetName The sheet name.
33573
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33371
33574
  * @example
33372
33575
  * ```javascript
33373
33576
  * //This example uses the navigationPreviousSheet action.
@@ -33381,10 +33584,10 @@ declare module GC{
33381
33584
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33382
33585
  * @property {function} execute - performs an execute or undo operation.
33383
33586
  * The arguments of the execute method are as follows.
33384
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33385
- * @param {Object} options The options of the operation.
33386
- * @param {string} options.sheetName The sheet name.
33387
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33587
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33588
+ * @property {Object} options The options of the operation.
33589
+ * @property {string} options.sheetName The sheet name.
33590
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33388
33591
  * @example
33389
33592
  * ```javascript
33390
33593
  * //This example uses the navigationRight action.
@@ -33397,10 +33600,10 @@ declare module GC{
33397
33600
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33398
33601
  * @property {function} execute - performs an execute or undo operation.
33399
33602
  * The arguments of the execute method are as follows.
33400
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33401
- * @param {Object} options The options of the operation.
33402
- * @param {string} options.sheetName The sheet name.
33403
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33603
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33604
+ * @property {Object} options The options of the operation.
33605
+ * @property {string} options.sheetName The sheet name.
33606
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33404
33607
  * @example
33405
33608
  * ```javascript
33406
33609
  * //This example uses the navigationTop action.
@@ -33413,10 +33616,10 @@ declare module GC{
33413
33616
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33414
33617
  * @property {function} execute - performs an execute or undo operation.
33415
33618
  * The arguments of the execute method are as follows.
33416
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33417
- * @param {Object} options The options of the operation.
33418
- * @param {string} options.sheetName The sheet name.
33419
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33619
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33620
+ * @property {Object} options The options of the operation.
33621
+ * @property {string} options.sheetName The sheet name.
33622
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33420
33623
  * @example
33421
33624
  * ```javascript
33422
33625
  * //This example maps the navigationUp action to a.
@@ -33429,13 +33632,13 @@ declare module GC{
33429
33632
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33430
33633
  * @property {function} execute - performs an execute or undo operation.
33431
33634
  * The arguments of the execute method are as follows.
33432
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33433
- * @param {Object} options The options of the operation.
33434
- * @param {string} options.sheetName The sheet name.
33435
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33436
- * @param {number} options.row The rowIndex.
33437
- * @param {number} options.col The columnIndex.
33438
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33635
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33636
+ * @property {Object} options The options of the operation.
33637
+ * @property {string} options.sheetName The sheet name.
33638
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33639
+ * @property {number} options.row The rowIndex.
33640
+ * @property {number} options.col The columnIndex.
33641
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33439
33642
  * @example
33440
33643
  * ```javascript
33441
33644
  * // open a calculator with invoking command
@@ -33448,13 +33651,13 @@ declare module GC{
33448
33651
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33449
33652
  * @property {function} execute - performs an execute or undo operation.
33450
33653
  * The arguments of the execute method are as follows.
33451
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33452
- * @param {Object} options The options of the operation.
33453
- * @param {string} options.sheetName The sheet name.
33454
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33455
- * @param {number} options.row The rowIndex.
33456
- * @param {number} options.col The columnIndex.
33457
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33654
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33655
+ * @property {Object} options The options of the operation.
33656
+ * @property {string} options.sheetName The sheet name.
33657
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33658
+ * @property {number} options.row The rowIndex.
33659
+ * @property {number} options.col The columnIndex.
33660
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33458
33661
  * @example
33459
33662
  * ```javascript
33460
33663
  * // open a color picker with invoking command
@@ -33467,13 +33670,13 @@ declare module GC{
33467
33670
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33468
33671
  * @property {function} execute - performs an execute or undo operation.
33469
33672
  * The arguments of the execute method are as follows.
33470
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33471
- * @param {Object} options The options of the operation.
33472
- * @param {string} options.sheetName The sheet name.
33473
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33474
- * @param {number} options.row The rowIndex.
33475
- * @param {number} options.col The columnIndex.
33476
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33673
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33674
+ * @property {Object} options The options of the operation.
33675
+ * @property {string} options.sheetName The sheet name.
33676
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33677
+ * @property {number} options.row The rowIndex.
33678
+ * @property {number} options.col The columnIndex.
33679
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33477
33680
  * @example
33478
33681
  * ```javascript
33479
33682
  * // open a dateTimePicker with invoking command
@@ -33486,13 +33689,13 @@ declare module GC{
33486
33689
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33487
33690
  * @property {function} execute - performs an execute or undo operation.
33488
33691
  * The arguments of the execute method are as follows.
33489
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33490
- * @param {Object} options The options of the operation.
33491
- * @param {string} options.sheetName The sheet name.
33492
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33493
- * @param {number} options.row The rowIndex.
33494
- * @param {number} options.col The columnIndex.
33495
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33692
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33693
+ * @property {Object} options The options of the operation.
33694
+ * @property {string} options.sheetName The sheet name.
33695
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33696
+ * @property {number} options.row The rowIndex.
33697
+ * @property {number} options.col The columnIndex.
33698
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33496
33699
  * @example
33497
33700
  * ```javascript
33498
33701
  * // open a list with invoking command
@@ -33505,13 +33708,13 @@ declare module GC{
33505
33708
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33506
33709
  * @property {function} execute - performs an execute or undo operation.
33507
33710
  * The arguments of the execute method are as follows.
33508
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33509
- * @param {Object} options The options of the operation.
33510
- * @param {string} options.sheetName The sheet name.
33511
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33512
- * @param {number} options.row The rowIndex.
33513
- * @param {number} options.col The columnIndex.
33514
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33711
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33712
+ * @property {Object} options The options of the operation.
33713
+ * @property {string} options.sheetName The sheet name.
33714
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33715
+ * @property {number} options.row The rowIndex.
33716
+ * @property {number} options.col The columnIndex.
33717
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33515
33718
  * @example
33516
33719
  * ```javascript
33517
33720
  * // open a month picker with invoking command
@@ -33524,13 +33727,13 @@ declare module GC{
33524
33727
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33525
33728
  * @property {function} execute - performs an execute or undo operation.
33526
33729
  * The arguments of the execute method are as follows.
33527
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33528
- * @param {Object} options The options of the operation.
33529
- * @param {string} options.sheetName The sheet name.
33530
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33531
- * @param {number} options.row The rowIndex.
33532
- * @param {number} options.col The columnIndex.
33533
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33730
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33731
+ * @property {Object} options The options of the operation.
33732
+ * @property {string} options.sheetName The sheet name.
33733
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33734
+ * @property {number} options.row The rowIndex.
33735
+ * @property {number} options.col The columnIndex.
33736
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33534
33737
  * @example
33535
33738
  * ```javascript
33536
33739
  * // open a MultiColumn with invoking command
@@ -33540,7 +33743,7 @@ declare module GC{
33540
33743
  var openMultiColumn: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, row: number, col: number, sheetArea: GC.Spread.Sheets.SheetArea}, isUndo: boolean): any};
33541
33744
  /**
33542
33745
  * Represents the command used to open paste special dialog.
33543
- * @param context The context of the operation.
33746
+ * @property context The context of the operation.
33544
33747
  * @example
33545
33748
  * ```javascript
33546
33749
  * //This example opens the paste special dialog.
@@ -33553,13 +33756,13 @@ declare module GC{
33553
33756
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33554
33757
  * @property {function} execute - performs an execute or undo operation.
33555
33758
  * The arguments of the execute method are as follows.
33556
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33557
- * @param {Object} options The options of the operation.
33558
- * @param {string} options.sheetName The sheet name.
33559
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33560
- * @param {number} options.row The rowIndex.
33561
- * @param {number} options.col The columnIndex.
33562
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33759
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33760
+ * @property {Object} options The options of the operation.
33761
+ * @property {string} options.sheetName The sheet name.
33762
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33763
+ * @property {number} options.row The rowIndex.
33764
+ * @property {number} options.col The columnIndex.
33765
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33563
33766
  * @example
33564
33767
  * ```javascript
33565
33768
  * // open a slider with invoking command
@@ -33572,13 +33775,13 @@ declare module GC{
33572
33775
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33573
33776
  * @property {function} execute - performs an execute or undo operation.
33574
33777
  * The arguments of the execute method are as follows.
33575
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33576
- * @param {Object} options The options of the operation.
33577
- * @param {string} options.sheetName The sheet name.
33578
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33579
- * @param {number} options.row The rowIndex.
33580
- * @param {number} options.col The columnIndex.
33581
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33778
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33779
+ * @property {Object} options The options of the operation.
33780
+ * @property {string} options.sheetName The sheet name.
33781
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33782
+ * @property {number} options.row The rowIndex.
33783
+ * @property {number} options.col The columnIndex.
33784
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33582
33785
  * @example
33583
33786
  * ```javascript
33584
33787
  * // open a TimePicker with invoking command
@@ -33591,12 +33794,12 @@ declare module GC{
33591
33794
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33592
33795
  * @property {function} execute - performs an execute or undo operation.
33593
33796
  * The arguments of the execute method are as follows.
33594
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33595
- * @param {Object} options The options of the operation.
33596
- * @param {string} options.sheetName The sheet name.
33597
- * @param {string} options.url The url string.
33598
- * @param {GC.Spread.Sheets.Hyperlink.HyperlinkTargetType} options.target The target type, it's default is blank.
33599
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33797
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33798
+ * @property {Object} options The options of the operation.
33799
+ * @property {string} options.sheetName The sheet name.
33800
+ * @property {string} options.url The url string.
33801
+ * @property {GC.Spread.Sheets.Hyperlink.HyperlinkTargetType} options.target The target type, it's default is blank.
33802
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33600
33803
  * @example
33601
33804
  * ```javascript
33602
33805
  * // clear open the url of the hyperlink cell with invoking command
@@ -33609,13 +33812,13 @@ declare module GC{
33609
33812
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33610
33813
  * @property {function} execute - performs an execute or undo operation.
33611
33814
  * The arguments of the execute method are as follows.
33612
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33613
- * @param {Object} options The options of the operation.
33614
- * @param {string} options.sheetName The sheet name.
33615
- * @param {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33616
- * @param {number} options.row The rowIndex.
33617
- * @param {number} options.col The columnIndex.
33618
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33815
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33816
+ * @property {Object} options The options of the operation.
33817
+ * @property {string} options.sheetName The sheet name.
33818
+ * @property {GC.Spread.Sheets.SheetArea} options.sheetArea The sheet area.
33819
+ * @property {number} options.row The rowIndex.
33820
+ * @property {number} options.col The columnIndex.
33821
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33619
33822
  * @example
33620
33823
  * ```javascript
33621
33824
  * // open a color picker with invoking command
@@ -33628,12 +33831,12 @@ declare module GC{
33628
33831
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33629
33832
  * @property {function} execute - performs an execute or undo operation.
33630
33833
  * The arguments of the execute method are as follows.
33631
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33632
- * @param {Object} options The options of the operation.
33633
- * @param {string} options.sheetName The sheet name.
33634
- * @param {number} options.index The outline starting index.
33635
- * @param {number} options.count The number of rows or columns to group or ungroup in the outline.
33636
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33834
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33835
+ * @property {Object} options The options of the operation.
33836
+ * @property {string} options.sheetName The sheet name.
33837
+ * @property {number} options.index The outline starting index.
33838
+ * @property {number} options.count The number of rows or columns to group or ungroup in the outline.
33839
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33637
33840
  * @example
33638
33841
  * ```javascript
33639
33842
  * //This example creates a group.
@@ -33647,12 +33850,12 @@ declare module GC{
33647
33850
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33648
33851
  * @property {function} execute - performs an execute or undo operation.
33649
33852
  * The arguments of the execute method are as follows.
33650
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33651
- * @param {Object} options The options of the operation.
33652
- * @param {string} options.sheetName The sheet name.
33653
- * @param {number} options.index The outline starting index.
33654
- * @param {number} options.count The number of rows or columns to group or ungroup in the outline.
33655
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33853
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33854
+ * @property {Object} options The options of the operation.
33855
+ * @property {string} options.sheetName The sheet name.
33856
+ * @property {number} options.index The outline starting index.
33857
+ * @property {number} options.count The number of rows or columns to group or ungroup in the outline.
33858
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33656
33859
  * @example
33657
33860
  * ```javascript
33658
33861
  * //This example undoes an action.
@@ -33666,19 +33869,21 @@ declare module GC{
33666
33869
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33667
33870
  * @property {function} execute - performs an execute or undo operation.
33668
33871
  * The arguments of the execute method are as follows.
33669
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33670
- * @param {Object} options The options of the operation.
33671
- * @param {string} options.sheetName The sheet name.
33672
- * @param {GC.Spread.Sheets.InsertShiftCell} options.shiftCells The inserted data needs to be moved in the direction.
33673
- * @param {GC.Spread.Sheets.ClipboardPasteOptions} options.pasteOption The option of paste.
33674
- * @param {string} options.pasteText The pasting text of clipboard.
33675
- * @param {string} options.pasteHtml The pasting HTML of clipboard.
33676
- * @param {Object} options.pasteSpecialOptions
33677
- * @param {GC.Spread.Sheets.PasteOperationOptions} options.pasteSpecialOptions.operationOptions The option of paste operation.
33678
- * @param {boolean} options.pasteSpecialOptions.skipBlanks whether to skip the blank cells in the copied range without replacing the corresponding cells.
33679
- * @param {boolean} options.pasteSpecialOptions.transpose whether to change columns of copied data to rows and vice versa.
33680
- * @param {boolean} options.pasteSpecialOptions.pasteLink whether to paste cell references.
33681
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33872
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33873
+ * @property {Object} options The options of the operation.
33874
+ * @property {string} options.sheetName The sheet name.
33875
+ * @property {GC.Spread.Sheets.InsertShiftCell} options.shiftCells The inserted data needs to be moved in the direction.
33876
+ * @property {GC.Spread.Sheets.ClipboardPasteOptions} options.pasteOption The option of paste.
33877
+ * @property {string} options.pasteText The pasting text of clipboard.
33878
+ * @property {string} options.pasteHtml The pasting HTML of clipboard.
33879
+ * @property {Object} options.pasteSpecialOptions
33880
+ * @property {GC.Spread.Sheets.PasteOperationOptions} options.pasteSpecialOptions.operationOptions The option of paste operation.
33881
+ * @property {boolean} options.pasteSpecialOptions.skipBlanks whether to skip the blank cells in the copied range without replacing the corresponding cells.
33882
+ * @property {boolean} options.pasteSpecialOptions.transpose whether to change columns of copied data to rows and vice versa.
33883
+ * @property {boolean} options.pasteSpecialOptions.pasteLink whether to paste cell references.
33884
+ * @property {string} options.pasteSpecialOptions.transformFormula Represents the formula for cell transform when pasting.
33885
+ * @property {GC.Spread.Sheets.TransformScope} options.pasteSpecialOptions.transformScope Represents the work scope for cell transform when pasting.
33886
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33682
33887
  * @example
33683
33888
  * ```javascript
33684
33889
  * // paste the selected items from the Clipboard to the current sheet with invoking command
@@ -33691,10 +33896,10 @@ declare module GC{
33691
33896
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33692
33897
  * @property {function} execute - performs an execute or undo operation.
33693
33898
  * The arguments of the execute method are as follows.
33694
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33695
- * @param {Object} options The options of the operation.
33696
- * @param {string} options.sheetName The sheet name.
33697
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33899
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33900
+ * @property {Object} options The options of the operation.
33901
+ * @property {string} options.sheetName The sheet name.
33902
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33698
33903
  * @example
33699
33904
  * ```javascript
33700
33905
  * // paste the floating objects with invoking command
@@ -33707,10 +33912,10 @@ declare module GC{
33707
33912
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33708
33913
  * @property {function} execute - performs an execute or undo operation.
33709
33914
  * The arguments of the execute method are as follows.
33710
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33711
- * @param {Object} options The options of the operation.
33712
- * @param {string} options.sheetName The sheet name.
33713
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33915
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33916
+ * @property {Object} options The options of the operation.
33917
+ * @property {string} options.sheetName The sheet name.
33918
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33714
33919
  * @example
33715
33920
  * ```javascript
33716
33921
  * //This example uses the redo command.
@@ -33723,11 +33928,11 @@ declare module GC{
33723
33928
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33724
33929
  * @property {function} execute - performs an execute or undo operation.
33725
33930
  * The arguments of the execute method are as follows.
33726
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33727
- * @param {Object} options The options of the operation.
33728
- * @param {string} options.sheetName The sheet name.
33729
- * @param {number} options.col The specified col.
33730
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33931
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33932
+ * @property {Object} options The options of the operation.
33933
+ * @property {string} options.sheetName The sheet name.
33934
+ * @property {number} options.col The specified col.
33935
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33731
33936
  * @example
33732
33937
  * ```javascript
33733
33938
  * //This example uses the remove column action.
@@ -33741,12 +33946,12 @@ declare module GC{
33741
33946
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33742
33947
  * @property {function} execute - performs an execute or undo operation.
33743
33948
  * The arguments of the execute method are as follows.
33744
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33745
- * @param {Object} options The options of the operation.
33746
- * @param {string} options.sheetName The sheet name.
33747
- * @param {number} options.index The outline starting index.
33748
- * @param {number} options.count The number of rows or columns to group or ungroup in the outline.
33749
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33949
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33950
+ * @property {Object} options The options of the operation.
33951
+ * @property {string} options.sheetName The sheet name.
33952
+ * @property {number} options.index The outline starting index.
33953
+ * @property {number} options.count The number of rows or columns to group or ungroup in the outline.
33954
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33750
33955
  * @example
33751
33956
  * ```javascript
33752
33957
  * // ungroup a column outline with invoking command
@@ -33759,12 +33964,12 @@ declare module GC{
33759
33964
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33760
33965
  * @property {function} execute - performs an execute or undo operation.
33761
33966
  * The arguments of the execute method are as follows.
33762
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33763
- * @param {Object} options The options of the operation.
33764
- * @param {string} options.sheetName The sheet name.
33765
- * @param {number} options.index The outline starting index.
33766
- * @param {number} options.count The number of rows or columns to group or ungroup in the outline.
33767
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33967
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33968
+ * @property {Object} options The options of the operation.
33969
+ * @property {string} options.sheetName The sheet name.
33970
+ * @property {number} options.index The outline starting index.
33971
+ * @property {number} options.count The number of rows or columns to group or ungroup in the outline.
33972
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33768
33973
  * @example
33769
33974
  * ```javascript
33770
33975
  * // ungroup a row outline with invoking command
@@ -33777,11 +33982,11 @@ declare module GC{
33777
33982
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33778
33983
  * @property {function} execute - performs an execute or undo operation.
33779
33984
  * The arguments of the execute method are as follows.
33780
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33781
- * @param {Object} options The options of the operation.
33782
- * @param {string} options.sheetName The sheet name.
33783
- * @param {string} options.name The sheet's new name.
33784
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33985
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
33986
+ * @property {Object} options The options of the operation.
33987
+ * @property {string} options.sheetName The sheet name.
33988
+ * @property {string} options.name The sheet's new name.
33989
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33785
33990
  * @example
33786
33991
  * ```javascript
33787
33992
  * //This example renames a sheet.
@@ -33794,13 +33999,13 @@ declare module GC{
33794
33999
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33795
34000
  * @property {function} execute - performs an execute or undo operation.
33796
34001
  * The arguments of the execute method are as follows.
33797
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33798
- * @param {Object} options The options of the operation.
33799
- * @param {string} options.sheetName The sheet name.
33800
- * @param {number} options.row The data chart row number.
33801
- * @param {number} options.col The data chart column number.
33802
- * @param {boolean} options.visible The data chart visible.
33803
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34002
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34003
+ * @property {Object} options The options of the operation.
34004
+ * @property {string} options.sheetName The sheet name.
34005
+ * @property {number} options.row The data chart row number.
34006
+ * @property {number} options.col The data chart column number.
34007
+ * @property {boolean} options.visible The data chart visible.
34008
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33804
34009
  * @example
33805
34010
  * ```javascript
33806
34011
  * // change the data chart preview visible in reportSheet while in Design mode with invoking command.
@@ -33813,12 +34018,12 @@ declare module GC{
33813
34018
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33814
34019
  * @property {function} execute - performs an execute or undo operation.
33815
34020
  * The arguments of the execute method are as follows.
33816
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33817
- * @param {Object} options The options of the operation.
33818
- * @param {string} options.sheetName The sheet name.
33819
- * @param {number} options.row The collapse button row.
33820
- * @param {number} options.col The collapse button col.
33821
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34021
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34022
+ * @property {Object} options The options of the operation.
34023
+ * @property {string} options.sheetName The sheet name.
34024
+ * @property {number} options.row The collapse button row.
34025
+ * @property {number} options.col The collapse button col.
34026
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33822
34027
  * @example
33823
34028
  * ```javascript
33824
34029
  * // toggle one collapse button with invoking command.
@@ -33831,12 +34036,12 @@ declare module GC{
33831
34036
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33832
34037
  * @property {function} execute - performs an execute or undo operation.
33833
34038
  * The arguments of the execute method are as follows.
33834
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33835
- * @param {Object} options The options of the operation.
33836
- * @param {string} options.sheetName The sheet name.
33837
- * @param {number} options.activeRow The add record active row number.
33838
- * @param {number} options.activeCol The add record active column number.
33839
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34039
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34040
+ * @property {Object} options The options of the operation.
34041
+ * @property {string} options.sheetName The sheet name.
34042
+ * @property {number} options.activeRow The add record active row number.
34043
+ * @property {number} options.activeCol The add record active column number.
34044
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33840
34045
  * @example
33841
34046
  * ```javascript
33842
34047
  * // add record in reportSheet while in DataEntry mode with invoking command.
@@ -33849,11 +34054,11 @@ declare module GC{
33849
34054
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33850
34055
  * @property {function} execute - performs an execute or undo operation.
33851
34056
  * The arguments of the execute method are as follows.
33852
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33853
- * @param {Object} options The options of the operation.
33854
- * @param {string} options.sheetName The sheet name.
33855
- * @param {GC.Spread.Sheets.Range[]} options.selections The collapse button selections.
33856
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34057
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34058
+ * @property {Object} options The options of the operation.
34059
+ * @property {string} options.sheetName The sheet name.
34060
+ * @property {GC.Spread.Sheets.Range[]} options.selections The collapse button selections.
34061
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33857
34062
  * @example
33858
34063
  * ```javascript
33859
34064
  * // collapse all collapse button while in DataEntry mode with invoking command.
@@ -33866,12 +34071,12 @@ declare module GC{
33866
34071
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33867
34072
  * @property {function} execute - performs an execute or undo operation.
33868
34073
  * The arguments of the execute method are as follows.
33869
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33870
- * @param {Object} options The options of the operation.
33871
- * @param {string} options.sheetName The sheet name.
33872
- * @param {number} options.activeRow The deleted record active row number.
33873
- * @param {number} options.activeCol The deleted record active column number.
33874
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34074
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34075
+ * @property {Object} options The options of the operation.
34076
+ * @property {string} options.sheetName The sheet name.
34077
+ * @property {number} options.activeRow The deleted record active row number.
34078
+ * @property {number} options.activeCol The deleted record active column number.
34079
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33875
34080
  * @example
33876
34081
  * ```javascript
33877
34082
  * // delete record in reportSheet while in DataEntry mode with invoking command.
@@ -33884,11 +34089,11 @@ declare module GC{
33884
34089
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33885
34090
  * @property {function} execute - performs an execute or undo operation.
33886
34091
  * The arguments of the execute method are as follows.
33887
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33888
- * @param {Object} options The options of the operation.
33889
- * @param {string} options.sheetName The sheet name.
33890
- * @param {GC.Spread.Sheets.Range[]} options.selections The collapse button selections.
33891
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34092
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34093
+ * @property {Object} options The options of the operation.
34094
+ * @property {string} options.sheetName The sheet name.
34095
+ * @property {GC.Spread.Sheets.Range[]} options.selections The collapse button selections.
34096
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33892
34097
  * @example
33893
34098
  * ```javascript
33894
34099
  * // expand all collapse button while in DataEntry mode with invoking command.
@@ -33901,10 +34106,10 @@ declare module GC{
33901
34106
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33902
34107
  * @property {function} execute - performs an execute or undo operation.
33903
34108
  * The arguments of the execute method are as follows.
33904
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33905
- * @param {Object} options The options of the operation.
33906
- * @param {string} options.sheetName The sheet name.
33907
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34109
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34110
+ * @property {Object} options The options of the operation.
34111
+ * @property {string} options.sheetName The sheet name.
34112
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33908
34113
  * @example
33909
34114
  * ```javascript
33910
34115
  * // regenerate reportSheet with invoking command.
@@ -33917,11 +34122,11 @@ declare module GC{
33917
34122
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33918
34123
  * @property {function} execute - performs an execute or undo operation.
33919
34124
  * The arguments of the execute method are as follows.
33920
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33921
- * @param {Object} options The options of the operation.
33922
- * @param {string} options.sheetName The sheet name.
33923
- * @param {GC.Spread.Sheets.Range[]} options.selections The reset value selections.
33924
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34125
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34126
+ * @property {Object} options The options of the operation.
34127
+ * @property {string} options.sheetName The sheet name.
34128
+ * @property {GC.Spread.Sheets.Range[]} options.selections The reset value selections.
34129
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33925
34130
  * @example
33926
34131
  * ```javascript
33927
34132
  * // reset all selected cells value while in DataEntry mode with invoking command.
@@ -33934,10 +34139,10 @@ declare module GC{
33934
34139
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33935
34140
  * @property {function} execute - performs an execute or undo operation.
33936
34141
  * The arguments of the execute method are as follows.
33937
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33938
- * @param {Object} options The options of the operation.
33939
- * @param {string} options.sheetName The sheet name.
33940
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34142
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34143
+ * @property {Object} options The options of the operation.
34144
+ * @property {string} options.sheetName The sheet name.
34145
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33941
34146
  * @example
33942
34147
  * ```javascript
33943
34148
  * // submit the data entry changes with invoking command.
@@ -33950,13 +34155,13 @@ declare module GC{
33950
34155
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33951
34156
  * @property {function} execute - performs an execute or undo operation.
33952
34157
  * The arguments of the execute method are as follows.
33953
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33954
- * @param {Object} options The options of the operation.
33955
- * @param {string} options.sheetName The sheet name.
33956
- * @param {Array} options.columns The resize columns; each item is an object which has firstCol and lastCol.
33957
- * @param {number} options.size The size of the column that is being resized.
33958
- * @param {boolean} options.rowHeader Whether the column being resized is in the row header area.
33959
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34158
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34159
+ * @property {Object} options The options of the operation.
34160
+ * @property {string} options.sheetName The sheet name.
34161
+ * @property {Array} options.columns The resize columns; each item is an object which has firstCol and lastCol.
34162
+ * @property {number} options.size The size of the column that is being resized.
34163
+ * @property {boolean} options.rowHeader Whether the column being resized is in the row header area.
34164
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33960
34165
  * @example
33961
34166
  * ```javascript
33962
34167
  * // resize the col with invoking command
@@ -33969,15 +34174,15 @@ declare module GC{
33969
34174
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33970
34175
  * @property {function} execute - performs an execute or undo operation.
33971
34176
  * The arguments of the execute method are as follows.
33972
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33973
- * @param {Object} options The options of the operation.
33974
- * @param {string} options.sheetName The sheet name.
33975
- * @param {Array} options.floatingObjects The names array of floating objects.
33976
- * @param {number} options.offsetX The offset left.
33977
- * @param {number} options.offsetY The offset top.
33978
- * @param {number} options.offsetWidth The offset width.
33979
- * @param {number} options.offsetHeight The offset height.
33980
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34177
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34178
+ * @property {Object} options The options of the operation.
34179
+ * @property {string} options.sheetName The sheet name.
34180
+ * @property {Array} options.floatingObjects The names array of floating objects.
34181
+ * @property {number} options.offsetX The offset left.
34182
+ * @property {number} options.offsetY The offset top.
34183
+ * @property {number} options.offsetWidth The offset width.
34184
+ * @property {number} options.offsetHeight The offset height.
34185
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
33981
34186
  * @example
33982
34187
  * ```javascript
33983
34188
  * // resize floating objects with invoking command
@@ -33990,13 +34195,13 @@ declare module GC{
33990
34195
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
33991
34196
  * @property {function} execute - performs an execute or undo operation.
33992
34197
  * The arguments of the execute method are as follows.
33993
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
33994
- * @param {Object} options The options of the operation.
33995
- * @param {string} options.sheetName The sheet name.
33996
- * @param {Array} options.rows The resize rows; each item is an object which has firstRow and lastRow.
33997
- * @param {number} options.size The size of the row that is being resized.
33998
- * @param {boolean} options.columnHeader Whether the row being resized is in the column header area.
33999
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34198
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34199
+ * @property {Object} options The options of the operation.
34200
+ * @property {string} options.sheetName The sheet name.
34201
+ * @property {Array} options.rows The resize rows; each item is an object which has firstRow and lastRow.
34202
+ * @property {number} options.size The size of the row that is being resized.
34203
+ * @property {boolean} options.columnHeader Whether the row being resized is in the column header area.
34204
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34000
34205
  * @example
34001
34206
  * ```javascript
34002
34207
  * // resize the row with invoking command
@@ -34009,10 +34214,10 @@ declare module GC{
34009
34214
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34010
34215
  * @property {function} execute - performs an execute or undo operation.
34011
34216
  * The arguments of the execute method are as follows.
34012
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34013
- * @param {Object} options The options of the operation.
34014
- * @param {string} options.sheetName The sheet name.
34015
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34217
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34218
+ * @property {Object} options The options of the operation.
34219
+ * @property {string} options.sheetName The sheet name.
34220
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34016
34221
  * @example
34017
34222
  * ```javascript
34018
34223
  * //This example uses the selectionBottom action.
@@ -34025,10 +34230,10 @@ declare module GC{
34025
34230
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34026
34231
  * @property {function} execute - performs an execute or undo operation.
34027
34232
  * The arguments of the execute method are as follows.
34028
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34029
- * @param {Object} options The options of the operation.
34030
- * @param {string} options.sheetName The sheet name.
34031
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34233
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34234
+ * @property {Object} options The options of the operation.
34235
+ * @property {string} options.sheetName The sheet name.
34236
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34032
34237
  * @example
34033
34238
  * ```javascript
34034
34239
  * //This example uses the selectionDown action.
@@ -34041,10 +34246,10 @@ declare module GC{
34041
34246
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34042
34247
  * @property {function} execute - performs an execute or undo operation.
34043
34248
  * The arguments of the execute method are as follows.
34044
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34045
- * @param {Object} options The options of the operation.
34046
- * @param {string} options.sheetName The sheet name.
34047
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34249
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34250
+ * @property {Object} options The options of the operation.
34251
+ * @property {string} options.sheetName The sheet name.
34252
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34048
34253
  * @example
34049
34254
  * ```javascript
34050
34255
  * //This example uses the selectionEnd action.
@@ -34058,10 +34263,10 @@ declare module GC{
34058
34263
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34059
34264
  * @property {function} execute - performs an execute or undo operation.
34060
34265
  * The arguments of the execute method are as follows.
34061
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34062
- * @param {Object} options The options of the operation.
34063
- * @param {string} options.sheetName The sheet name.
34064
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34266
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34267
+ * @property {Object} options The options of the operation.
34268
+ * @property {string} options.sheetName The sheet name.
34269
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34065
34270
  * @example
34066
34271
  * ```javascript
34067
34272
  * //This example uses the selectionFirst action.
@@ -34075,10 +34280,10 @@ declare module GC{
34075
34280
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34076
34281
  * @property {function} execute - performs an execute or undo operation.
34077
34282
  * The arguments of the execute method are as follows.
34078
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34079
- * @param {Object} options The options of the operation.
34080
- * @param {string} options.sheetName The sheet name.
34081
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34283
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34284
+ * @property {Object} options The options of the operation.
34285
+ * @property {string} options.sheetName The sheet name.
34286
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34082
34287
  * @example
34083
34288
  * ```javascript
34084
34289
  * //This example uses the selectionHome action.
@@ -34092,10 +34297,10 @@ declare module GC{
34092
34297
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34093
34298
  * @property {function} execute - performs an execute or undo operation.
34094
34299
  * The arguments of the execute method are as follows.
34095
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34096
- * @param {Object} options The options of the operation.
34097
- * @param {string} options.sheetName The sheet name.
34098
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34300
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34301
+ * @property {Object} options The options of the operation.
34302
+ * @property {string} options.sheetName The sheet name.
34303
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34099
34304
  * @example
34100
34305
  * ```javascript
34101
34306
  * //This example uses the selectionLast action.
@@ -34109,10 +34314,10 @@ declare module GC{
34109
34314
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34110
34315
  * @property {function} execute - performs an execute or undo operation.
34111
34316
  * The arguments of the execute method are as follows.
34112
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34113
- * @param {Object} options The options of the operation.
34114
- * @param {string} options.sheetName The sheet name.
34115
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34317
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34318
+ * @property {Object} options The options of the operation.
34319
+ * @property {string} options.sheetName The sheet name.
34320
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34116
34321
  * @example
34117
34322
  * ```javascript
34118
34323
  * //This example uses the selectionLeft action.
@@ -34125,10 +34330,10 @@ declare module GC{
34125
34330
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34126
34331
  * @property {function} execute - performs an execute or undo operation.
34127
34332
  * The arguments of the execute method are as follows.
34128
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34129
- * @param {Object} options The options of the operation.
34130
- * @param {string} options.sheetName The sheet name.
34131
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34333
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34334
+ * @property {Object} options The options of the operation.
34335
+ * @property {string} options.sheetName The sheet name.
34336
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34132
34337
  * @example
34133
34338
  * ```javascript
34134
34339
  * //This example uses the selectionPageDown action.
@@ -34141,10 +34346,10 @@ declare module GC{
34141
34346
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34142
34347
  * @property {function} execute - performs an execute or undo operation.
34143
34348
  * The arguments of the execute method are as follows.
34144
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34145
- * @param {Object} options The options of the operation.
34146
- * @param {string} options.sheetName The sheet name.
34147
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34349
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34350
+ * @property {Object} options The options of the operation.
34351
+ * @property {string} options.sheetName The sheet name.
34352
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34148
34353
  * @example
34149
34354
  * ```javascript
34150
34355
  * //This example uses the selectionPageUp action.
@@ -34157,10 +34362,10 @@ declare module GC{
34157
34362
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34158
34363
  * @property {function} execute - performs an execute or undo operation.
34159
34364
  * The arguments of the execute method are as follows.
34160
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34161
- * @param {Object} options The options of the operation.
34162
- * @param {string} options.sheetName The sheet name.
34163
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34365
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34366
+ * @property {Object} options The options of the operation.
34367
+ * @property {string} options.sheetName The sheet name.
34368
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34164
34369
  * @example
34165
34370
  * ```javascript
34166
34371
  * //This example uses the selectionRight action.
@@ -34173,10 +34378,10 @@ declare module GC{
34173
34378
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34174
34379
  * @property {function} execute - performs an execute or undo operation.
34175
34380
  * The arguments of the execute method are as follows.
34176
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34177
- * @param {Object} options The options of the operation.
34178
- * @param {string} options.sheetName The sheet name.
34179
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34381
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34382
+ * @property {Object} options The options of the operation.
34383
+ * @property {string} options.sheetName The sheet name.
34384
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34180
34385
  * @example
34181
34386
  * ```javascript
34182
34387
  * //This example uses the selectionTop action.
@@ -34189,10 +34394,10 @@ declare module GC{
34189
34394
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34190
34395
  * @property {function} execute - performs an execute or undo operation.
34191
34396
  * The arguments of the execute method are as follows.
34192
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34193
- * @param {Object} options The options of the operation.
34194
- * @param {string} options.sheetName The sheet name.
34195
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34397
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34398
+ * @property {Object} options The options of the operation.
34399
+ * @property {string} options.sheetName The sheet name.
34400
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34196
34401
  * @example
34197
34402
  * ```javascript
34198
34403
  * //This example uses the selectionUp action.
@@ -34205,10 +34410,10 @@ declare module GC{
34205
34410
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34206
34411
  * @property {function} execute - performs an execute or undo operation.
34207
34412
  * The arguments of the execute method are as follows.
34208
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34209
- * @param {Object} options The options of the operation.
34210
- * @param {string} options.sheetName The sheet name.
34211
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34413
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34414
+ * @property {Object} options The options of the operation.
34415
+ * @property {string} options.sheetName The sheet name.
34416
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34212
34417
  * @example
34213
34418
  * ```javascript
34214
34419
  * //This example maps the selectNextControl action to the Tab key.
@@ -34222,10 +34427,10 @@ declare module GC{
34222
34427
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34223
34428
  * @property {function} execute - performs an execute or undo operation.
34224
34429
  * The arguments of the execute method are as follows.
34225
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34226
- * @param {Object} options The options of the operation.
34227
- * @param {string} options.sheetName The sheet name.
34228
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34430
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34431
+ * @property {Object} options The options of the operation.
34432
+ * @property {string} options.sheetName The sheet name.
34433
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34229
34434
  * @example
34230
34435
  * ```javascript
34231
34436
  * //This example maps the selectPreviousControl action to the Shift + Tab key combination.
@@ -34239,13 +34444,13 @@ declare module GC{
34239
34444
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34240
34445
  * @property {function} execute - performs an execute or undo operation.
34241
34446
  * The arguments of the execute method are as follows.
34242
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34243
- * @param {Object} options The options of the operation.
34244
- * @param {string} options.sheetName The sheet name.
34245
- * @param {Array} options.columns The resize columns; each item is an object which has firstCol and lastCol.
34246
- * @param {number} options.size The size of the column that is being resized.
34247
- * @param {boolean} options.rowHeader Whether the column being resized is in the row header area.
34248
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34447
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34448
+ * @property {Object} options The options of the operation.
34449
+ * @property {string} options.sheetName The sheet name.
34450
+ * @property {Array} options.columns The resize columns; each item is an object which has firstCol and lastCol.
34451
+ * @property {number} options.size The size of the column that is being resized.
34452
+ * @property {boolean} options.rowHeader Whether the column being resized is in the row header area.
34453
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34249
34454
  * @example
34250
34455
  * ```javascript
34251
34456
  * // split resize the column with invoking command
@@ -34258,13 +34463,13 @@ declare module GC{
34258
34463
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34259
34464
  * @property {function} execute - performs an execute or undo operation.
34260
34465
  * The arguments of the execute method are as follows.
34261
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34262
- * @param {Object} options The options of the operation.
34263
- * @param {string} options.sheetName The sheet name.
34264
- * @param {Array} options.rows The resize rows; each item is an object which has firstRow and lastRow.
34265
- * @param {number} options.size The size of the row that is being resized.
34266
- * @param {boolean} options.columnHeader Whether the row being resized is in the column header area.
34267
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34466
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34467
+ * @property {Object} options The options of the operation.
34468
+ * @property {string} options.sheetName The sheet name.
34469
+ * @property {Array} options.rows The resize rows; each item is an object which has firstRow and lastRow.
34470
+ * @property {number} options.size The size of the row that is being resized.
34471
+ * @property {boolean} options.columnHeader Whether the row being resized is in the column header area.
34472
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34268
34473
  * @example
34269
34474
  * ```javascript
34270
34475
  * // split resize the row with invoking command
@@ -34277,10 +34482,10 @@ declare module GC{
34277
34482
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34278
34483
  * @property {function} execute - performs an execute or undo operation.
34279
34484
  * The arguments of the execute method are as follows.
34280
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34281
- * @param {Object} options The options of the operation.
34282
- * @param {string} options.sheetName The sheet name.
34283
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34485
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34486
+ * @property {Object} options The options of the operation.
34487
+ * @property {string} options.sheetName The sheet name.
34488
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34284
34489
  * @example
34285
34490
  * ```javascript
34286
34491
  * // start editing a cell with invoking command
@@ -34293,13 +34498,13 @@ declare module GC{
34293
34498
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34294
34499
  * @property {function} execute - performs an execute or undo operation.
34295
34500
  * The arguments of the execute method are as follows.
34296
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34297
- * @param {Object} options The options of the operation.
34298
- * @param {string} options.sheetName The sheet name.
34299
- * @param {string} options.tableName The table name.
34300
- * @param {number} options.col The index of the starting column to delete, the col index is based on table index.
34301
- * @param {number} options.count The number of columns to delete.
34302
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34501
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34502
+ * @property {Object} options The options of the operation.
34503
+ * @property {string} options.sheetName The sheet name.
34504
+ * @property {string} options.tableName The table name.
34505
+ * @property {number} options.col The index of the starting column to delete, the col index is based on table index.
34506
+ * @property {number} options.count The number of columns to delete.
34507
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34303
34508
  * @example
34304
34509
  * ```javascript
34305
34510
  * // delete columns for table with invoking command
@@ -34312,13 +34517,13 @@ declare module GC{
34312
34517
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34313
34518
  * @property {function} execute - performs an execute or undo operation.
34314
34519
  * The arguments of the execute method are as follows.
34315
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34316
- * @param {Object} options The options of the operation.
34317
- * @param {string} options.sheetName The sheet name.
34318
- * @param {string} options.tableName The table name.
34319
- * @param {number} options.row The index of the starting row to delete, the row index is based on table index.
34320
- * @param {number} options.count The number of rows to delete.
34321
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34520
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34521
+ * @property {Object} options The options of the operation.
34522
+ * @property {string} options.sheetName The sheet name.
34523
+ * @property {string} options.tableName The table name.
34524
+ * @property {number} options.row The index of the starting row to delete, the row index is based on table index.
34525
+ * @property {number} options.count The number of rows to delete.
34526
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34322
34527
  * @example
34323
34528
  * ```javascript
34324
34529
  * // delete rows for table with invoking command
@@ -34331,13 +34536,13 @@ declare module GC{
34331
34536
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34332
34537
  * @property {function} execute - performs an execute or undo operation.
34333
34538
  * The arguments of the execute method are as follows.
34334
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34335
- * @param {Object} options The options of the operation.
34336
- * @param {string} options.sheetName The sheet name.
34337
- * @param {string} options.tableName The table name.
34338
- * @param {number} options.col The index of the starting column to insert, the col index is based on table index.
34339
- * @param {number} options.count The number of columns to insert.
34340
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34539
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34540
+ * @property {Object} options The options of the operation.
34541
+ * @property {string} options.sheetName The sheet name.
34542
+ * @property {string} options.tableName The table name.
34543
+ * @property {number} options.col The index of the starting column to insert, the col index is based on table index.
34544
+ * @property {number} options.count The number of columns to insert.
34545
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34341
34546
  * @example
34342
34547
  * ```javascript
34343
34548
  * // insert columns for table with invoking command
@@ -34350,13 +34555,13 @@ declare module GC{
34350
34555
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34351
34556
  * @property {function} execute - performs an execute or undo operation.
34352
34557
  * The arguments of the execute method are as follows.
34353
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34354
- * @param {Object} options The options of the operation.
34355
- * @param {string} options.sheetName The sheet name.
34356
- * @param {string} options.tableName The table name.
34357
- * @param {number} options.row The index of the starting row to insert, the row index is based on table index.
34358
- * @param {number} options.count The number of rows to insert.
34359
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34558
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34559
+ * @property {Object} options The options of the operation.
34560
+ * @property {string} options.sheetName The sheet name.
34561
+ * @property {string} options.tableName The table name.
34562
+ * @property {number} options.row The index of the starting row to insert, the row index is based on table index.
34563
+ * @property {number} options.count The number of rows to insert.
34564
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34360
34565
  * @example
34361
34566
  * ```javascript
34362
34567
  * // insert rows for table with invoking command
@@ -34369,12 +34574,12 @@ declare module GC{
34369
34574
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34370
34575
  * @property {function} execute - performs an execute or undo operation.
34371
34576
  * The arguments of the execute method are as follows.
34372
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34373
- * @param {Object} options The options of the operation.
34374
- * @param {string} options.sheetName The sheet name.
34375
- * @param {string} options.tableName The table name.
34376
- * @param {GC.Spread.Sheets.Range} options.resizeToRange The resized table range.
34377
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34577
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34578
+ * @property {Object} options The options of the operation.
34579
+ * @property {string} options.sheetName The sheet name.
34580
+ * @property {string} options.tableName The table name.
34581
+ * @property {GC.Spread.Sheets.Range} options.resizeToRange The resized table range.
34582
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34378
34583
  * @example
34379
34584
  * ```javascript
34380
34585
  * // resize table with invoking command
@@ -34387,11 +34592,11 @@ declare module GC{
34387
34592
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34388
34593
  * @property {function} execute - performs an execute or undo operation.
34389
34594
  * The arguments of the execute method are as follows.
34390
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34391
- * @param {Object} options The options of the operation.
34392
- * @param {string} [options.sheetName] The sheet name, from active sheet by default.
34393
- * @param {string[]} [options.tableNames] The table names, from active table by default.
34394
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34595
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34596
+ * @property {Object} options The options of the operation.
34597
+ * @property {string} [options.sheetName] The sheet name, from active sheet by default.
34598
+ * @property {string[]} [options.tableNames] The table names, from active table by default.
34599
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34395
34600
  * @example
34396
34601
  * ```javascript
34397
34602
  * // submit changes of the tables which bind the data manager tables with invoking command
@@ -34404,10 +34609,10 @@ declare module GC{
34404
34609
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34405
34610
  * @property {function} execute - performs an execute or undo operation.
34406
34611
  * The arguments of the execute method are as follows.
34407
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34408
- * @param {Object} options The options of the operation.
34409
- * @param {string} options.sheetName The sheet name.
34410
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34612
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34613
+ * @property {Object} options The options of the operation.
34614
+ * @property {string} options.sheetName The sheet name.
34615
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34411
34616
  * @example
34412
34617
  * ```javascript
34413
34618
  * //This example uses the undo command.
@@ -34420,11 +34625,11 @@ declare module GC{
34420
34625
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
34421
34626
  * @property {function} execute - performs an execute or undo operation.
34422
34627
  * The arguments of the execute method are as follows.
34423
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34424
- * @param {Object} options The options of the operation.
34425
- * @param {string} options.sheetName The sheet name.
34426
- * @param {number} options.zoomFactor The zoom factor.
34427
- * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34628
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34629
+ * @property {Object} options The options of the operation.
34630
+ * @property {string} options.sheetName The sheet name.
34631
+ * @property {number} options.zoomFactor The zoom factor.
34632
+ * @property {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
34428
34633
  * @example
34429
34634
  * ```javascript
34430
34635
  * // zoom the sheet with invoking command
@@ -34434,9 +34639,9 @@ declare module GC{
34434
34639
  var zoom: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, zoomFactor: number}, isUndo: boolean): any};
34435
34640
  /**
34436
34641
  * Ends a transaction. During the transaction, the changes of the data model will be saved.
34437
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34438
- * @param {Object} options The options of the operation.
34439
- * @param {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34642
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34643
+ * @property {Object} options The options of the operation.
34644
+ * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34440
34645
  * @example
34441
34646
  * ```javascript
34442
34647
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -34467,9 +34672,9 @@ declare module GC{
34467
34672
  function endTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
34468
34673
  /**
34469
34674
  * Starts a transaction. During the transaction, the changes of the data model will be saved.
34470
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34471
- * @param {Object} options The options of the operation.
34472
- * @param {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34675
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34676
+ * @property {Object} options The options of the operation.
34677
+ * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34473
34678
  * @example
34474
34679
  * ```javascript
34475
34680
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -34500,9 +34705,9 @@ declare module GC{
34500
34705
  function startTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
34501
34706
  /**
34502
34707
  * Undo the changes made in a transaction.
34503
- * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
34504
- * @param {Object} options The options of the operation.
34505
- * @param {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34708
+ * @property {GC.Spread.Sheets.Workbook} context The context of the operation.
34709
+ * @property {Object} options The options of the operation.
34710
+ * @property {string|string[]} [options.sheetName] The sheet name. If the current transaction need change multiple worksheets, the sheetName could be a string Array.
34506
34711
  * @example
34507
34712
  * ```javascript
34508
34713
  * //For example, the following code registers the changeBackColor command and then executes the command.
@@ -38592,14 +38797,20 @@ declare module GC{
38592
38797
  * // add a row state rule with red back color in whole sheet
38593
38798
  * var style = new GC.Spread.Sheets.Style();
38594
38799
  * style.backColor = "red";
38595
- * var stateRule = new GC.Spread.Sheets.ConditionalFormatting.StateRule(GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule, style, [new GC.Spread.Sheets.Range(-1, -1, -1, -1)]);
38596
- * activeSheet.conditionalFormats.addRule(cell);
38597
- * // add a row state rule with two styles to different corresponding ranges
38598
38800
  * var stateRule = new GC.Spread.Sheets.ConditionalFormatting.StateRule(
38599
38801
  * GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule,
38802
+ * GC.Spread.Sheets.RowColumnStates.active,
38803
+ * style, [new GC.Spread.Sheets.Range(-1, -1, -1, -1)]
38804
+ * );
38805
+ * activeSheet.conditionalFormats.addRule(stateRule);
38806
+ * // add a row state rule with two styles to different corresponding ranges
38807
+ * var stateRule2 = new GC.Spread.Sheets.ConditionalFormatting.StateRule(
38808
+ * GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule,
38809
+ * GC.Spread.Sheets.RowColumnStates.dirty,
38600
38810
  * [new GC.Spread.Sheets.Style("green"), new GC.Spread.Sheets.Style("red")],
38601
38811
  * [new GC.Spread.Sheets.Range(1, 1, 10, 5), new GC.Spread.Sheets.Range(1, 7, 10, 5)]
38602
38812
  * );
38813
+ * activeSheet.conditionalFormats.addRule(stateRule2);
38603
38814
  * ```
38604
38815
  */
38605
38816
  constructor(ruleType: GC.Spread.Sheets.ConditionalFormatting.RuleType, state: GC.Spread.Sheets.RowColumnStates, style?: GC.Spread.Sheets.Style | GC.Spread.Sheets.Style[], ranges?: GC.Spread.Sheets.Range[]);
@@ -39070,6 +39281,16 @@ declare module GC{
39070
39281
  }
39071
39282
 
39072
39283
 
39284
+ export interface IFunnelOption{
39285
+ funnelType?: GC.Spread.Sheets.DataCharts.FunnelType;
39286
+ topWidth?: number;
39287
+ bottomWidth?: number;
39288
+ neckHeight?: number;
39289
+ orientation?: GC.Spread.Sheets.DataCharts.Orientation;
39290
+ reversed?: boolean;
39291
+ }
39292
+
39293
+
39073
39294
  export interface IHeaderOption{
39074
39295
  title?: string;
39075
39296
  textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
@@ -39156,6 +39377,7 @@ declare module GC{
39156
39377
  tooltip?: GC.Spread.Sheets.DataCharts.IPlotConfigTooltipOption[];
39157
39378
  hoverAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
39158
39379
  updateAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
39380
+ funnel?: GC.Spread.Sheets.DataCharts.IFunnelOption;
39159
39381
  }
39160
39382
 
39161
39383
 
@@ -39678,7 +39900,15 @@ declare module GC{
39678
39900
  /**
39679
39901
  * Identifies the current DataChart type as bubble
39680
39902
  */
39681
- bubble= "Bubble"
39903
+ bubble= "Bubble",
39904
+ /**
39905
+ * Identifies the current DataChart type as treemap
39906
+ */
39907
+ treemap= "Treemap",
39908
+ /**
39909
+ * Identifies the current DataChart type as funnel
39910
+ */
39911
+ funnel= "Funnel"
39682
39912
  }
39683
39913
 
39684
39914
  /**
@@ -39778,6 +40008,25 @@ declare module GC{
39778
40008
  trillions= "Trillions"
39779
40009
  }
39780
40010
 
40011
+ /**
40012
+ * Specifies the datachart funnel type.
40013
+ * @enum {string}
40014
+ */
40015
+ export enum FunnelType{
40016
+ /**
40017
+ * default
40018
+ */
40019
+ default= "Default",
40020
+ /**
40021
+ * bar
40022
+ */
40023
+ bar= "Bar",
40024
+ /**
40025
+ * pyramid
40026
+ */
40027
+ pyramid= "Pyramid"
40028
+ }
40029
+
39781
40030
  /**
39782
40031
  * Specifies the datachart plot HAlign.
39783
40032
  * @enum {string}
@@ -39892,6 +40141,21 @@ declare module GC{
39892
40141
  none= "None"
39893
40142
  }
39894
40143
 
40144
+ /**
40145
+ * Specifies the datachart orientation.
40146
+ * @enum {string}
40147
+ */
40148
+ export enum Orientation{
40149
+ /**
40150
+ * horizontal
40151
+ */
40152
+ horizontal= "Horizontal",
40153
+ /**
40154
+ * vertical
40155
+ */
40156
+ vertical= "Vertical"
40157
+ }
40158
+
39895
40159
  /**
39896
40160
  * Specifies the datachart plot OverlappingLabels.
39897
40161
  * @enum {string}
@@ -47784,7 +48048,7 @@ declare module GC{
47784
48048
  */
47785
48049
  font?: string;
47786
48050
  margins?: [number, number, number, number];
47787
- textDirection?: "horizontal" | "vertical" | "rotate90" | "rotate270";
48051
+ textDirection?: GC.Spread.Sheets.Shapes.TextDirection;
47788
48052
  /**
47789
48053
  * 0: left, 1: center, 2: right
47790
48054
  */
@@ -47812,6 +48076,10 @@ declare module GC{
47812
48076
  * Resize the shape to fit text size.
47813
48077
  */
47814
48078
  resizeToFitText?: boolean | string;
48079
+ /**
48080
+ * The text direction, it is TextDirection enum or formula(starts with =).
48081
+ */
48082
+ textDirection?: GC.Spread.Sheets.Shapes.TextDirection | string;
47815
48083
  }
47816
48084
 
47817
48085
 
@@ -49110,6 +49378,49 @@ declare module GC{
49110
49378
  shape= 2
49111
49379
  }
49112
49380
 
49381
+ /**
49382
+ * Defines text direction of the shape.
49383
+ * @enum {number}
49384
+ * @example
49385
+ * ```javascript
49386
+ * //This sample sets the textDirection for the shape.
49387
+ * var rectangleShape = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 60, 200, 160);
49388
+ * var oldStyle = rectangleShape.style();
49389
+ * oldStyle.textFrame.textDirection = GC.Spread.Sheets.Shapes.TextDirection.wordArtVertRtl;
49390
+ * rectangleShape.style(oldStyle);
49391
+ * ```
49392
+ */
49393
+ export enum TextDirection{
49394
+ /** Specifies that text display as horizontal.
49395
+ * @type {number}
49396
+ */
49397
+ horz= 0,
49398
+ /** Specifies that text display as Vertical 90 deg.
49399
+ * @type {number}
49400
+ */
49401
+ vert= 1,
49402
+ /** Specifies that text display as Vertical 270 deg.
49403
+ * @type {number}
49404
+ */
49405
+ vert270= 2,
49406
+ /** Specifies that text display as Word Art Vertical Left to Right.
49407
+ * @type {number}
49408
+ */
49409
+ wordArtVert= 3,
49410
+ /** Specifies that text display as East Asian Vertical Right to Left.
49411
+ * @type {number}
49412
+ */
49413
+ eaVert= 4,
49414
+ /** Specifies that text display as East Asian Vertical Left to Right.
49415
+ * @type {number}
49416
+ */
49417
+ eaVertLtr= 5,
49418
+ /** Specifies that text display as Word Art Vertical Right to Left.
49419
+ * @type {number}
49420
+ */
49421
+ wordArtVertRtl= 6
49422
+ }
49423
+
49113
49424
  /**
49114
49425
  * Defines texture fill aligmnet of shape.
49115
49426
  * @enum {number}
@@ -56894,6 +57205,28 @@ declare module GC{
56894
57205
  * ```
56895
57206
  */
56896
57207
  footerIndex(): number;
57208
+ /**
57209
+ * Gets the table binding source if it bound.
57210
+ * @returns {object | GC.Data.Table | null} The table binding source.
57211
+ * @example
57212
+ * ```javascript
57213
+ * // if binding an object
57214
+ * const source = [
57215
+ * { LastName: "Freehafer", FirstName: "Nancy", Title: "Sales Representative", Phone: "(123)555-0100"},
57216
+ * { LastName: "Cencini", FirstName: "Andrew", Title: "Vice President, Sales", Phone: "(123)555-0101"},
57217
+ * { LastName: "Kotas", FirstName: "Jan", Title: "Sales Representative", Phone: "(123)555-0102"},
57218
+ * { LastName: "Sergienko", FirstName: "Mariya", Title: "Sales Representative", Phone: "(123)555-0103"},
57219
+ * ];
57220
+ * const table = activeSheet.tables.addFromDataSource("Table1", 5, 2, source, GC.Spread.Sheets.Tables.TableThemes.dark1);
57221
+ * // the bindingSource will be the source
57222
+ * const bindingSource = table.getBindingSource();
57223
+ * // if binding a data manager table, it will return the table
57224
+ * const table = activeSheet.tables.addFromDataSource("Table1", 5, 2, "products", GC.Spread.Sheets.Tables.TableThemes.dark1);
57225
+ * // the bindingTable will be the data manager table
57226
+ * const bindingTable = table.getBindingSource();
57227
+ * ```
57228
+ */
57229
+ getBindingSource(): object | GC.Data.Table | null;
56897
57230
  /**
56898
57231
  * Gets the table column data field with the specified table column index.
56899
57232
  * @param {number} tableColumnIndex - The column index of the table. The index is zero-based.
@@ -57512,6 +57845,28 @@ declare module GC{
57512
57845
  * @returns {GC.Spread.Sheets.Tables.Table[]} The GC.Spread.Sheets.Tables.Table array of table instances. The array is never null.
57513
57846
  */
57514
57847
  all(): GC.Spread.Sheets.Tables.Table[];
57848
+ /**
57849
+ * Converts the table binding a data manager table to a regular table.
57850
+ * @param {GC.Spread.Sheets.Tables.Table|string} table The table instance or the table name.
57851
+ * @returns {GC.Spread.Sheets.Tables.Table}
57852
+ * @example
57853
+ * ```javascript
57854
+ * var table = activeSheet.tables.find(0,0);
57855
+ * activeSheet.tables.convertFromDataTable(table);
57856
+ * ```
57857
+ */
57858
+ convertFromDataTable(table: GC.Spread.Sheets.Tables.Table | string): GC.Spread.Sheets.Tables.Table;
57859
+ /**
57860
+ * Convert a regular table to the table creating and binding a data manager table.
57861
+ * @param {GC.Spread.Sheets.Tables.Table|string} table The table instance or the table name.
57862
+ * @returns {GC.Spread.Sheets.Tables.Table}
57863
+ * @example
57864
+ * ```javascript
57865
+ * var table = activeSheet.tables.find(0,0);
57866
+ * activeSheet.tables.convertToDataTable(table);
57867
+ * ```
57868
+ */
57869
+ convertToDataTable(table: GC.Spread.Sheets.Tables.Table | string): GC.Spread.Sheets.Tables.Table;
57515
57870
  /**
57516
57871
  * Gets the table of the specified cell.
57517
57872
  * @param {number} row The row index.