@mescius/spread-sheets 17.1.10 → 18.0.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.
@@ -8104,6 +8104,36 @@ declare module GC{
8104
8104
  * ```
8105
8105
  */
8106
8106
  subtotalType(fieldName: string, type?:GC.Pivot.SubtotalType): GC.Pivot.SubtotalType | void;
8107
+ /**
8108
+ * @description set or get whether the field displays subtotal information.
8109
+ * @param {string} fieldName Indicates the field name.
8110
+ * @param {boolean} position Indicates whether to display subtotal information for the field.
8111
+ * @returns {boolean}
8112
+ * @example
8113
+ * ```
8114
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
8115
+ * var sourceSheet = spread.getSheet(0)
8116
+ * var sheet = spread.getSheet(1);
8117
+ * var sourceData = [["Date","Buyer","Type","Amount"],
8118
+ * ["01-Jan","Mom","Fuel",74],
8119
+ * ["15-Jan","Mom","Food",235],
8120
+ * ["17-Jan","Dad","Sports",20],
8121
+ * ["21-Jan","Kelly","Books",125]];
8122
+ * sourceSheet.setArray(0, 0, sourceData);
8123
+ * sourceSheet.tables.add('sourceData', 0, 0, 5, 4);
8124
+ * var layout = GC.Spread.Pivot.PivotTableLayoutType.compact;
8125
+ * var theme = GC.Spread.Pivot.PivotTableThemes.medium2;
8126
+ * var options = {showRowHeader: true, showColumnHeader: true};
8127
+ * sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme, options);
8128
+ * var pivotTable = sheet.pivotTables.get("pivotTable_1");
8129
+ * pivotTable.add("Date","Date",GC.Spread.Pivot.PivotTableFieldType.rowField);
8130
+ * pivotTable.add("Buyer","Buyer",GC.Spread.Pivot.PivotTableFieldType.rowField);
8131
+ * pivotTable.add("Type","Type",GC.Spread.Pivot.PivotTableFieldType.columnField);
8132
+ * pivotTable.add("Amount","Sum of Amount",GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
8133
+ * pivotTable.subtotalVisible("Buyer", false);
8134
+ * ```
8135
+ */
8136
+ subtotalVisible(fieldName: string, isVisible: boolean): boolean;
8107
8137
  /**
8108
8138
  * @description Stop update field util resumeFieldsLayout, it must be used in pairs with resumeFieldsLayout.
8109
8139
  */
@@ -8284,9 +8314,17 @@ declare module GC{
8284
8314
  * pivotTable.add("Amount","Sum of Amount",GC.Spread.Pivot.PivotTableFieldType.valueField, GC.Pivot.SubtotalType.sum);
8285
8315
  * sourceSheet.setValue(1,3,1000);
8286
8316
  * pivotTable.updateSource();
8317
+ * var newSourceData = [["Salesman","ProductType","Product","Sales"],
8318
+ * ["SunLin","Drinks","Apple Juice",74],
8319
+ * ["JinShiPeng","Drinks","Milk",235],
8320
+ * ["ZhangShang","Dessert","Chocolate",20],
8321
+ * ["SunYang","Dessert","Beef Jerky",125]];
8322
+ * sourceSheet.setArray(10, 0, newSourceData);
8323
+ * sourceSheet.tables.add('newSourceData', 10, 0, 5, 4);
8324
+ * pivotTable.updateSource('newSourceData');
8287
8325
  * ```
8288
8326
  */
8289
- updateSource(): void;
8327
+ updateSource(source?: string): void;
8290
8328
  /**
8291
8329
  * Get or set value filter info for a field.
8292
8330
  * @param {string} fieldName Indicates the target field name of pivot table.
@@ -11134,6 +11172,7 @@ declare module GC{
11134
11172
  filter?: GC.Spread.Report.IFilter;
11135
11173
  sortOptions?: GC.Spread.Report.SortOption[];
11136
11174
  showCollapseButton?: boolean;
11175
+ initialExpansionState?: 'Expanded' | 'Collapsed';
11137
11176
  alias?: string;
11138
11177
  autoExpand?: 'Both' | 'Horizontal' | 'Vertical' | 'None';
11139
11178
  }
@@ -11357,6 +11396,14 @@ declare module GC{
11357
11396
  }
11358
11397
 
11359
11398
 
11399
+ /**
11400
+ * @typedef GC.Spread.Report.ChartCell
11401
+ * @type {{type: 'Chart'; dataChartName: string;chartPreviewVisible: boolean;}}
11402
+ */
11403
+ export type ChartCell =
11404
+ {type: 'Chart'; dataChartName: string; chartPreviewVisible?: boolean;}
11405
+
11406
+
11360
11407
  /**
11361
11408
  * @typedef GC.Spread.Report.ConditionRule
11362
11409
  * @type {{ column: string; operator: GC.Spread.Report.ConditionRuleOperator; } & (GC.Spread.Report.IConditionRuleValueType | GC.Spread.Report.IConditionRuleCellType | GC.Spread.Report.IConditionRuleDataColumnType | GC.Spread.Report.IConditionRuleParameterType | GC.Spread.Report.IConditionRuleFormulaType)}
@@ -11505,10 +11552,10 @@ declare module GC{
11505
11552
 
11506
11553
  /**
11507
11554
  * @typedef GC.Spread.Report.StaticCell
11508
- * @type {{type: 'Static'; pin?: 'None' | 'Row' | 'Column' | 'Both'; autoExpand?: 'Both' | 'Horizontal' | 'Vertical' | 'None'; showCollapseButton?: boolean;}}
11555
+ * @type {{type: 'Static'; pin?: 'None' | 'Row' | 'Column' | 'Both'; autoExpand?: 'Both' | 'Horizontal' | 'Vertical' | 'None'; showCollapseButton?: boolean; initialExpansionState?: 'Expanded' | 'Collapsed';}}
11509
11556
  */
11510
11557
  export type StaticCell =
11511
- {type: 'Static'; pin?: 'None' | 'Row' | 'Column' | 'Both'; autoExpand?: 'Both' | 'Horizontal' | 'Vertical' | 'None'; showCollapseButton?: boolean;}
11558
+ {type: 'Static'; pin?: 'None' | 'Row' | 'Column' | 'Both'; autoExpand?: 'Both' | 'Horizontal' | 'Vertical' | 'None'; showCollapseButton?: boolean; initialExpansionState?: 'Expanded' | 'Collapsed';}
11512
11559
 
11513
11560
 
11514
11561
  /**
@@ -11529,10 +11576,10 @@ declare module GC{
11529
11576
 
11530
11577
  /**
11531
11578
  * @typedef GC.Spread.Report.ReportTemplateCell
11532
- * @type {(GC.Spread.Report.ListCell | GC.Spread.Report.GroupCell | GC.Spread.Report.SummaryCell | GC.Spread.Report.StaticCell) & GC.Spread.Report.ITemplateCellCommonSetting}
11579
+ * @type {(GC.Spread.Report.ListCell | GC.Spread.Report.GroupCell | GC.Spread.Report.SummaryCell | GC.Spread.Report.StaticCell | GC.Spread.Report.ChartCell) & GC.Spread.Report.ITemplateCellCommonSetting}
11533
11580
  */
11534
11581
  export type TemplateCell =
11535
- (GC.Spread.Report.ListCell | GC.Spread.Report.GroupCell | GC.Spread.Report.SummaryCell | GC.Spread.Report.StaticCell) & GC.Spread.Report.ITemplateCellCommonSetting
11582
+ (GC.Spread.Report.ListCell | GC.Spread.Report.GroupCell | GC.Spread.Report.SummaryCell | GC.Spread.Report.StaticCell | GC.Spread.Report.ChartCell) & GC.Spread.Report.ITemplateCellCommonSetting
11536
11583
 
11537
11584
 
11538
11585
  export class ReportSheet{
@@ -12241,6 +12288,8 @@ declare module GC{
12241
12288
  * Toggle the collapse state of the specified cell.
12242
12289
  * @param {number} row The row index.
12243
12290
  * @param {number} col The column index.
12291
+ * @param {'Collapsed' | 'Expanded'} targetState The target state, collapse or expand the specific cell.
12292
+ * @param {boolean} recursive True will update the state of the current cell and all the descendant cells, false will only update the current cell.
12244
12293
  * @example
12245
12294
  * ```
12246
12295
  * const report = spread.addSheetTab(0, "Report", GC.Spread.Sheets.SheetType.reportSheet);
@@ -12260,7 +12309,7 @@ declare module GC{
12260
12309
  * report.toggleCollapseState(0, 0);
12261
12310
  * ```
12262
12311
  */
12263
- toggleCollapseState(row: number, col: number): void;
12312
+ toggleCollapseState(row: number, col: number, targetState?: 'Collapsed' | 'Expanded', recursive?: boolean): void;
12264
12313
  /**
12265
12314
  * Generated a static worksheet(no formula, no cell binding) base on the current report sheet.
12266
12315
  * @returns {GC.Spread.Sheets.Worksheet} Return the generated worksheet.
@@ -12334,7 +12383,6 @@ declare module GC{
12334
12383
  /**
12335
12384
  * Represents a TemplateSheet.
12336
12385
  * @class
12337
- * @noInheritDoc
12338
12386
  * @param {string} name The name of the TemplateSheet.
12339
12387
  * @example
12340
12388
  * ```
@@ -12627,12 +12675,21 @@ declare module GC{
12627
12675
  }
12628
12676
 
12629
12677
 
12678
+ export interface ICalendarDateRange{
12679
+ start: Date;
12680
+ end: Date;
12681
+ }
12682
+
12683
+
12630
12684
  export interface ICalendarOption{
12631
12685
  startDay?: GC.Spread.Sheets.CalendarStartDay;
12632
12686
  calendarPage?: GC.Spread.Sheets.CalendarPage;
12633
12687
  showTime?: boolean;
12634
12688
  showDateRange?: boolean;
12635
12689
  showBuiltInDateRange?: boolean;
12690
+ defaultDateTime?: Date | GC.Spread.Sheets.ICalendarDateRange;
12691
+ maxDate?: Date;
12692
+ minDate?: Date;
12636
12693
  }
12637
12694
 
12638
12695
 
@@ -14690,6 +14747,7 @@ declare module GC{
14690
14747
  * @property {boolean} [calcOnDemand] - Whether to calculate formulas only when they are demanded, default false.
14691
14748
  * @property {boolean} [incrementalCalculation] - Whether to incremental calculate formulas without blocking UI, default false.
14692
14749
  * @property {boolean} [includeUnusedStyles] - Whether to include the unused name style when converting excel xml to the json, default true.
14750
+ * @property {boolean} [convertSheetTableToDataTable] - Whether to convert the sheet tables to data manager tables, default false.
14693
14751
  * @property {string} [password] - The password to open the workbook.
14694
14752
  * @property {GC.Spread.Sheets.OpenMode} [openMode] - The open mode of normal, lazy and incremental. By default is normal.
14695
14753
  * @property {GC.Spread.Sheets.ProgressFunctionType} [progress] - The progress callback function for each open mode.
@@ -14705,6 +14763,7 @@ declare module GC{
14705
14763
  calcOnDemand?: boolean;
14706
14764
  incrementalCalculation?: boolean;
14707
14765
  includeUnusedStyles?: boolean;
14766
+ convertSheetTableToDataTable?: boolean;
14708
14767
  password?: string;
14709
14768
  openMode?: GC.Spread.Sheets.OpenMode;
14710
14769
  progress?: GC.Spread.Sheets.ProgressFunctionType;
@@ -16913,7 +16972,7 @@ declare module GC{
16913
16972
  /**
16914
16973
  * Sheet all used range type
16915
16974
  */
16916
- all= 262143,
16975
+ all= 4294967295,
16917
16976
  /**
16918
16977
  * Sheet header used range
16919
16978
  */
@@ -16985,7 +17044,15 @@ declare module GC{
16985
17044
  /**
16986
17045
  * Sheet picture used range
16987
17046
  */
16988
- picture= 131072
17047
+ picture= 131072,
17048
+ /**
17049
+ * Sheet tag used range
17050
+ */
17051
+ tag= 262144,
17052
+ /**
17053
+ * Sheet data range used range
17054
+ */
17055
+ dataRange= 524288
16989
17056
  }
16990
17057
 
16991
17058
  /**
@@ -17157,6 +17224,20 @@ declare module GC{
17157
17224
  * @type {GC.Spread.Sheets.SheetArea}
17158
17225
  */
17159
17226
  sheetArea: GC.Spread.Sheets.SheetArea;
17227
+ /**
17228
+ * Gets or sets whether the cell can enter edit mode for editing.
17229
+ * @param {boolean} [value] Set to `false` to disallow the cell enter edit mode for editing.
17230
+ * @returns {boolean|GC.Spread.Sheets.CellRange} If no value is set, returns whether the cell can enter edit mode for editing; otherwise, returns the cell.
17231
+ * @example
17232
+ * ```
17233
+ * activeSheet.getRange(0, 0, 2, 3, GC.Spread.Sheets.SheetArea.viewport).allowEditInCell(false);
17234
+ * ```
17235
+ * @example
17236
+ * ```
17237
+ * activeSheet.getCell(1,1).allowEditInCell(false);
17238
+ * ```
17239
+ */
17240
+ allowEditInCell(value?: boolean): any;
17160
17241
  /**
17161
17242
  * Gets or sets the alternative text of the cell for screen readers.
17162
17243
  * @param {string} value The alternative text of the cell.
@@ -20373,12 +20454,18 @@ declare module GC{
20373
20454
  * @param eventParam *{@link GC.Spread.Sheets.Tables.Table}* `table` The table which is resizing.
20374
20455
  * @param eventParam *{@link GC.Spread.Sheets.Range}* `oldRange` The table range before resize.
20375
20456
  * @param eventParam *{@link GC.Spread.Sheets.Range}* `newRange` The table range after resize.
20457
+ * @param eventParam *boolean* `cancel` Whether to cancel the current resize behavior. The default value is false.
20376
20458
  * @example
20377
20459
  * ```
20378
20460
  * //This example uses the TableResizing and TableResized event.
20379
20461
  * window.onload = function(){
20380
20462
  * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
20381
20463
  * var activeSheet = spread.getActiveSheet();
20464
+ * spread.bind(GC.Spread.Sheets.Events.TableResizing, function (e, data) {
20465
+ * if (data.newRange.rowCount > 10) {
20466
+ * args.cancel = true;
20467
+ * }
20468
+ * });
20382
20469
  * spread.bind(GC.Spread.Sheets.Events.TableResizing, function (e, data) {});
20383
20470
  * spread.bind(GC.Spread.Sheets.Events.TableResized, function (e, data) {});
20384
20471
  * }
@@ -20715,7 +20802,7 @@ declare module GC{
20715
20802
  * sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme);
20716
20803
  * ```
20717
20804
  */
20718
- add(name: string, sourceData: string | any[][], row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
20805
+ add(name: string, sourceData: string, row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
20719
20806
  /**
20720
20807
  * @description Get all pivot table in current worksheet.
20721
20808
  * @return {GC.Spread.Pivot.PivotTable[]} return all pivot table in current worksheet.
@@ -21205,6 +21292,17 @@ declare module GC{
21205
21292
  * ```
21206
21293
  */
21207
21294
  constructor(backColor?: string | GC.Spread.Sheets.IPatternFill | GC.Spread.Sheets.IGradientFill | GC.Spread.Sheets.IGradientPathFill, foreColor?: string, hAlign?: GC.Spread.Sheets.HorizontalAlign, vAlign?: GC.Spread.Sheets.VerticalAlign, font?: string, themeFont?: string, formatter?: string | GC.Spread.Formatter.GeneralFormatter, borderLeft?: GC.Spread.Sheets.LineBorder, borderTop?: GC.Spread.Sheets.LineBorder, borderRight?: GC.Spread.Sheets.LineBorder, borderBottom?: GC.Spread.Sheets.LineBorder, locked?: boolean, textIndent?: number, wordWrap?: boolean, showEllipsis?: boolean, shrinkToFit?: boolean, backgroundImage?: string, cellType?: GC.Spread.Sheets.CellTypes.Base, backgroundImageLayout?: GC.Spread.Sheets.ImageLayout, tabStop?: boolean, textDecoration?: GC.Spread.Sheets.TextDecorationType, imeMode?: GC.Spread.Sheets.ImeMode, name?: string, parentName?: string, watermark?: string, cellPadding?: string, labelOptions?: GC.Spread.Sheets.ILabelOptions, quotePrefix?: boolean, diagonalDown?: GC.Spread.Sheets.LineBorder, diagonalUp?: GC.Spread.Sheets.LineBorder, isVerticalText?: boolean, cellButtons?: GC.Spread.Sheets.ICellButton[], dropdown?: GC.Spread.Sheets.IDropdown[], textOrientation?: number, decoration?: GC.Spread.Sheets.TextDecorationType, mask?: GC.Spread.Sheets.IMaskType, fontStyle?: string, fontWeight?: string, fontSize?: string, fontFamily?: string, hidden?: boolean, textDirection?: GC.Spread.Sheets.TextDirectionType);
21295
+ /**
21296
+ * Indicates whether the cell can enter edit mode for editing.
21297
+ * @type {boolean}
21298
+ * @example
21299
+ * ```
21300
+ * //This example sets the allowEditInCell property.
21301
+ * var style = activeSheet.getStyle(1,1,GC.Spread.Sheets.SheetArea.viewport);
21302
+ * style.allowEditInCell = false;
21303
+ * ```
21304
+ */
21305
+ allowEditInCell: boolean | undefined;
21208
21306
  /**
21209
21307
  * Only work for namedStyle, the boolean value indicates whether the alignment formatting applied.
21210
21308
  * @type {boolean}
@@ -22731,6 +22829,11 @@ declare module GC{
22731
22829
  * spread.addSparklineEx(new MySparklineEx('green'));
22732
22830
  */
22733
22831
  addSparklineEx(sparklineEx: GC.Spread.Sheets.Sparklines.SparklineEx): void;
22832
+ /**
22833
+ * Only used in collaboration case, to apply doc's op.
22834
+ * @param {object} changeSet - change set
22835
+ */
22836
+ applyOp(changeSet: Object): void;
22734
22837
  /**
22735
22838
  * Binds an event to the Workbook.
22736
22839
  * @param {string} type The event type.
@@ -22985,6 +23088,11 @@ declare module GC{
22985
23088
  * ```
22986
23089
  */
22987
23090
  fromJSON(workbookData: Object, deserializationOptions?: GC.Spread.Sheets.IDeserializationOptions): Promise<any>;
23091
+ /**
23092
+ * Only used in collaboration case, to restore the snapshot to workbook state.
23093
+ * @param {object} snapshot - snapshot object
23094
+ */
23095
+ fromSnapshot(snapshot: Object): void;
22988
23096
  /**
22989
23097
  * Gets the active sheet.
22990
23098
  * @returns {GC.Spread.Sheets.Worksheet} The active sheet instance.
@@ -23257,6 +23365,11 @@ declare module GC{
23257
23365
  * @returns {HTMLElement|GC.Spread.Sheets.Workbook} If no value is set, returns the next control; otherwise, returns the spreadsheet.
23258
23366
  */
23259
23367
  nextControl(value?: HTMLElement): any;
23368
+ /**
23369
+ * Only used in collaboration case, to watch op
23370
+ * @param {function} opHandler - callback watch op
23371
+ */
23372
+ onOp(onOpHandler: Function): void;
23260
23373
  /**
23261
23374
  * Loads the object state from the sjs zipped file.
23262
23375
  * @param {Blob} file - The zipped spreadsheet data file.
@@ -23568,6 +23681,11 @@ declare module GC{
23568
23681
  * ```
23569
23682
  */
23570
23683
  toJSON(serializationOption?: GC.Spread.Sheets.ISerializationOption): Object;
23684
+ /**
23685
+ * Only used in collaboration case, to save workbook state to snapshot.
23686
+ * @return {object} snapshot - snapshot object
23687
+ */
23688
+ toSnapshot(): Object;
23571
23689
  /**
23572
23690
  * Removes the binding of an event to Workbook.
23573
23691
  * @param {string} type The event type.
@@ -23715,6 +23833,21 @@ declare module GC{
23715
23833
  * ```
23716
23834
  */
23717
23835
  conditionalFormats: ConditionalFormatting.ConditionalFormats;
23836
+ /** The datachart manager.
23837
+ * @type {GC.Spread.Sheets.DataCharts.DataChartManager}
23838
+ * @example
23839
+ * ```
23840
+ * //This example creates a datachart.
23841
+ * var datacharts = sheet.dataCharts;
23842
+ * var datachart = datacharts.add('datachart1', 250, 20, 600, 400, GC.Spread.Sheets.DataCharts.DataChartType.column);
23843
+ * ```
23844
+ */
23845
+ dataCharts: GC.Spread.Sheets.DataCharts.DataChartManager;
23846
+ /**
23847
+ * Data range manager for the sheet.
23848
+ * @type {GC.Spread.Sheets.DataRange.DataRangeManager}
23849
+ */
23850
+ dataRanges: GC.Spread.Sheets.DataRange.DataRangeManager;
23718
23851
  /**
23719
23852
  * Indicates the default row height and column width of the sheet.
23720
23853
  * @type {Object}
@@ -26039,21 +26172,21 @@ declare module GC{
26039
26172
  * ```
26040
26173
  * //This example uses the setHyperlink method.
26041
26174
  * sheet.setHyperlink(0, 2, {
26042
- * url: 'https://www.spreadjs.com',
26043
- * tooltip: 'baidu',
26044
- * linkColor: 'blue',
26045
- * visitedLinkColor: 'red',
26046
- * target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank,
26047
- * command: 'navigationLeft'
26048
- * }, GC.Spread.Sheets.SheetArea.viewport);
26175
+ * url: 'https://www.spreadjs.com',
26176
+ * tooltip: 'spreadjs',
26177
+ * linkColor: 'blue',
26178
+ * visitedLinkColor: 'red',
26179
+ * target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank,
26180
+ * command: 'navigationLeft'
26181
+ * });
26182
+ * sheet.setValue(0,2, 'spreadjs');
26049
26183
  * sheet.setHyperlink(1, 1, {
26050
- * url: 'https://www.spreadjs.com',
26051
- * tooltip: 'baidu',
26052
- * setUnderlineToStyle: true;
26053
- * setForeColorToStyle: true;
26054
- * target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.top,
26055
- * command: function() { console.log('Only show this message when click the hyperlink.')}
26056
- * }, GC.Spread.Sheets.SheetArea.viewport);
26184
+ * url: 'https://www.spreadjs.com',
26185
+ * tooltip: 'spreadjs',
26186
+ * target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.top,
26187
+ * command: function () { console.log('Only show this message when click the hyperlink.') }
26188
+ * });
26189
+ * sheet.setValue(1,1, 'spreadjs');
26057
26190
  * ```
26058
26191
  */
26059
26192
  setHyperlink(row: number, col: number, value: GC.Spread.Sheets.IHyperlink, sheetArea?: GC.Spread.Sheets.SheetArea): void;
@@ -27068,6 +27201,22 @@ declare module GC{
27068
27201
  }
27069
27202
 
27070
27203
 
27204
+ export interface IDataBinding{
27205
+ /**
27206
+ * Represents the data binding source. it can be a table name, or a formula.
27207
+ */
27208
+ dataSource: string;
27209
+ /**
27210
+ * Represents the column name or column index of the data source that will binding to the text of the item of the ComboBox.
27211
+ */
27212
+ text?: string | number;
27213
+ /**
27214
+ * Represents the column name or column index of the data source that will binding to the value of the item of the ComboBox.
27215
+ */
27216
+ value?: string | number;
27217
+ }
27218
+
27219
+
27071
27220
  export interface IFileInfo{
27072
27221
  name: string;
27073
27222
  blob?: Blob;
@@ -27146,6 +27295,29 @@ declare module GC{
27146
27295
  vertical= 1
27147
27296
  }
27148
27297
 
27298
+ /**
27299
+ * Specifies what is the diverge direction of the diagonal cell type
27300
+ * @readonly
27301
+ * @enum {number}
27302
+ * @example
27303
+ * ```
27304
+ * //This example uses the EditorValueType enumeration.
27305
+ * var diagonalCellType = new GC.Spread.Sheets.CellTypes.Diagonal();
27306
+ * diagonalCellType.divergeDirection(GC.Spread.Sheets.CellTypes.DivergeDirection.topLeftToBottomRight)
27307
+ * activeSheet.getCell(2, 2).cellType(diagonalCellType);
27308
+ * ```
27309
+ */
27310
+ export enum DivergeDirection{
27311
+ /**
27312
+ * Represents diverge from the TopLeft to the BottomRight.
27313
+ */
27314
+ topLeftToBottomRight= 0,
27315
+ /**
27316
+ * Represents diverge from the BottomLeft to the TopRight.
27317
+ */
27318
+ bottomLeftToTopRight= 1
27319
+ }
27320
+
27149
27321
  /**
27150
27322
  * Represents the editor type of text cell type.
27151
27323
  * @enum {number}
@@ -28150,6 +28322,28 @@ declare module GC{
28150
28322
  * ```
28151
28323
  */
28152
28324
  allowFloat(value?: boolean): any;
28325
+ /**
28326
+ * Gets or sets the data binding of the ComboBox cell type.
28327
+ * @param {GC.Spread.Sheets.CellTypes.IDataBinding} [value] the data binding of the ComboBox.
28328
+ * @returns {GC.Spread.Sheets.CellTypes.IDataBinding | GC.Spread.Sheets.CellTypes.ComboBox} If no value is set, returns the combo box's data binding; otherwise, returns the combo box cellType.
28329
+ * @example
28330
+ * ```
28331
+ * //This example shows binding a table name to the ComboBox cell type.
28332
+ * var tableName = { dataSource: "productName", text: "productName", value: "productId" };
28333
+ * var cellType = new GC.Spread.Sheets.CellTypes.ComboBox();
28334
+ * cellType.dataBinding(tableName);
28335
+ * activeSheet.getCell(1, 3).cellType(cellType);
28336
+ * ```
28337
+ * @example
28338
+ * ```
28339
+ * //This example shows binding a formula to the ComboBox cell type.
28340
+ * var formula = { dataSource: '=SORT(UNIQUE(QUERY("Products", {"productName","productId"})))', text: 0, value: 1 };
28341
+ * var cellType2 = new GC.Spread.Sheets.CellTypes.ComboBox();
28342
+ * cellType2.dataBinding(formula);
28343
+ * activeSheet.getCell(10, 3).cellType(cellType2);
28344
+ * ```
28345
+ */
28346
+ dataBinding(value?: GC.Spread.Sheets.CellTypes.IDataBinding): GC.Spread.Sheets.CellTypes.IDataBinding | GC.Spread.Sheets.CellTypes.ComboBox;
28153
28347
  /**
28154
28348
  * Gets or sets whether the combo box is editable.
28155
28349
  * @param {boolean} value Whether the combo box is editable.
@@ -28249,6 +28443,47 @@ declare module GC{
28249
28443
  constructor();
28250
28444
  }
28251
28445
 
28446
+ export class Diagonal extends Text{
28447
+ /**
28448
+ * Represents a diagonal lines cell.
28449
+ * @extends GC.Spread.Sheets.CellTypes.Text
28450
+ * @class
28451
+ * @example
28452
+ * ```
28453
+ * //This example creates a diagonal cell.
28454
+ * var diagonalCellType = new GC.Spread.Sheets.CellTypes.Diagonal();
28455
+ * activeSheet.getCell(2, 2).cellType(diagonalCellType).value('Year,Product,Region');
28456
+ * ```
28457
+ */
28458
+ constructor();
28459
+ /**
28460
+ * Gets or sets the diverge direction of the diagonal cell type.
28461
+ * @param {GC.Spread.Sheets.CellTypes.DivergeDirection} value The type of diverge direction.
28462
+ * @returns {GC.Spread.Sheets.CellTypes.DivergeDirection | GC.Spread.Sheets.CellTypes.Diagonal} If no value is set, returns the type of diverge direction; otherwise, returns the diagonal cellType.
28463
+ * @example
28464
+ * ```
28465
+ * //This example gets the diverge direction type.
28466
+ * var cellType = new GC.Spread.Sheets.CellTypes.Diagonal();
28467
+ * activeSheet.getCell(2, 2).cellType(cellType);
28468
+ * alert(cellType.divergeDirection());
28469
+ * ```
28470
+ */
28471
+ divergeDirection(value?: GC.Spread.Sheets.CellTypes.DivergeDirection): GC.Spread.Sheets.CellTypes.DivergeDirection | GC.Spread.Sheets.CellTypes.Diagonal;
28472
+ /**
28473
+ * Gets or sets the line border of the diagonal cell type.
28474
+ * @param {GC.Spread.Sheets.LineBorder} value The type of line border.
28475
+ * @returns {GC.Spread.Sheets.LineBorder | GC.Spread.Sheets.CellTypes.Diagonal} If no value is set, returns the type of line border; otherwise, returns the diagonal cellType.
28476
+ * @example
28477
+ * ```
28478
+ * //This example gets the diverge direction type.
28479
+ * var cellType = new GC.Spread.Sheets.CellTypes.Diagonal();
28480
+ * activeSheet.getCell(2, 2).cellType(cellType);
28481
+ * alert(cellType.lineBorder());
28482
+ * ```
28483
+ */
28484
+ lineBorder(value?: GC.Spread.Sheets.LineBorder): GC.Spread.Sheets.LineBorder | GC.Spread.Sheets.CellTypes.Diagonal;
28485
+ }
28486
+
28252
28487
  export class FileUpload extends Base{
28253
28488
  /**
28254
28489
  * Represents a file upload cell type.
@@ -30672,6 +30907,15 @@ declare module GC{
30672
30907
  * ```
30673
30908
  */
30674
30909
  toImageSrc(): string;
30910
+ /**
30911
+ * Get the chart Image src of type Base64 string.
30912
+ * @returns {Promise<string>} return the chart Image Base64 src string.
30913
+ * @example
30914
+ * ```
30915
+ * let chartImageSrc = await sheet.charts.all()[0].toImageSrcAsync();
30916
+ * ```
30917
+ */
30918
+ toImageSrcAsync(): Promise<string>;
30675
30919
  /**
30676
30920
  * Gets or sets whether apply animation to the chart.
30677
30921
  * @param {boolean} [value] whether apply animation to the chart.
@@ -31111,6 +31355,22 @@ declare module GC{
31111
31355
  * ```
31112
31356
  */
31113
31357
  var cancelInput: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string}): any};
31358
+ /**
31359
+ * Represents the command used to switch the editor status between enter and edit mode when a cell is editing.
31360
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
31361
+ * @property {function} execute - performs an execute or undo operation.
31362
+ * The arguments of the execute method are as follows.
31363
+ * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
31364
+ * @param {Object} options The options of the operation.
31365
+ * @param {string} options.sheetName The sheet name.
31366
+ * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
31367
+ * @example
31368
+ * ```
31369
+ * // start editing a cell with invoking command
31370
+ * spread.commandManager().execute({cmd: "changeEditorStatus", sheetName: "Sheet1"});
31371
+ * ```
31372
+ */
31373
+ var changeEditorStatus: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string}): any};
31114
31374
  /**
31115
31375
  * Represents the command used to switch the formula reference between relative, absolute, and mixed when editing formulas.
31116
31376
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
@@ -32601,6 +32861,22 @@ declare module GC{
32601
32861
  * ```
32602
32862
  */
32603
32863
  var splitResizeRow: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: { sheetName: string, rows: Object[], size: number, columnHeader: boolean }, isUndo: boolean): any};
32864
+ /**
32865
+ * Represents the command used to start editing the active cell with the edit mode.
32866
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32867
+ * @property {function} execute - performs an execute or undo operation.
32868
+ * The arguments of the execute method are as follows.
32869
+ * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32870
+ * @param {Object} options The options of the operation.
32871
+ * @param {string} options.sheetName The sheet name.
32872
+ * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32873
+ * @example
32874
+ * ```
32875
+ * // start editing a cell with invoking command
32876
+ * spread.commandManager().execute({cmd: "startEdit", sheetName: "Sheet1"});
32877
+ * ```
32878
+ */
32879
+ var startEdit: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string}): any};
32604
32880
  /**
32605
32881
  * Represents the command used to delete columns for table.
32606
32882
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
@@ -32695,6 +32971,23 @@ declare module GC{
32695
32971
  * ```
32696
32972
  */
32697
32973
  var tableResize: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName: string, tableName: string, resizeToRange: GC.Spread.Sheets.Range}, isUndo: boolean): boolean};
32974
+ /**
32975
+ * Represents the command used to submit changes of the tables which bind data manager tables.
32976
+ * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
32977
+ * @property {function} execute - performs an execute or undo operation.
32978
+ * The arguments of the execute method are as follows.
32979
+ * @param {GC.Spread.Sheets.Workbook} context The context of the operation.
32980
+ * @param {Object} options The options of the operation.
32981
+ * @param {string} [options.sheetName] The sheet name, from active sheet by default.
32982
+ * @param {string[]} [options.tableNames] The table names, from active table by default.
32983
+ * @param {boolean} isUndo `true` if this is an undo operation; otherwise, `false`.
32984
+ * @example
32985
+ * ```
32986
+ * // submit changes of the tables which bind the data manager tables with invoking command
32987
+ * spread.commandManager().execute({cmd: "tableSubmitChanges", sheetName: "Sheet1", tableNames: ["table1"]});
32988
+ * ```
32989
+ */
32990
+ var tableSubmitChanges: { canUndo: boolean, execute(context: GC.Spread.Sheets.Workbook, options: {sheetName?: string, tableNames?: string[] }, isUndo: boolean): boolean};
32698
32991
  /**
32699
32992
  * Represents the command used to perform an undo of the most recent edit or action.
32700
32993
  * @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
@@ -37232,6 +37525,1610 @@ declare module GC{
37232
37525
  }
37233
37526
  }
37234
37527
 
37528
+ module DataCharts{
37529
+
37530
+ export interface IAnimationOption{
37531
+ duration?: number;
37532
+ easing?: GC.Spread.Sheets.DataCharts.AnimationEasing;
37533
+ scale?: number;
37534
+ startDelay?: number;
37535
+ }
37536
+
37537
+
37538
+ export interface IAxisOption{
37539
+ type?: GC.Spread.Sheets.DataCharts.AxisType;
37540
+ labels?: boolean;
37541
+ axisLine?: boolean;
37542
+ reversed?: boolean;
37543
+ title?: string;
37544
+ max?: GC.Spread.Sheets.DataCharts.IValueOption;
37545
+ min?: GC.Spread.Sheets.DataCharts.IValueOption;
37546
+ position?: GC.Spread.Sheets.DataCharts.AxisPosition;
37547
+ origin?: number;
37548
+ format?: GC.Spread.Sheets.DataCharts.IFormatOption;
37549
+ majorUnit?: GC.Spread.Sheets.DataCharts.IAxisUnitOption;
37550
+ overlappingLabels?: GC.Spread.Sheets.DataCharts.OverlappingLabels;
37551
+ dateMode?: GC.Spread.Sheets.DataCharts.DateMode;
37552
+ hoverStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37553
+ labelAngle?: number[];
37554
+ labelStyle?: GC.Spread.Sheets.DataCharts.ILabelStyleOption;
37555
+ logBase?: number;
37556
+ majorGrid?: boolean;
37557
+ majorTickSize?: number;
37558
+ majorTicks?: GC.Spread.Sheets.DataCharts.TickMark;
37559
+ minorGrid?: boolean;
37560
+ minorTickSize?: number;
37561
+ minorTicks?: GC.Spread.Sheets.DataCharts.TickMark;
37562
+ minorUnit?: GC.Spread.Sheets.DataCharts.IAxisUnitOption;
37563
+ scale?: GC.Spread.Sheets.DataCharts.IValueScaleOption;
37564
+ style?: GC.Spread.Sheets.DataCharts.IStyleOption;
37565
+ titleStyle?: GC.Spread.Sheets.DataCharts.ITitleStyleOption;
37566
+ lineStyle?: GC.Spread.Sheets.DataCharts.ILineStyle;
37567
+ majorGridStyle?: GC.Spread.Sheets.DataCharts.ILineStyle;
37568
+ majorTickStyle?: GC.Spread.Sheets.DataCharts.ILineStyle;
37569
+ minorGridStyle?: GC.Spread.Sheets.DataCharts.ILineStyle;
37570
+ minorTickStyle?: GC.Spread.Sheets.DataCharts.ILineStyle;
37571
+ }
37572
+
37573
+
37574
+ export interface IAxisUnitOption{
37575
+ dateMode?: GC.Spread.Sheets.DataCharts.DateMode;
37576
+ value?: number;
37577
+ }
37578
+
37579
+
37580
+ export interface IBarStyleOption{
37581
+ overlap?: number;
37582
+ width?: number;
37583
+ borderRadius?: GC.Spread.Sheets.DataCharts.IBorderRadius;
37584
+ }
37585
+
37586
+
37587
+ export interface IBorderRadius{
37588
+ bottomLeft?: number;
37589
+ bottomRight?: number;
37590
+ topLeft?: number;
37591
+ topRight?: number;
37592
+ }
37593
+
37594
+
37595
+ export interface ICategoryEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
37596
+ sort?: GC.Spread.Sheets.DataCharts.ISortEncodingOption;
37597
+ }
37598
+
37599
+
37600
+ export interface IConfigLegendOption{
37601
+ wrapping?: boolean;
37602
+ }
37603
+
37604
+
37605
+ export interface IConfigOption{
37606
+ dvStyle?: GC.Spread.Sheets.DataCharts.IStyleOption;
37607
+ palette?: GC.Spread.Sheets.DataCharts.IPaletteItemOption[];
37608
+ plotAreaLayout?: GC.Spread.Sheets.DataCharts.IPlotAreaLayoutOption;
37609
+ plotAreas?: GC.Spread.Sheets.DataCharts.IPlotAreaOption[];
37610
+ style?: GC.Spread.Sheets.DataCharts.IStyleOption;
37611
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37612
+ header?: GC.Spread.Sheets.DataCharts.IHeaderOption;
37613
+ }
37614
+
37615
+
37616
+ export interface IConnectingLineStyle{
37617
+ stroke?: string;
37618
+ strokeWidth?: number;
37619
+ strokeDasharray?: string;
37620
+ firstLineLength?: number;
37621
+ secondLineLength?: number;
37622
+ }
37623
+
37624
+
37625
+ export interface IContentEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
37626
+ aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
37627
+ }
37628
+
37629
+
37630
+ export interface ICssColorOptions{
37631
+ type: "CssColor";
37632
+ color?: GC.Spread.Sheets.DataCharts.ColorString;
37633
+ }
37634
+
37635
+
37636
+ export interface IDataChartConfig{
37637
+ plots: GC.Spread.Sheets.DataCharts.IPlotOption[];
37638
+ config?: GC.Spread.Sheets.DataCharts.IConfigOption;
37639
+ tableName?: string;
37640
+ }
37641
+
37642
+
37643
+ export interface IDataPointStyleOption extends GC.Spread.Sheets.DataCharts.IStyleOption{
37644
+ symbol?: GC.Spread.Sheets.DataCharts.ISymbolStyleOption;
37645
+ bar?: GC.Spread.Sheets.DataCharts.IBarStyleOption;
37646
+ }
37647
+
37648
+
37649
+ export interface IFieldBasicOption{
37650
+ field: string;
37651
+ displayName?: string;
37652
+ }
37653
+
37654
+
37655
+ export interface IFormatOption{
37656
+ type?: GC.Spread.Sheets.DataCharts.FormatType;
37657
+ value: string;
37658
+ }
37659
+
37660
+
37661
+ export interface IHeaderOption{
37662
+ title?: string;
37663
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37664
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
37665
+ style?: GC.Spread.Sheets.DataCharts.IStyleOption;
37666
+ }
37667
+
37668
+
37669
+ export interface ILabelStyleOption{
37670
+ color?: string;
37671
+ fontFamily?: string;
37672
+ fontSize?: number;
37673
+ fontStyle?: GC.Spread.Sheets.DataCharts.FontStyle;
37674
+ fontWeight?: string;
37675
+ opacity?: number;
37676
+ overflow?: GC.Spread.Sheets.DataCharts.TextOverflow;
37677
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
37678
+ }
37679
+
37680
+
37681
+ export interface ILegendOptions{
37682
+ title?: string;
37683
+ type?: GC.Spread.Sheets.DataCharts.LegendType;
37684
+ height?: number;
37685
+ width?: number;
37686
+ position?: GC.Spread.Sheets.DataCharts.LegendPosition;
37687
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37688
+ hAlign?: GC.Spread.Sheets.DataCharts.HAlign;
37689
+ vAlign?: GC.Spread.Sheets.DataCharts.VAlign;
37690
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
37691
+ }
37692
+
37693
+
37694
+ export interface ILineStyle{
37695
+ stroke?: GC.Spread.Sheets.DataCharts.ColorOptions;
37696
+ strokeWidth?: number;
37697
+ strokeDasharray?: string;
37698
+ strokeOpacity?: number;
37699
+ }
37700
+
37701
+
37702
+ export interface IPaddingOption{
37703
+ top?: number;
37704
+ bottom?: number;
37705
+ left?: number;
37706
+ right?: number;
37707
+ }
37708
+
37709
+
37710
+ export interface IPaletteItemOption{
37711
+ color: GC.Spread.Sheets.DataCharts.ColorOptions;
37712
+ }
37713
+
37714
+
37715
+ export interface IPlotAreaLayoutOption{
37716
+ columnWidths?: GC.Spread.Sheets.DataCharts.IValueOption[];
37717
+ rowHeights?: GC.Spread.Sheets.DataCharts.IValueOption[];
37718
+ }
37719
+
37720
+
37721
+ export interface IPlotAreaOption{
37722
+ axes?: GC.Spread.Sheets.DataCharts.IAxisOption[];
37723
+ column?: number;
37724
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
37725
+ row?: number;
37726
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37727
+ legends?: GC.Spread.Sheets.DataCharts.ILegendOptions[];
37728
+ legend?: GC.Spread.Sheets.DataCharts.IConfigLegendOption;
37729
+ }
37730
+
37731
+
37732
+ export interface IPlotConfigOption{
37733
+ hoverStyle?: GC.Spread.Sheets.DataCharts.IDataPointStyleOption;
37734
+ innerRadius?: number;
37735
+ outerRadius?: number;
37736
+ lineAspect?: GC.Spread.Sheets.DataCharts.LineAspect;
37737
+ palette?: string[];
37738
+ startAngle?: number;
37739
+ style?: GC.Spread.Sheets.DataCharts.IDataPointStyleOption;
37740
+ swapAxes?: boolean;
37741
+ sweep?: number;
37742
+ symbols?: boolean;
37743
+ text?: GC.Spread.Sheets.DataCharts.IPlotConfigTextOption[];
37744
+ tooltip?: GC.Spread.Sheets.DataCharts.IPlotConfigTooltipOption[];
37745
+ hoverAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
37746
+ updateAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
37747
+ }
37748
+
37749
+
37750
+ export interface IPlotConfigTextOption{
37751
+ template?: string;
37752
+ format?: GC.Spread.Sheets.DataCharts.IFormatOption;
37753
+ style?: GC.Spread.Sheets.DataCharts.IStyleOption;
37754
+ textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
37755
+ connectingLineStyle?: GC.Spread.Sheets.DataCharts.IConnectingLineStyle;
37756
+ maxWidth?: number;
37757
+ offset?: number;
37758
+ overlappingLabels?: GC.Spread.Sheets.DataCharts.OverlappingLabels;
37759
+ position?: GC.Spread.Sheets.DataCharts.TextPosition;
37760
+ }
37761
+
37762
+
37763
+ export interface IPlotConfigTooltipOption{
37764
+ style?: GC.Spread.Sheets.DataCharts.IToolTipStyleOption;
37765
+ textStyle?: GC.Spread.Sheets.DataCharts.IToolTipTextStyleOption;
37766
+ }
37767
+
37768
+
37769
+ export interface IPlotEncodingsOption{
37770
+ values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[];
37771
+ category?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
37772
+ details?: GC.Spread.Sheets.DataCharts.IFieldBasicOption[];
37773
+ color?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
37774
+ size?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
37775
+ tooltip?: GC.Spread.Sheets.DataCharts.IContentEncodingOption[];
37776
+ filter?: GC.Spread.Sheets.DataCharts.IFilterOption;
37777
+ }
37778
+
37779
+
37780
+ export interface IPlotOption{
37781
+ type: GC.Spread.Sheets.DataCharts.DataChartType;
37782
+ encodings?: GC.Spread.Sheets.DataCharts.IPlotEncodingsOption;
37783
+ config?: GC.Spread.Sheets.DataCharts.IPlotConfigOption;
37784
+ }
37785
+
37786
+
37787
+ export interface IQuadrangleStyleOption{
37788
+ leftBorder?: GC.Spread.Sheets.DataCharts.ILineStyle;
37789
+ rightBorder?: GC.Spread.Sheets.DataCharts.ILineStyle;
37790
+ topBorder?: GC.Spread.Sheets.DataCharts.ILineStyle;
37791
+ bottomBorder?: GC.Spread.Sheets.DataCharts.ILineStyle;
37792
+ }
37793
+
37794
+
37795
+ export interface ISortEncodingOption{
37796
+ field: string;
37797
+ aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
37798
+ order?: GC.Spread.Sheets.DataCharts.OrderType;
37799
+ }
37800
+
37801
+
37802
+ export interface IStyleOption{
37803
+ fill?: GC.Spread.Sheets.DataCharts.ColorOptions;
37804
+ fillOpacity?: number;
37805
+ stroke?: GC.Spread.Sheets.DataCharts.ColorOptions;
37806
+ strokeDasharray?: string;
37807
+ strokeOpacity?: number;
37808
+ strokeWidth?: number;
37809
+ }
37810
+
37811
+
37812
+ export interface ISymbolStyleOption{
37813
+ symbolShape?: GC.Spread.Sheets.DataCharts.SymbolShape;
37814
+ symbolSize?: number;
37815
+ }
37816
+
37817
+
37818
+ export interface ITextDecorationOption{
37819
+ lineThrough?: boolean;
37820
+ overline?: boolean;
37821
+ underline?: boolean;
37822
+ }
37823
+
37824
+
37825
+ export interface ITextStyleOption{
37826
+ alignment?: GC.Spread.Sheets.DataCharts.HAlign;
37827
+ color?: string;
37828
+ fontFamily?: string;
37829
+ fontSize?: number;
37830
+ fontStyle?: GC.Spread.Sheets.DataCharts.FontStyle;
37831
+ fontWeight?: string;
37832
+ opacity?: number;
37833
+ overflow?: GC.Spread.Sheets.DataCharts.TextOverflow;
37834
+ }
37835
+
37836
+
37837
+ export interface ITitleStyleOption{
37838
+ color?: string;
37839
+ fontFamily?: string;
37840
+ fontSize?: number;
37841
+ fontStyle?: GC.Spread.Sheets.DataCharts.FontStyle;
37842
+ fontWeight?: string;
37843
+ opacity?: number;
37844
+ padding?: GC.Spread.Sheets.DataCharts.IPaddingOption;
37845
+ }
37846
+
37847
+
37848
+ export interface IToolTipStyleOption{
37849
+ fill?: GC.Spread.Sheets.DataCharts.ColorOptions;
37850
+ stroke?: GC.Spread.Sheets.DataCharts.ColorOptions;
37851
+ strokeWidth?: number;
37852
+ fillOpacity?: number;
37853
+ strokeOpacity?: number;
37854
+ }
37855
+
37856
+
37857
+ export interface IToolTipTextStyleOption{
37858
+ color?: string;
37859
+ fontFamily?: string;
37860
+ fontSize?: number;
37861
+ fontStyle?: GC.Spread.Sheets.DataCharts.FontStyle;
37862
+ fontWeight?: string;
37863
+ opacity?: number;
37864
+ textDecoration?: GC.Spread.Sheets.DataCharts.ITextDecorationOption;
37865
+ }
37866
+
37867
+
37868
+ export interface IValueEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
37869
+ aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
37870
+ }
37871
+
37872
+
37873
+ export interface IValueFilter{
37874
+ field: string;
37875
+ operate: GC.Spread.Sheets.DataCharts.ComparisonOperator | GC.Spread.Sheets.DataCharts.StringOperator;
37876
+ value: GC.Spread.Sheets.DataCharts.DataValueType | GC.Spread.Sheets.DataCharts.DataValueType[];
37877
+ excludeMatched?: boolean;
37878
+ ignoreCase?: boolean;
37879
+ }
37880
+
37881
+
37882
+ export interface IValueFilterGroup{
37883
+ conditions: GC.Spread.Sheets.DataCharts.IFilterOption[];
37884
+ operate: GC.Spread.Sheets.DataCharts.LogicalOperation;
37885
+ }
37886
+
37887
+
37888
+ export interface IValueOption{
37889
+ type?: GC.Spread.Sheets.DataCharts.ValueOptionType;
37890
+ value?: number;
37891
+ }
37892
+
37893
+
37894
+ export interface IValueScaleOption{
37895
+ type?: GC.Spread.Sheets.DataCharts.ValueScaleType;
37896
+ }
37897
+
37898
+
37899
+ /**
37900
+ * @typedef GC.Spread.Sheets.DataCharts.ColorOptions
37901
+ * @type {GC.Spread.Sheets.DataCharts.ICssColorOptions}
37902
+ */
37903
+ export type ColorOptions =
37904
+ GC.Spread.Sheets.DataCharts.ICssColorOptions
37905
+
37906
+
37907
+ /**
37908
+ * @typedef GC.Spread.Sheets.DataCharts.ColorString
37909
+ * @type {string}
37910
+ */
37911
+ export type ColorString =
37912
+ string
37913
+
37914
+
37915
+ /**
37916
+ * @typedef GC.Spread.Sheets.DataCharts.DataValueType
37917
+ * @type {number | boolean | Date | string | null}
37918
+ */
37919
+ export type DataValueType =
37920
+ number | boolean | Date | string | null
37921
+
37922
+
37923
+ /**
37924
+ * @typedef GC.Spread.Sheets.DataCharts.IFilterOption
37925
+ * @type {GC.Spread.Sheets.DataCharts.IValueFilter | GC.Spread.Sheets.DataCharts.IValueFilterGroup}
37926
+ */
37927
+ export type IFilterOption =
37928
+ GC.Spread.Sheets.DataCharts.IValueFilter | GC.Spread.Sheets.DataCharts.IValueFilterGroup
37929
+
37930
+ /**
37931
+ * Specifies the datachart plot value Aggregate.
37932
+ * @enum {number}
37933
+ */
37934
+ export enum Aggregate{
37935
+ /**
37936
+ * firstValue
37937
+ */
37938
+ firstValue= 0,
37939
+ /**
37940
+ * sum
37941
+ */
37942
+ sum= 1,
37943
+ /**
37944
+ * count
37945
+ */
37946
+ count= 2,
37947
+ /**
37948
+ * average
37949
+ */
37950
+ average= 3,
37951
+ /**
37952
+ * max
37953
+ */
37954
+ max= 4,
37955
+ /**
37956
+ * min
37957
+ */
37958
+ min= 5,
37959
+ /**
37960
+ * countDistinct
37961
+ */
37962
+ countDistinct= 12
37963
+ }
37964
+
37965
+ /**
37966
+ * Specifies the datachart plot AnimationEasing.
37967
+ * @enum {number}
37968
+ */
37969
+ export enum AnimationEasing{
37970
+ /**
37971
+ * linear
37972
+ */
37973
+ linear= 0,
37974
+ /**
37975
+ * swing
37976
+ */
37977
+ swing= 1,
37978
+ /**
37979
+ * easeInQuad
37980
+ */
37981
+ easeInQuad= 2,
37982
+ /**
37983
+ * easeOutQuad
37984
+ */
37985
+ easeOutQuad= 3,
37986
+ /**
37987
+ * easeInOutQuad
37988
+ */
37989
+ easeInOutQuad= 4,
37990
+ /**
37991
+ * easeInCubic
37992
+ */
37993
+ easeInCubic= 5,
37994
+ /**
37995
+ * easeOutCubic
37996
+ */
37997
+ easeOutCubic= 6,
37998
+ /**
37999
+ * easeInOutCubic
38000
+ */
38001
+ easeInOutCubic= 7,
38002
+ /**
38003
+ * easeInQuart
38004
+ */
38005
+ easeInQuart= 8,
38006
+ /**
38007
+ * easeOutQuart
38008
+ */
38009
+ easeOutQuart= 9,
38010
+ /**
38011
+ * easeInOutQuart
38012
+ */
38013
+ easeInOutQuart= 10,
38014
+ /**
38015
+ * easeInQuint
38016
+ */
38017
+ easeInQuint= 11,
38018
+ /**
38019
+ * easeOutQuint
38020
+ */
38021
+ easeOutQuint= 12,
38022
+ /**
38023
+ * easeInOutQuint
38024
+ */
38025
+ easeInOutQuint= 13,
38026
+ /**
38027
+ * easeInSine
38028
+ */
38029
+ easeInSine= 14,
38030
+ /**
38031
+ * easeOutSine
38032
+ */
38033
+ easeOutSine= 15,
38034
+ /**
38035
+ * easeInOutSine
38036
+ */
38037
+ easeInOutSine= 16,
38038
+ /**
38039
+ * easeInExpo
38040
+ */
38041
+ easeInExpo= 17,
38042
+ /**
38043
+ * easeOutExpo
38044
+ */
38045
+ easeOutExpo= 18,
38046
+ /**
38047
+ * easeInOutExpo
38048
+ */
38049
+ easeInOutExpo= 19,
38050
+ /**
38051
+ * easeInCirc
38052
+ */
38053
+ easeInCirc= 20,
38054
+ /**
38055
+ * easeOutCirc
38056
+ */
38057
+ easeOutCirc= 21,
38058
+ /**
38059
+ * easeInOutCirc
38060
+ */
38061
+ easeInOutCirc= 22,
38062
+ /**
38063
+ * easeInBack
38064
+ */
38065
+ easeInBack= 23,
38066
+ /**
38067
+ * easeOutBack
38068
+ */
38069
+ easeOutBack= 24,
38070
+ /**
38071
+ * easeInOutBack
38072
+ */
38073
+ easeInOutBack= 25,
38074
+ /**
38075
+ * easeInBounce
38076
+ */
38077
+ easeInBounce= 26,
38078
+ /**
38079
+ * easeOutBounce
38080
+ */
38081
+ easeOutBounce= 27,
38082
+ /**
38083
+ * easeInOutBounce
38084
+ */
38085
+ easeInOutBounce= 28,
38086
+ /**
38087
+ * easeInElastic
38088
+ */
38089
+ easeInElastic= 29,
38090
+ /**
38091
+ * easeOutElastic
38092
+ */
38093
+ easeOutElastic= 30,
38094
+ /**
38095
+ * easeInOutElastic
38096
+ */
38097
+ easeInOutElastic= 31
38098
+ }
38099
+
38100
+ /**
38101
+ * Specifies the datachart plot AxisPosition.
38102
+ * @enum {number}
38103
+ */
38104
+ export enum AxisPosition{
38105
+ /**
38106
+ none
38107
+ */
38108
+ none= 0,
38109
+ /**
38110
+ near
38111
+ */
38112
+ near= 1,
38113
+ /**
38114
+ far
38115
+ */
38116
+ far= 2
38117
+ }
38118
+
38119
+ /**
38120
+ * Specifies the datachart plot AxisType.
38121
+ * @enum {string}
38122
+ */
38123
+ export enum AxisType{
38124
+ /**
38125
+ x
38126
+ */
38127
+ x= 0,
38128
+ /**
38129
+ y
38130
+ */
38131
+ y= 1
38132
+ }
38133
+
38134
+ /**
38135
+ * Specifies the datachart filter operator.
38136
+ * @enum {string}
38137
+ */
38138
+ export enum ComparisonOperator{
38139
+ /**
38140
+ in
38141
+ */
38142
+ in= "In",
38143
+ /**
38144
+ equalsTo
38145
+ */
38146
+ equalsTo= "EqualsTo",
38147
+ /**
38148
+ greaterThan
38149
+ */
38150
+ greaterThan= "GreaterThan",
38151
+ /**
38152
+ greaterThanOrEqualsTo
38153
+ */
38154
+ greaterThanOrEqualsTo= "GreaterThanOrEqualsTo",
38155
+ /**
38156
+ lessThan
38157
+ */
38158
+ lessThan= "LessThan",
38159
+ /**
38160
+ lessThanOrEqualsTo
38161
+ */
38162
+ lessThanOrEqualsTo= "LessThanOrEqualsTo",
38163
+ /**
38164
+ notEqualsTo
38165
+ */
38166
+ notEqualsTo= "NotEqualsTo"
38167
+ }
38168
+
38169
+ /**
38170
+ * Specifies the datachart type.
38171
+ * @enum {string}
38172
+ */
38173
+ export enum DataChartType{
38174
+ /**
38175
+ * Identifies the current DataChart type as column
38176
+ */
38177
+ column= "Column",
38178
+ /**
38179
+ * Identifies the current DataChart type as rangeColumn
38180
+ */
38181
+ rangeColumn= "RangeColumn",
38182
+ /**
38183
+ * Identifies the current DataChart type as stackedColumn
38184
+ */
38185
+ stackedColumn= "StackedColumn",
38186
+ /**
38187
+ * Identifies the current DataChart type as percentStackedColumn
38188
+ */
38189
+ percentStackedColumn= "PercentStackedColumn",
38190
+ /**
38191
+ * Identifies the current DataChart type as bar
38192
+ */
38193
+ bar= "Bar",
38194
+ /**
38195
+ * Identifies the current DataChart type as rangeBar
38196
+ */
38197
+ rangeBar= "RangeBar",
38198
+ /**
38199
+ * Identifies the current DataChart type as stackedBar
38200
+ */
38201
+ stackedBar= "StackedBar",
38202
+ /**
38203
+ * Identifies the current DataChart type as percentStackedBar
38204
+ */
38205
+ percentStackedBar= "PercentStackedBar",
38206
+ /**
38207
+ * Identifies the current DataChart type as area
38208
+ */
38209
+ area= "Area",
38210
+ /**
38211
+ * Identifies the current DataChart type as rangeArea
38212
+ */
38213
+ rangeArea= "RangeArea",
38214
+ /**
38215
+ * Identifies the current DataChart type as stackedArea
38216
+ */
38217
+ stackedArea= "StackedArea",
38218
+ /**
38219
+ * Identifies the current DataChart type as percentStackedArea
38220
+ */
38221
+ percentStackedArea= "PercentStackedArea",
38222
+ /**
38223
+ * Identifies the current DataChart type as line
38224
+ */
38225
+ line= "Line",
38226
+ /**
38227
+ * Identifies the current DataChart type as pie
38228
+ */
38229
+ pie= "Pie",
38230
+ /**
38231
+ * Identifies the current DataChart type as donut
38232
+ */
38233
+ donut= "Donut",
38234
+ /**
38235
+ * Identifies the current DataChart type as rose
38236
+ */
38237
+ rose= "Rose",
38238
+ /**
38239
+ * Identifies the current DataChart type as radialStackedBar
38240
+ */
38241
+ radialStackedBar= "RadialStackedBar",
38242
+ /**
38243
+ * Identifies the current DataChart type as sunburst
38244
+ */
38245
+ sunburst= "Sunburst",
38246
+ /**
38247
+ * Identifies the current DataChart type as polarCoordinatesBar
38248
+ */
38249
+ polarCoordinatesBar= "PolarCoordinatesBar",
38250
+ /**
38251
+ * Identifies the current DataChart type as polarCoordinatesStackedBar
38252
+ */
38253
+ polarCoordinatesStackedBar= "PolarCoordinatesStackedBar",
38254
+ /**
38255
+ * Identifies the current DataChart type as radar
38256
+ */
38257
+ radar= "Radar",
38258
+ /**
38259
+ * Identifies the current DataChart type as filledRadar
38260
+ */
38261
+ filledRadar= "FilledRadar",
38262
+ /**
38263
+ * Identifies the current DataChart type as scatter
38264
+ */
38265
+ scatter= "Scatter",
38266
+ /**
38267
+ * Identifies the current DataChart type as bubble
38268
+ */
38269
+ bubble= "Bubble"
38270
+ }
38271
+
38272
+ /**
38273
+ * Specifies the datachart plot DateMode.
38274
+ * @enum {string}
38275
+ */
38276
+ export enum DateMode{
38277
+ /**
38278
+ milliSecond
38279
+ */
38280
+ milliSecond= 0,
38281
+ /**
38282
+ second
38283
+ */
38284
+ second= 1,
38285
+ /**
38286
+ minute
38287
+ */
38288
+ minute= 2,
38289
+ /**
38290
+ hour
38291
+ */
38292
+ hour= 3,
38293
+ /**
38294
+ day
38295
+ */
38296
+ day= 4,
38297
+ /**
38298
+ week
38299
+ */
38300
+ week= 5,
38301
+ /**
38302
+ month
38303
+ */
38304
+ month= 6,
38305
+ /**
38306
+ year
38307
+ */
38308
+ year= 7
38309
+ }
38310
+
38311
+ /**
38312
+ * Specifies the datachart plot FontStyle.
38313
+ * @enum {string}
38314
+ */
38315
+ export enum FontStyle{
38316
+ /**
38317
+ normal
38318
+ */
38319
+ normal= "Normal",
38320
+ /**
38321
+ italic
38322
+ */
38323
+ italic= "Italic"
38324
+ }
38325
+
38326
+ /**
38327
+ * Specifies the datachart data level.
38328
+ * @enum {string}
38329
+ */
38330
+ export enum FormatType{
38331
+ /**
38332
+ hundreds
38333
+ */
38334
+ hundreds= "Hundreds",
38335
+ /**
38336
+ thousands
38337
+ */
38338
+ thousands= "Thousands",
38339
+ /**
38340
+ tenThousand
38341
+ */
38342
+ tenThousand= "10000",
38343
+ /**
38344
+ hundredThousand
38345
+ */
38346
+ hundredThousand= "100000",
38347
+ /**
38348
+ millions
38349
+ */
38350
+ millions= "Millions",
38351
+ /**
38352
+ tenMillion
38353
+ */
38354
+ tenMillion= "10000000",
38355
+ /**
38356
+ hundredMillion
38357
+ */
38358
+ hundredMillion= "100000000",
38359
+ /**
38360
+ billions
38361
+ */
38362
+ billions= "Billions",
38363
+ /**
38364
+ trillions
38365
+ */
38366
+ trillions= "Trillions"
38367
+ }
38368
+
38369
+ /**
38370
+ * Specifies the datachart plot HAlign.
38371
+ * @enum {string}
38372
+ */
38373
+ export enum HAlign{
38374
+ /**
38375
+ center
38376
+ */
38377
+ center= "Center",
38378
+ /**
38379
+ left
38380
+ */
38381
+ left= "Left",
38382
+ /**
38383
+ right
38384
+ */
38385
+ right= "Right"
38386
+ }
38387
+
38388
+ /**
38389
+ * Specifies the datachart plot LegendPosition.
38390
+ * @enum {string}
38391
+ */
38392
+ export enum LegendPosition{
38393
+ /**
38394
+ none
38395
+ */
38396
+ none= "None",
38397
+ /**
38398
+ bottom
38399
+ */
38400
+ bottom= "Bottom",
38401
+ /**
38402
+ left
38403
+ */
38404
+ left= "Left",
38405
+ /**
38406
+ right
38407
+ */
38408
+ right= "Right",
38409
+ /**
38410
+ top
38411
+ */
38412
+ top= "Top"
38413
+ }
38414
+
38415
+ /**
38416
+ * Specifies the datachart plot LegendType.
38417
+ * @enum {string}
38418
+ */
38419
+ export enum LegendType{
38420
+ /**
38421
+ color
38422
+ */
38423
+ color= "Color",
38424
+ /**
38425
+ size
38426
+ */
38427
+ size= "Size"
38428
+ }
38429
+
38430
+ /**
38431
+ * Describes the type of lines in the Area chart.
38432
+ * @enum {string}
38433
+ */
38434
+ export enum LineAspect{
38435
+ /**
38436
+ * default
38437
+ */
38438
+ default= "Default",
38439
+ /**
38440
+ * spline
38441
+ */
38442
+ spline= "Spline",
38443
+ /**
38444
+ * stepCenter
38445
+ */
38446
+ stepCenter= "StepCenter"
38447
+ }
38448
+
38449
+ /**
38450
+ * Specifies the datachart string filter logical operator.
38451
+ * @enum {string}
38452
+ */
38453
+ export enum LogicalOperation{
38454
+ /**
38455
+ and
38456
+ */
38457
+ and= "AND",
38458
+ /**
38459
+ or
38460
+ */
38461
+ or= "OR"
38462
+ }
38463
+
38464
+ /**
38465
+ * Specifies the datachart order type.
38466
+ * @enum {string}
38467
+ */
38468
+ export enum OrderType{
38469
+ /**
38470
+ * ascending
38471
+ */
38472
+ ascending= "Ascending",
38473
+ /**
38474
+ * descending
38475
+ */
38476
+ descending= "Descending",
38477
+ /**
38478
+ * none
38479
+ */
38480
+ none= "None"
38481
+ }
38482
+
38483
+ /**
38484
+ * Specifies the datachart plot OverlappingLabels.
38485
+ * @enum {string}
38486
+ */
38487
+ export enum OverlappingLabels{
38488
+ /**
38489
+ * show
38490
+ */
38491
+ show= "Show",
38492
+ /**
38493
+ * hide
38494
+ */
38495
+ hide= "Hide"
38496
+ }
38497
+
38498
+ /**
38499
+ * Specifies the datachart string filter operator.
38500
+ * @enum {string}
38501
+ */
38502
+ export enum StringOperator{
38503
+ /**
38504
+ in
38505
+ */
38506
+ in= "In",
38507
+ /**
38508
+ equalsTo
38509
+ */
38510
+ equalsTo= "EqualsTo",
38511
+ /**
38512
+ contains
38513
+ */
38514
+ contains= "Contains",
38515
+ /**
38516
+ startsWith
38517
+ */
38518
+ startsWith= "StartsWith",
38519
+ /**
38520
+ endsWith
38521
+ */
38522
+ endsWith= "EndsWith"
38523
+ }
38524
+
38525
+ /**
38526
+ * Specifies the datachart SymbolShape.
38527
+ * @enum {number}
38528
+ */
38529
+ export enum SymbolShape{
38530
+ /**
38531
+ * dot
38532
+ */
38533
+ dot= "Dot",
38534
+ /**
38535
+ * box
38536
+ */
38537
+ box= "Box",
38538
+ /**
38539
+ * diamond
38540
+ */
38541
+ diamond= "Diamond",
38542
+ /**
38543
+ * triangle
38544
+ */
38545
+ triangle= "Triangle",
38546
+ /**
38547
+ * x
38548
+ */
38549
+ x= "X",
38550
+ /**
38551
+ * plus
38552
+ */
38553
+ plus= "Plus"
38554
+ }
38555
+
38556
+ /**
38557
+ * Specifies the datachart plot TextOverflow.
38558
+ * @enum {string}
38559
+ */
38560
+ export enum TextOverflow{
38561
+ /**
38562
+ * clip
38563
+ */
38564
+ clip= "Clip",
38565
+ /**
38566
+ * ellipsis
38567
+ */
38568
+ ellipsis= "Ellipsis",
38569
+ /**
38570
+ * wrap
38571
+ */
38572
+ wrap= "Wrap"
38573
+ }
38574
+
38575
+ /**
38576
+ * Specifies the datachart plot TextPosition.
38577
+ * @enum {string}
38578
+ */
38579
+ export enum TextPosition{
38580
+ /**
38581
+ * center
38582
+ */
38583
+ center= "Center",
38584
+ /**
38585
+ * inside
38586
+ */
38587
+ inside= "Inside",
38588
+ /**
38589
+ * outside
38590
+ */
38591
+ outside= "Outside"
38592
+ }
38593
+
38594
+ /**
38595
+ * Specifies the datachart plot TickMark.
38596
+ * @enum {string}
38597
+ */
38598
+ export enum TickMark{
38599
+ /**
38600
+ cross
38601
+ */
38602
+ cross= "Cross",
38603
+ /**
38604
+ inside
38605
+ */
38606
+ inside= "Inside",
38607
+ /**
38608
+ none
38609
+ */
38610
+ none= "None",
38611
+ /**
38612
+ outside
38613
+ */
38614
+ outside= "Outside"
38615
+ }
38616
+
38617
+ /**
38618
+ * Specifies the datachart plot VAlign.
38619
+ * @enum {string}
38620
+ */
38621
+ export enum VAlign{
38622
+ /**
38623
+ top
38624
+ */
38625
+ top= "Top",
38626
+ /**
38627
+ bottom
38628
+ */
38629
+ bottom= "Bottom",
38630
+ /**
38631
+ middle
38632
+ */
38633
+ middle= "Middle"
38634
+ }
38635
+
38636
+ /**
38637
+ * Specifies the datachart plot Orientation.
38638
+ * @enum {string}
38639
+ */
38640
+ export enum ValueOptionType{
38641
+ /**
38642
+ number
38643
+ */
38644
+ number= 0,
38645
+ /**
38646
+ date
38647
+ */
38648
+ date= 1
38649
+ }
38650
+
38651
+ /**
38652
+ * Specifies the datachart plot ValueScaleType.
38653
+ * @enum {string}
38654
+ */
38655
+ export enum ValueScaleType{
38656
+ /**
38657
+ date
38658
+ */
38659
+ date= "Date",
38660
+ /**
38661
+ linear
38662
+ */
38663
+ linear= "Linear"
38664
+ }
38665
+
38666
+
38667
+ export class DataChart{
38668
+ /**
38669
+ * Represents a datachart.
38670
+ * @class
38671
+ * @param {GC.Spread.Sheets.Worksheet} sheet The host sheet of the datachart.
38672
+ * @param {string} name The name of the datachart.
38673
+ * @param {number} x The <i>x</i> location of the datachart.
38674
+ * @param {number} y The <i>y</i> location of the datachart.
38675
+ * @param {number} width The width of the datachart.
38676
+ * @param {number} height The height of the datachart.
38677
+ * @param {GC.Spread.Sheets.DataCharts.DataChartType} type The type of the datachart.
38678
+ */
38679
+ constructor(sheet: GC.Spread.Sheets.Worksheet, name: string, x: number, y: number, width: number, height: number, type: GC.Spread.Sheets.DataCharts.DataChartType);
38680
+ /**
38681
+ * Gets or sets whether to disable moving the data chart.
38682
+ * @param {boolean} value The setting for whether to disable moving the data chart.
38683
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the setting for whether to disable moving the data chart; otherwise, returns the data chart.
38684
+ */
38685
+ allowMove(value?: boolean): any;
38686
+ /**
38687
+ * Gets or sets whether to disable resizing the data chart.
38688
+ * @param {boolean} value The setting for whether to disable resizing the data chart.
38689
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the setting for whether to disable resizing the data chart; otherwise, returns the data chart.
38690
+ */
38691
+ allowResize(value?: boolean): any;
38692
+ /**
38693
+ * Gets or sets the alternative text of the data chart for screen readers.
38694
+ * @param {string} value The alternative text of the data chart.
38695
+ * @returns {string} The alternative text of the data chart.
38696
+ */
38697
+ alt(value?: string): any;
38698
+ /**
38699
+ * Gets or sets whether this data chart is printable.
38700
+ * @param {boolean} value The value that indicates whether this data chart is printable.
38701
+ * @returns {boolean | void} If no value is set, returns whether this data chart is printable.
38702
+ */
38703
+ canPrint(value?: boolean): any;
38704
+ /**
38705
+ * Gets or sets whether the object moves when hiding or showing, resizing, or moving rows or columns.
38706
+ * @param {boolean} value The value indicates whether the object moves when hiding or showing, resizing, or moving rows or columns.
38707
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns whether this data chart dynamically moves; otherwise, returns the data chart.
38708
+ */
38709
+ dynamicMove(value?: boolean): any;
38710
+ /**
38711
+ * Gets or sets whether the position of the data chart is fixed. When fixedPosition is true, dynamicMove and dynamicSize are disabled.
38712
+ * @param {boolean} value The value indicates whether the position of the data chart is fixed.
38713
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns whether the position of the data chart is fixed; otherwise, returns the data chart.
38714
+ */
38715
+ dynamicSize(value?: boolean): any;
38716
+ /**
38717
+ * Gets or sets the end column index of the data chart position.
38718
+ * @param {number} value The end column index of the data chart position.
38719
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the end column index of the data chart position; otherwise, returns the data chart.
38720
+ */
38721
+ endColumn(value?: number): any;
38722
+ /**
38723
+ * Gets or sets the offset relative to the end column of the data chart.
38724
+ * @param {number} value The offset relative to the end column of the data chart.
38725
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the offset relative to the end column of the data chart; otherwise, returns the data chart.
38726
+ */
38727
+ endColumnOffset(value?: number): any;
38728
+ /**
38729
+ * Gets or sets the end row index of the data chart position.
38730
+ * @param {number} value The end row index of the data chart position.
38731
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the end row index of the data chart position; otherwise, returns the data chart.
38732
+ */
38733
+ endRow(value?: number): any;
38734
+ /**
38735
+ * Gets or sets the offset relative to the end row of the data chart.
38736
+ * @param {number} value The offset relative to the end row of the data chart.
38737
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the offset relative to the end row of the data chart; otherwise, returns the data chart.
38738
+ */
38739
+ endRowOffset(value?: number): any;
38740
+ /**
38741
+ * get datachart config.
38742
+ * @return {object} The config of the datachart.
38743
+ * @example
38744
+ * ```
38745
+ * var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38746
+ * console.log(datachart.getChartConfig());
38747
+ * ```
38748
+ */
38749
+ getChartConfig(): GC.Spread.Sheets.DataCharts.IDataChartConfig;
38750
+ /**
38751
+ * Gets or sets the height of a data chart.
38752
+ * @param {number} value The height of a data chart.
38753
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the height of a data chart; otherwise, returns the data chart.
38754
+ */
38755
+ height(value?: number): any;
38756
+ /**
38757
+ * Gets or sets whether this data chart is locked.
38758
+ * @param {boolean} value The value that indicates whether this data chart is locked.
38759
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns whether this data chart is locked; otherwise, returns the data chart.
38760
+ */
38761
+ isLocked(value?: boolean): any;
38762
+ /**
38763
+ * Gets or sets whether this data chart is selected.
38764
+ * @param {boolean} value The value that indicates whether this data chart is selected.
38765
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns whether this data chart is selected; otherwise, returns the data chart.
38766
+ */
38767
+ isSelected(value?: boolean): any;
38768
+ /**
38769
+ * Gets or sets whether this data chart is visible.
38770
+ * @param {boolean} value The value that indicates whether this data chart is visible.
38771
+ * @returns {boolean | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns whether this data chart is visible; otherwise, returns the data chart.
38772
+ */
38773
+ isVisible(value?: boolean): any;
38774
+ /**
38775
+ * Gets the name of the data chart.
38776
+ * @param {string} value The name of the data chart.
38777
+ * @returns {string | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the name of the data chart; otherwise, returns the data chart.
38778
+ */
38779
+ name(value?: string): any;
38780
+ /**
38781
+ * set datachart config.
38782
+ * @param {object} config The config of the datachart.
38783
+ * @example
38784
+ * ```
38785
+ * var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38786
+ * var config = datachart.getChartConfig();
38787
+ * config.plots[0].type = GC.Spread.Sheets.DataCharts.DataChartType.line;
38788
+ * datachart.setChartConfig(config);
38789
+ * ```
38790
+ */
38791
+ setChartConfig(config: GC.Spread.Sheets.DataCharts.IDataChartConfig): void;
38792
+ /**
38793
+ * Gets or sets the starting column index of the data chart position.
38794
+ * @param {number} value The starting column index of the data chart position.
38795
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the starting column index of the data chart position; otherwise, returns the data chart.
38796
+ */
38797
+ startColumn(value?: number): any;
38798
+ /**
38799
+ * Gets or sets the offset relative to the start column of the data chart.
38800
+ * @param {number} value The offset relative to the start column of the data chart.
38801
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the offset relative to the start column of the data chart; otherwise, returns the data chart.
38802
+ */
38803
+ startColumnOffset(value?: number): any;
38804
+ /**
38805
+ * Gets or sets the starting row index of the data chart position.
38806
+ * @param {number} value The starting row index of the data chart position.
38807
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the starting row index of the data chart position; otherwise, returns the data chart.
38808
+ */
38809
+ startRow(value?: number): any;
38810
+ /**
38811
+ * Gets or sets the offset relative to the start row of the data chart.
38812
+ * @param {number} value The offset relative to the start row of the data chart.
38813
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the offset relative to the start row of the data chart; otherwise, returns the data chart.
38814
+ */
38815
+ startRowOffset(value?: number): any;
38816
+ /**
38817
+ * Gets or sets the width of a data chart.
38818
+ * @param {number} value The width of a data chart.
38819
+ * @returns {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the width of a data chart; otherwise, returns the data chart.
38820
+ */
38821
+ width(value?: number): any;
38822
+ /**
38823
+ * Gets or sets the horizontal location of the data chart.
38824
+ * @param {number} value The horizontal location of the data chart.
38825
+ * @return {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the horizontal location of the data chart; otherwise, returns the data chart.
38826
+ */
38827
+ x(value?: number): any;
38828
+ /**
38829
+ * Gets or sets the vertical location of the data chart.
38830
+ * @param {number} value The vertical location of the data chart.
38831
+ * @return {number | GC.Spread.Sheets.DataCharts.DataChart} If no value is set, returns the vertical location of the data chart; otherwise, returns the data chart.
38832
+ */
38833
+ y(value?: number): any;
38834
+ }
38835
+
38836
+ export class DataChartConfigPanel{
38837
+ /**
38838
+ * Represents a data chart config panel.
38839
+ * @class
38840
+ * @param {HTMLElement | string} host The host element or the host element id or the host element selector.
38841
+ * @param {object} spread The spread that the panel attach to.
38842
+ */
38843
+ constructor(host: HTMLElement | string, spread: GC.Spread.Sheets.Workbook);
38844
+ /**
38845
+ * attach the spread to the config panel.
38846
+ * @example
38847
+ * ```
38848
+ * configPanel.attach(spread);
38849
+ * ```
38850
+ */
38851
+ attach(spread: GC.Spread.Sheets.Workbook): void;
38852
+ /**
38853
+ * destroy the config panel.
38854
+ * @example
38855
+ * ```
38856
+ * configPanel.destroy();
38857
+ * ```
38858
+ */
38859
+ destroy(): void;
38860
+ /**
38861
+ * detach the spread from the config panel.
38862
+ * @example
38863
+ * ```
38864
+ * configPanel.detach();
38865
+ * ```
38866
+ */
38867
+ detach(): void;
38868
+ /**
38869
+ * Gets the DataChartConfigPanel instance by the host element.
38870
+ * @param {HTMLElement|string} host The host element or the host element id or the host element selector.
38871
+ * @returns {GC.Spread.Sheets.DataCharts.DataChartConfigPanel} The DataChartConfigPanel instance.
38872
+ * @example
38873
+ * ```
38874
+ * const configPanel = GC.Spread.Sheets.DataCharts.DataChartConfigPanel.findControl('host');
38875
+ * ```
38876
+ */
38877
+ static findControl(host: HTMLElement|string): GC.Spread.Sheets.DataCharts.DataChartConfigPanel;
38878
+ }
38879
+
38880
+ export class DataChartManager{
38881
+ /**
38882
+ * Represents a datachart manager that managers all datacharts in a sheet.
38883
+ * @class
38884
+ * @param {GC.Spread.Sheets.Worksheet} sheet The worksheet.
38885
+ */
38886
+ constructor();
38887
+ /**
38888
+ * Adds a datachart to the sheet.
38889
+ * @param {string} name The name of the datachart that will be added to the sheet.
38890
+ * @param {number} x The x location of the datachart.
38891
+ * @param {number} y The y location of the datachart.
38892
+ * @param {number} width The width of the datachart.
38893
+ * @param {number} height The height of the datachart.
38894
+ * @param {GC.Spread.Sheets.DataCharts.DataChartType} type The type of the datachart.
38895
+ * @return {GC.Spread.Sheets.DataCharts.DataChart} The datachart that has been added to the sheet.
38896
+ * @example
38897
+ * ```
38898
+ * //This example shows how to add a datachart.
38899
+ * var datachart = activeSheet.datacharts.add('datachart1', 250, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38900
+ * ```
38901
+ */
38902
+ add(name: string, x: number, y: number, width: number, height: number, type: GC.Spread.Sheets.DataCharts.DataChartType): GC.Spread.Sheets.DataCharts.DataChart;
38903
+ /**
38904
+ * get all data charts.
38905
+ * @return {GC.Spread.Sheets.DataCharts.DataChart[]} get all data charts.
38906
+ * @example
38907
+ * ```
38908
+ * activeSheet.datacharts.add('DataChart1', 0, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38909
+ * activeSheet.datacharts.add('DataChart2', 500, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.pie);
38910
+ * var dataCharts = activeSheet.datacharts.all();
38911
+ * for (var i = 0; i &lt; dataCharts.length; i++) {
38912
+ * alert("Name of dataChart " + i + " is: " + dataCharts[i].name())
38913
+ * }
38914
+ * ```
38915
+ */
38916
+ all(): GC.Spread.Sheets.DataCharts.DataChart[];
38917
+ /**
38918
+ * remove all data charts.
38919
+ */
38920
+ clear(): void;
38921
+ /**
38922
+ * get a data charts by name.
38923
+ * @param {string} name data chart name.
38924
+ * @return {GC.Spread.Sheets.DataCharts.DataChart} get a data charts by name.
38925
+ * @example
38926
+ * ```
38927
+ * activeSheet.datacharts.add('DataChart1', 0, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38928
+ * //button
38929
+ * $("#button1").click(function () {
38930
+ * var dataChart = activeSheet.datacharts.get("DataChart1");
38931
+ * });
38932
+ * ```
38933
+ */
38934
+ get(name: string): GC.Spread.Sheets.DataCharts.DataChart;
38935
+ /**
38936
+ * remove a data charts by name.
38937
+ * @param {string} name data chart name.
38938
+ * @example
38939
+ * ```
38940
+ * activeSheet.datacharts.add('DataChart1', 0, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38941
+ * //button
38942
+ * $("#button1").click(function () {
38943
+ * activeSheet.resumePaint();
38944
+ * activeSheet.datacharts.remove("DataChart1");
38945
+ * activeSheet.repaint();
38946
+ * });
38947
+ * ```
38948
+ */
38949
+ remove(name: string): void;
38950
+ /**
38951
+ * Gets or sets the z-index of chart.
38952
+ * @param {string} name The name of the chart.
38953
+ * @param {number} zIndex The z-index of the chart.
38954
+ * @return {number | *} If the parameter 'zIndex' is null or undefined,it will return the z-index of the chart with the indicate name.
38955
+ * @example
38956
+ * ```
38957
+ * activeSheet.datacharts.add('DataChart1', 200, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.column);
38958
+ * activeSheet.datacharts.add('DataChart2', 0, 20, 480, 300, GC.Spread.Sheets.DataCharts.DataChartType.pie);
38959
+ * activeSheet.datacharts.zIndex('DataChart1', 897);
38960
+ * activeSheet.datacharts.zIndex('DataChart2', 890);
38961
+ * ```
38962
+ */
38963
+ zIndex(name: string, zIndex?: number): any;
38964
+ }
38965
+ }
38966
+
38967
+ module DataRange{
38968
+
38969
+ export interface IDataProvider{
38970
+ /**
38971
+ * The data provider host.
38972
+ */
38973
+ host: GC.Spread.Sheets.DataRange.DataRange;
38974
+ /**
38975
+ * Implement this hook to provide values to data range cells. The `row` and `col` parameters are based on the data range axis. If returns `undefined`, it means fail to get value from data provider, so it will continue to get the value from sheet model.
38976
+ */
38977
+ getValue?: (row: number, col: number) => unknown;
38978
+ /**
38979
+ * Implement this hook to receive the changed values from data range. The `row` and `col` parameters are based on the data range axis. Post your change into `changes` parameter if you want undo/redo. If returns `true`, it means set value successfully to data provider, so it will prevent to set the value to sheet model.
38980
+ */
38981
+ setValue?: (row: number, col: number, value: unknown, changes: any[]) => boolean;
38982
+ /**
38983
+ * Implement this hook to provide styles to data range cells. The `row` and `col` parameters are based on the data range axis. It should return the style as `GC.Spread.Sheets.Style`, otherwise, means fail to get style from data provider, so it will continue to get the style from sheet model.
38984
+ */
38985
+ getStyle?: (row: number, col: number) => GC.Spread.Sheets.Style;
38986
+ /**
38987
+ * Implement this hook to provide spans to data range cells. The `row`, `col`, `rowCount` and `colCount` parameters are based on the data range axis.
38988
+ */
38989
+ getSpans?: (row: number, col: number, rowCount: number, colCount: number) => GC.Spread.Sheets.Range[];
38990
+ /**
38991
+ * Implement this hook to receive changed rows information. The `row` and `rowCount` parameters are based on the data range axis. Post your change into `changes` parameter if you want undo/redo.
38992
+ */
38993
+ onRowChange?: (row: number, rowCount: number, changeType: "add" | "delete", changes: any[]) => void;
38994
+ /**
38995
+ * Implement this hook to receive changed columns information. The `col` and `colCount` parameters are based on the data range axis. Post your change into `changes` parameter if you want undo/redo.
38996
+ */
38997
+ onColumnChange?: (col: number, colCount: number, changeType: "add" | "delete", changes: any[]) => void;
38998
+ /**
38999
+ * Implement this hook to handle the copy action. Input parameter `name` is copied data range name, need to return a different new data range `name` and a data provider instance. Return `false` means prevent to copy data range. Default is `false`.
39000
+ */
39001
+ onCopy?: (name: string) => {name: string, dataProvider: GC.Spread.Sheets.DataRange.IDataProvider} | boolean;
39002
+ /**
39003
+ * Implement this hook to handle the clear contents action. Return `false` means prevent to clear data range contents. Default is `false`.
39004
+ */
39005
+ onClear?: (row: number, col: number, rowCount: number, colCount: number, changes: any[]) => boolean;
39006
+ /**
39007
+ * Implement this hook to handle the destroy action.
39008
+ */
39009
+ onDestroy?: () => void;
39010
+ /**
39011
+ * Implement this hook to handle the mouse down action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39012
+ */
39013
+ onMouseDown?: (row: number, col: number, e: MouseEvent) => boolean;
39014
+ /**
39015
+ * Implement this hook to handle the mouse move action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39016
+ */
39017
+ onMouseMove?: (row: number, col: number, e: MouseEvent) => boolean;
39018
+ /**
39019
+ * Implement this hook to handle the mouse up action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39020
+ */
39021
+ onMouseUp?: (row: number, col: number, e: MouseEvent) => boolean;
39022
+ /**
39023
+ * Implement this hook to handle the mouse context menu action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39024
+ */
39025
+ onContextMenu?: (row: number, col: number, e: MouseEvent) => boolean;
39026
+ /**
39027
+ * Implement this hook to handle the mouse double click action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39028
+ */
39029
+ onDoubleClick?: (row: number, col: number, e: MouseEvent) => boolean;
39030
+ /**
39031
+ * Implement this hook to handle the mouse wheel action. Return `true` means prevent the next sheet actions. Default is false.
39032
+ */
39033
+ onMouseWheel?: (deltaX: number, deltaY: number, e: MouseEvent) => boolean;
39034
+ /**
39035
+ * Implement this hook to handle the key down action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39036
+ */
39037
+ onKeyDown?: (row: number, col: number, e: KeyboardEvent) => boolean;
39038
+ /**
39039
+ * Implement this hook to handle the key down action. The `row` and `col` parameters are based on the data range axis. Return `true` means prevent the next sheet actions. Default is false.
39040
+ */
39041
+ onKeyUp?: (row: number, col: number, e: KeyboardEvent) => boolean;
39042
+ /**
39043
+ * Implement this hook to handle the undo action. Input parameter `change` is the user created in the corresponding hooks.
39044
+ */
39045
+ undo?: (change: any) => void;
39046
+ /**
39047
+ * Implement this hook to handle the serialization.
39048
+ */
39049
+ toJSON?: () => { typeName: string, [prop: string]: any };
39050
+ /**
39051
+ * Implement this hook to handle the deserialization.
39052
+ */
39053
+ fromJSON?: (options: { typeName: string, [prop: string]: any }) => void;
39054
+ }
39055
+
39056
+
39057
+ export interface IDataRangeOptions{
39058
+ /**
39059
+ * Indicates the top rows count to be sticked.
39060
+ */
39061
+ sticky: { top: number };
39062
+ }
39063
+
39064
+
39065
+ export class DataRange{
39066
+ /**
39067
+ * Represents a data range.
39068
+ * @class
39069
+ * @param {string} name The name of the data range.
39070
+ * @param {GC.Spread.Sheets.DataRange.IDataProvider} dataProvider The data provider of the data range.
39071
+ * @param {GC.Spread.Sheets.Range} range The range of the data range.
39072
+ * @param {GC.Spread.Sheets.DataRange.IDataRangeOptions} [options] The options of the data range.
39073
+ */
39074
+ constructor(name: string, dataProvider: GC.Spread.Sheets.DataRange.IDataProvider, range: GC.Spread.Sheets.Range, options?: GC.Spread.Sheets.DataRange.IDataRangeOptions);
39075
+ /**
39076
+ * @description Get or set the name of the data range.
39077
+ * @param {string} [name] this name of the data range
39078
+ * @returns {string} If no value is set, returns the name of the data range.
39079
+ */
39080
+ name(name?: string): string;
39081
+ /**
39082
+ * @description Get or set the range of the data range.
39083
+ * @param {GC.Spread.Sheets.Range} [range] this range of the data range
39084
+ * @returns {GC.Spread.Sheets.Range} If no value is set, returns the range of the data range.
39085
+ */
39086
+ range(range?: GC.Spread.Sheets.Range): GC.Spread.Sheets.Range;
39087
+ /**
39088
+ * @description repaint the data range
39089
+ */
39090
+ repaint(): void;
39091
+ }
39092
+
39093
+ export class DataRangeManager{
39094
+ /**
39095
+ * @description Represents a data range manager.
39096
+ * @class
39097
+ * @param {GC.Spread.Sheets.Worksheet} sheet The worksheet.
39098
+ */
39099
+ constructor(sheet: GC.Spread.Sheets.Worksheet);
39100
+ /**
39101
+ * @description Adds a data range.
39102
+ * @param {string} name The data range name.
39103
+ * @param {GC.Spread.Sheets.DataRange.IDataProvider | string} dataProvider The data provider. String type means the tableSheet name, it will create a TableSheetDataProvider.
39104
+ * @param {GC.Spread.Sheets.Range} range The range of data range.
39105
+ * @param {GC.Spread.Sheets.DataRange.IDataRangeOptions} [options] The data range options.
39106
+ * @returns {GC.Spread.Sheets.DataRange.DataRange} The added data range.
39107
+ */
39108
+ add(name: string, dataProvider: GC.Spread.Sheets.DataRange.IDataProvider | string, range: GC.Spread.Sheets.Range, options?: GC.Spread.Sheets.DataRange.IDataRangeOptions): GC.Spread.Sheets.DataRange.DataRange;
39109
+ /**
39110
+ * @description Get all data ranges.
39111
+ * @returns {GC.Spread.Sheets.DataRange.DataRange[]} The array of data range instances. Default is empty array.
39112
+ */
39113
+ all(): GC.Spread.Sheets.DataRange.DataRange[];
39114
+ /**
39115
+ * @description Remove all data ranges.
39116
+ */
39117
+ clear(): void;
39118
+ /**
39119
+ * @description Gets a data range.
39120
+ * @param {string} name The data range name.
39121
+ * @returns {GC.Spread.Sheets.DataRange.DataRange} The target data range.
39122
+ */
39123
+ get(name: string): GC.Spread.Sheets.DataRange.DataRange;
39124
+ /**
39125
+ * @description Remove a data range.
39126
+ * @param {string} name The data range name.
39127
+ */
39128
+ remove(name: string): void;
39129
+ }
39130
+ }
39131
+
37235
39132
  module DataValidation{
37236
39133
  /**
37237
39134
  * Creates a validator based on the data.
@@ -37477,6 +39374,19 @@ declare module GC{
37477
39374
  /**
37478
39375
  * Indicates the data validation highlightposition.
37479
39376
  * @enum {number}
39377
+ * @example
39378
+ * ```
39379
+ * //This example uses the highlightStyle method.
39380
+ * sheet.setValue(1, 1, "sss");
39381
+ * var dv = GC.Spread.Sheets.DataValidation.createListValidator('Fruit,Vegetable,Food');
39382
+ * dv.highlightStyle({
39383
+ * type:GC.Spread.Sheets.DataValidation.HighlightType.dogEar,
39384
+ * color:'blue',
39385
+ * position:GC.Spread.Sheets.DataValidation.HighlightPosition.topLeft
39386
+ * });
39387
+ * sheet.setDataValidator(1,1, dv);
39388
+ * spread.options.highlightInvalidData = true;
39389
+ * ```
37480
39390
  */
37481
39391
  export enum HighlightPosition{
37482
39392
  /**
@@ -37508,6 +39418,19 @@ declare module GC{
37508
39418
  /**
37509
39419
  * Indicates the data validation highlightType.
37510
39420
  * @enum {number}
39421
+ * @example
39422
+ * ```
39423
+ * //This example uses the highlightStyle method.
39424
+ * sheet.setValue(1, 1, "sss");
39425
+ * var dv = GC.Spread.Sheets.DataValidation.createListValidator('Fruit,Vegetable,Food');
39426
+ * dv.highlightStyle({
39427
+ * type:GC.Spread.Sheets.DataValidation.HighlightType.dogEar,
39428
+ * color:'blue',
39429
+ * position:GC.Spread.Sheets.DataValidation.HighlightPosition.topLeft
39430
+ * });
39431
+ * sheet.setDataValidator(1,1, dv);
39432
+ * spread.options.highlightInvalidData = true;
39433
+ * ```
37511
39434
  */
37512
39435
  export enum HighlightType{
37513
39436
  /**
@@ -37550,18 +39473,52 @@ declare module GC{
37550
39473
  * Gets or sets the condition to validate.
37551
39474
  * @param {GC.Spread.Sheets.ConditionalFormatting.Condition} [value] The condition to validate.
37552
39475
  * @returns {GC.Spread.Sheets.ConditionalFormatting.Condition | GC.Spread.Sheets.DataValidation.DefaultDataValidator} If no value is set, returns the condition to validate; otherwise, returns the data validator.
39476
+ * @example
39477
+ * ```
39478
+ * var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.averageCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above});
39479
+ * nCondition.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
39480
+ * var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator();
39481
+ * validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
39482
+ * validator.condition(nCondition);
39483
+ * activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
39484
+ * spread.options.highlightInvalidData = true;
39485
+ * activeSheet.setValue(0, 0, 5);
39486
+ * activeSheet.setValue(1, 0, 15);
39487
+ * ```
37553
39488
  */
37554
39489
  condition(value?: GC.Spread.Sheets.ConditionalFormatting.Condition): any;
37555
39490
  /**
37556
39491
  * Gets or sets the error message.
37557
39492
  * @param {string} [value] The error message.
37558
39493
  * @returns {string | GC.Spread.Sheets.DataValidation.DefaultDataValidator} If no value is set, returns the error message; otherwise, returns the data validator.
39494
+ * @example
39495
+ * ```
39496
+ * var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
39497
+ * nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
39498
+ * nCondition.expected(0);
39499
+ * var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
39500
+ * validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
39501
+ * validator.errorMessage('Incorrect input, please input a positive number');
39502
+ * activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
39503
+ * ```
37559
39504
  */
37560
39505
  errorMessage(value?: string): any;
37561
39506
  /**
37562
39507
  * Gets or sets the error style to display.
37563
39508
  * @param {GC.Spread.Sheets.DataValidation.ErrorStyle} [value] The error style to display.
37564
39509
  * @returns {GC.Spread.Sheets.DataValidation.ErrorStyle | GC.Spread.Sheets.DataValidation.DefaultDataValidator} If no value is set, returns the error style to display; otherwise, returns the data validator.
39510
+ * @example
39511
+ * ```
39512
+ * var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.averageCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above});
39513
+ * nCondition.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
39514
+ * var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
39515
+ * validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
39516
+ * validator.errorStyle(GC.Spread.Sheets.DataValidation.ErrorStyle.warning);
39517
+ * activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
39518
+ * spread.options.highlightInvalidData = true;
39519
+ * activeSheet.setValue(0, 0, 5);
39520
+ * activeSheet.setValue(1, 0, 15);
39521
+ * ```
37565
39522
  */
37566
39523
  errorStyle(value?: GC.Spread.Sheets.DataValidation.ErrorStyle): any;
37567
39524
  /**
@@ -37576,6 +39533,16 @@ declare module GC{
37576
39533
  * @param {number} baseRow The base row.
37577
39534
  * @param {number} baseColumn The base column.
37578
39535
  * @returns {Object[]} The valid data lists or null.
39536
+ * @example
39537
+ * ```
39538
+ * spread.options.highlightInvalidData = true;
39539
+ * var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
39540
+ * dv.showInputMessage(true);
39541
+ * dv.inputMessage("Value must be 1,2 or 3");
39542
+ * dv.inputTitle("tip");
39543
+ * activeSheet.setDataValidator(1,1,1,1,dv, GC.Spread.Sheets.SheetArea.viewport);
39544
+ * alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));
39545
+ * ```
37579
39546
  */
37580
39547
  getValidList(evaluator: Object, baseRow: number, baseColumn: number): any[];
37581
39548
  /**
@@ -37787,6 +39754,21 @@ declare module GC{
37787
39754
  * Gets or sets the criteria type of this data validator.
37788
39755
  * @param {GC.Spread.Sheets.DataValidation.CriteriaType} [value] The criteria type of this data validator.
37789
39756
  * @returns {GC.Spread.Sheets.DataValidation.CriteriaType | GC.Spread.Sheets.DataValidation.DefaultDataValidator} If no value is set, returns the criteria type of this data validator; otherwise, returns the data validator.
39757
+ * @example
39758
+ * ```
39759
+ * //This example uses the preciseCompareDate method.
39760
+ * var dateCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition);
39761
+ * dateCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.DateCompareType.after);
39762
+ * dateCondition.expected(new Date(2020, 4, 22, 6));
39763
+ * //When the option is false, the validator compares the whole day, and they are the same, so validation fails and the red alert is displayed.
39764
+ * //When the option is true, the date time 7 o'clock is greater than 6 o'clock, so the result is successful.
39765
+ * var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(dateCondition);
39766
+ * validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.date);
39767
+ * validator.preciseCompareDate(true);
39768
+ * activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
39769
+ * spread.options.highlightInvalidData = true;
39770
+ * activeSheet.setValue(0, 0, new Date(2020, 4, 22, 7));
39771
+ * ```
37790
39772
  */
37791
39773
  type(value?: GC.Spread.Sheets.DataValidation.CriteriaType): any;
37792
39774
  /**
@@ -39520,13 +41502,28 @@ declare module GC{
39520
41502
  constructor(host: HTMLElement, options?: GC.Spread.Sheets.FormulaTextBox.IFormulaTextBoxOptions);
39521
41503
  /**
39522
41504
  * Adds a custom function description.
39523
- * @param {GC.Spread.CalcEngine.Functions.IFunctionDescription} functionDescription The function description to add. This can be an array. See the Remarks for more information.
41505
+ * @param {GC.Spread.CalcEngine.Functions.IFunctionDescription | GC.Spread.CalcEngine.Functions.IFunctionDescription[]} functionDescription The function description to add. This can be an array. See the Remarks for more information.
39524
41506
  */
39525
- add(functionDescription: GC.Spread.CalcEngine.Functions.IFunctionDescription): void;
41507
+ add(functionDescription: GC.Spread.CalcEngine.Functions.IFunctionDescription | GC.Spread.CalcEngine.Functions.IFunctionDescription[]): void;
39526
41508
  /**
39527
41509
  * Gets or sets whether the text box uses automatic complete.
39528
- * @param {boolean} value Whether to use automatic complete when editing.
41510
+ * @param {boolean} [value] Whether to use automatic complete when editing.
39529
41511
  * @returns {boolean} If no value is set, returns whether the text box uses auto complete; otherwise, there is no return value.
41512
+ * @example
41513
+ * ```
41514
+ * var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
41515
+ * var div = document.createElement('div');
41516
+ * div.id = 'fbx';
41517
+ * div.style.width = '300px';
41518
+ * div.style.height = '50px';
41519
+ * div.setAttribute('contentEditable', 'true');
41520
+ * document.getElementById('panel').appendChild(div);
41521
+ * var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
41522
+ * formulaTextBox.workbook(spread);
41523
+ * formulaTextBox.autoComplete(false);
41524
+ *
41525
+ * // input "=SUM" formula prefix in the formula text box input element, the func hint box will not show
41526
+ * ```
39530
41527
  */
39531
41528
  autoComplete(value?: boolean): boolean;
39532
41529
  /**
@@ -39545,14 +41542,44 @@ declare module GC{
39545
41542
  remove(name: string): void;
39546
41543
  /**
39547
41544
  * Gets or sets whether to display the function's help tip.
39548
- * @param {boolean} value Whether to display the function's help tip when editing.
41545
+ * @param {boolean} [value] Whether to display the function's help tip when editing.
39549
41546
  * @returns {boolean} If no value is set, returns whether the text box displays the function's help tip when editing; otherwise, there is no return value.
41547
+ * @example
41548
+ * ```
41549
+ * var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
41550
+ * var div = document.createElement('div');
41551
+ * div.id = 'fbx';
41552
+ * div.style.width = '300px';
41553
+ * div.style.height = '50px';
41554
+ * div.setAttribute('contentEditable', 'true');
41555
+ * document.getElementById('panel').appendChild(div);
41556
+ * var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
41557
+ * formulaTextBox.workbook(spread);
41558
+ * formulaTextBox.showHelp(false);
41559
+ *
41560
+ * // input "=SUM" formula prefix in the formula text box input element, the func hint (auto complete) box iwll show, but the help func will not show
41561
+ * ```
39550
41562
  */
39551
41563
  showHelp(value?: boolean): any;
39552
41564
  /**
39553
41565
  * Gets or sets the text.
39554
- * @param {string} value The text.
41566
+ * @param {string} [value] The text.
39555
41567
  * @returns {string} If no value is set, returns the text; otherwise, there is no return value.
41568
+ * @example
41569
+ * ```
41570
+ * var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
41571
+ * var div = document.createElement('div');
41572
+ * div.id = 'fbx';
41573
+ * div.style.width = '300px';
41574
+ * div.style.height = '50px';
41575
+ * div.setAttribute('contentEditable', 'true');
41576
+ * document.getElementById('panel').appendChild(div);
41577
+ * var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
41578
+ * formulaTextBox.workbook(spread);
41579
+ * formulaTextBox.text('this is text');
41580
+ * // worksheet will be in edit status with the text value and formula text box input box will also show the text value.
41581
+ * console.log(formulaTextBox.text()); // 'this is text'
41582
+ * ```
39556
41583
  */
39557
41584
  text(value?: string): string;
39558
41585
  /**
@@ -41309,6 +43336,22 @@ declare module GC{
41309
43336
  * @property {boolean} [enableNavigateToRange] Indicates whether enable navigate to the named range or drawing item when input its name or click on custom list item.
41310
43337
  * @property {boolean} [showCustomNameList] Indicates whether show the custom name list dropdown indicator.
41311
43338
  * @property {number} [dropDownMaxHeight] Indicates the drop down list element max height.
43339
+ * @example
43340
+ * ```
43341
+ * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
43342
+ * var div = document.createElement('div');
43343
+ * div.id = 'nameBox';
43344
+ * div.style.width = '300px';
43345
+ * div.style.height = '50px';
43346
+ * document.getElementById('panel').appendChild(div);
43347
+ *
43348
+ * var nameBox = new GC.Spread.Sheets.NameBox.NameBox(document.getElementById('nameBox'), spread);
43349
+ * nameBox.options.enableAddCustomName = false; // cannot add custom name with inputting in name box input box now.
43350
+ * nameBox.options.enableNavigateToRange = false; // cannot swap the selected range to the value of the name box input box now.
43351
+ * nameBox.options.showCustomNameList = false; // cannot open the custom name list by down arrow button right side and the button will be hidden now.
43352
+ * nameBox.options.dropDownMaxHeight = 100; // the custom name list host DOM element height will no larger than 100px now.
43353
+ *
43354
+ * ```
41312
43355
  */
41313
43356
  options: GC.Spread.Sheets.NameBox.INameBoxOptions;
41314
43357
  /**
@@ -41396,26 +43439,110 @@ declare module GC{
41396
43439
  * Gets the check status of the row or all rows.
41397
43440
  * @param {number} [row] The index of the row.
41398
43441
  * @returns {boolean|boolean[]} If row is undefined, returns all row's check status; otherwise, returns the check status of the row.
43442
+ * @example
43443
+ * ```
43444
+ * spread.suspendPaint();
43445
+ * activeSheet.setValue(0, 0, "Name", GC.Spread.Sheets.SheetArea.colHeader);
43446
+ * activeSheet.setValue(0, 1, "Chapter", GC.Spread.Sheets.SheetArea.colHeader);
43447
+ * activeSheet.setValue(0, 2, "Page", GC.Spread.Sheets.SheetArea.colHeader);
43448
+ * activeSheet.setColumnWidth(0, 200);
43449
+ * activeSheet.setRowCount(13);
43450
+ * var commands = [
43451
+ * {name: 'Preface', chapter: '1', page: 1, indent: 0},
43452
+ * {name: 'Java SE5 and SE6', chapter: '1.1', page: 2, indent: 1},
43453
+ * {name: 'Java SE6', chapter: '1.1.1', page: 2, indent: 2},
43454
+ * {name: 'The 4th edition', chapter: '1.2', page: 2, indent: 1},
43455
+ * {name: 'Changes', chapter: '1.2.1', page: 3, indent: 2},
43456
+ * {name: 'Note on the cover design', chapter: '1.3', page: 4, indent: 1},
43457
+ * {name: 'Acknowledgements', chapter: '1.4', page: 4, indent: 1},
43458
+ * {name: 'Introduction', chapter: '2', page: 9, indent: 0},
43459
+ * {name: 'Prerequisites', chapter: '2.1', page: 9, indent: 1},
43460
+ * {name: 'Learning Java', chapter: '2.2', page: 10, indent: 1},
43461
+ * {name: 'Goals', chapter: '2.3', page: 10, indent: 1},
43462
+ * {name: 'Teaching from this book', chapter: '2.4', page: 11, indent: 1},
43463
+ * {name: 'JDK HTML documentation', chapter: '2.5', page: 11, indent: 1},
43464
+ * ];
43465
+ * for (var r = 0; r < commands.length; r++) {
43466
+ * activeSheet.setValue(r, 0, commands[r]['name']);
43467
+ * activeSheet.setValue(r, 1, commands[r]['chapter']);
43468
+ * activeSheet.setValue(r, 2, commands[r]['page']);
43469
+ * activeSheet.getRange(r, 0, 1, 1).textIndent(commands[r].indent);
43470
+ * }
43471
+ * activeSheet.outlineColumn.options({
43472
+ * columnIndex: 0,
43473
+ * showImage: true,
43474
+ * showCheckBox: true,
43475
+ * images: ['star2.png', 'box4.png', 'rating4.png'],
43476
+ * maxLevel: 2
43477
+ * });
43478
+ * activeSheet.showRowOutline(true);
43479
+ * spread.invalidateLayout();
43480
+ * spread.resumePaint();
43481
+ *
43482
+ * console.log(activeSheet.outlineColumn.getCheckStatus(1)); // false
43483
+ * activeSheet.outlineColumn.setCheckStatus(1, true);
43484
+ * console.log(activeSheet.outlineColumn.getCheckStatus(1)); // true
43485
+ * console.log(activeSheet.outlineColumn.getCheckStatus(2)); // true -> sub node of row 1
43486
+ * console.log(activeSheet.outlineColumn.getCheckStatus()); // [false, true, true, false, false, false, false, false, false, false, false, false, false]
43487
+ * ```
41399
43488
  */
41400
43489
  getCheckStatus(row?: number): any;
41401
43490
  /**
41402
43491
  * Gets the collapsed setting of the row or all rows.
41403
43492
  * @param {number} [row] The index of the collapsed row.
41404
43493
  * @returns {boolean|boolean[]} If row is undefined, returns all row's collapsed status; otherwise, returns the collapsed setting of the row.
43494
+ * @example
43495
+ * ```
43496
+ * spread.suspendPaint();
43497
+ * activeSheet.setValue(0, 0, "Name", GC.Spread.Sheets.SheetArea.colHeader);
43498
+ * activeSheet.setValue(0, 1, "Chapter", GC.Spread.Sheets.SheetArea.colHeader);
43499
+ * activeSheet.setValue(0, 2, "Page", GC.Spread.Sheets.SheetArea.colHeader);
43500
+ * activeSheet.setColumnWidth(0, 200);
43501
+ * activeSheet.setRowCount(13);
43502
+ * var commands = [
43503
+ * {name: 'Preface', chapter: '1', page: 1, indent: 0},
43504
+ * {name: 'Java SE5 and SE6', chapter: '1.1', page: 2, indent: 1},
43505
+ * {name: 'Java SE6', chapter: '1.1.1', page: 2, indent: 2},
43506
+ * {name: 'The 4th edition', chapter: '1.2', page: 2, indent: 1},
43507
+ * {name: 'Changes', chapter: '1.2.1', page: 3, indent: 2},
43508
+ * {name: 'Note on the cover design', chapter: '1.3', page: 4, indent: 1},
43509
+ * {name: 'Acknowledgements', chapter: '1.4', page: 4, indent: 1},
43510
+ * {name: 'Introduction', chapter: '2', page: 9, indent: 0},
43511
+ * {name: 'Prerequisites', chapter: '2.1', page: 9, indent: 1},
43512
+ * {name: 'Learning Java', chapter: '2.2', page: 10, indent: 1},
43513
+ * {name: 'Goals', chapter: '2.3', page: 10, indent: 1},
43514
+ * {name: 'Teaching from this book', chapter: '2.4', page: 11, indent: 1},
43515
+ * {name: 'JDK HTML documentation', chapter: '2.5', page: 11, indent: 1},
43516
+ * ];
43517
+ * for (var r = 0; r < commands.length; r++) {
43518
+ * activeSheet.setValue(r, 0, commands[r]['name']);
43519
+ * activeSheet.setValue(r, 1, commands[r]['chapter']);
43520
+ * activeSheet.setValue(r, 2, commands[r]['page']);
43521
+ * activeSheet.getRange(r, 0, 1, 1).textIndent(commands[r].indent);
43522
+ * }
43523
+ * activeSheet.outlineColumn.options({
43524
+ * columnIndex: 0,
43525
+ * showImage: true,
43526
+ * showCheckBox: true,
43527
+ * images: ['star2.png', 'box4.png', 'rating4.png'],
43528
+ * maxLevel: 2
43529
+ * });
43530
+ * activeSheet.showRowOutline(true);
43531
+ * spread.invalidateLayout();
43532
+ * spread.resumePaint();
43533
+ *
43534
+ * console.log(activeSheet.outlineColumn.getCollapsed(1)); // false
43535
+ * activeSheet.outlineColumn.setCollapsed(1, true);
43536
+ * console.log(activeSheet.outlineColumn.getCollapsed(1)); // true
43537
+ * console.log(activeSheet.outlineColumn.getCollapsed(2)); // false -> sub node of row 1
43538
+ * console.log(activeSheet.outlineColumn.getCollapsed()); // [false, true, false, false, false, false, false, false, false, false, false, false, false]
43539
+ * ```
41405
43540
  */
41406
43541
  getCollapsed(row?: number): any;
41407
43542
  /**
41408
43543
  * Gets or sets the outlineColumn options.
41409
- * @param {Object} outlineColumnOptions The outlineColumn options.
41410
- * @param {number} outlineColumnOptions.columnIndex - The index of the indented column.
41411
- * @param {boolean} [outlineColumnOptions.showImage] - Whether to display images.
41412
- * @param {string[]} [outlineColumnOptions.images] - The images by level (url or base64Image).
41413
- * @param {boolean} [outlineColumnOptions.showCheckBox] - Whether to display a check box.
41414
- * @param {boolean} [outlineColumnOptions.showIndicator] - Whether to display the indicator.
41415
- * @param {string} [outlineColumnOptions.expandIndicator] - The expand indicator (url or base64Image).
41416
- * @param {string} [outlineColumnOptions.collapseIndicator] - The collapse indicator (url or base64Image).
41417
- * @param {number} [outlineColumnOptions.maxLevel] - When the current row level is greater than maxLevel, the IncreaseCellIndent action does not take effect.
41418
- * @returns {Object | GC.Spread.Sheets.OutlineColumn.OutlineColumn} outlineColumnOptions|outlineColumn
43544
+ * @param {GC.Spread.Sheets.OutlineColumn.IOutlineColumnOptions} outlineColumnOptions The outlineColumn options.
43545
+ * @returns {GC.Spread.Sheets.OutlineColumn.IOutlineColumnOptions | GC.Spread.Sheets.OutlineColumn.OutlineColumn} outlineColumnOptions|outlineColumn
41419
43546
  * If no outlineColumnOptions item is set, returns outlineColumnOptions; otherwise, returns the outlineColumn instance.
41420
43547
  * @example
41421
43548
  * ```
@@ -41497,12 +43624,102 @@ declare module GC{
41497
43624
  * Sets the check status of the row.
41498
43625
  * @param {number} row The index of the row.
41499
43626
  * @param {boolean} checkStatus The check status of the row.
43627
+ * @example
43628
+ * ```
43629
+ * spread.suspendPaint();
43630
+ * activeSheet.setValue(0, 0, "Name", GC.Spread.Sheets.SheetArea.colHeader);
43631
+ * activeSheet.setValue(0, 1, "Chapter", GC.Spread.Sheets.SheetArea.colHeader);
43632
+ * activeSheet.setValue(0, 2, "Page", GC.Spread.Sheets.SheetArea.colHeader);
43633
+ * activeSheet.setColumnWidth(0, 200);
43634
+ * activeSheet.setRowCount(13);
43635
+ * var commands = [
43636
+ * {name: 'Preface', chapter: '1', page: 1, indent: 0},
43637
+ * {name: 'Java SE5 and SE6', chapter: '1.1', page: 2, indent: 1},
43638
+ * {name: 'Java SE6', chapter: '1.1.1', page: 2, indent: 2},
43639
+ * {name: 'The 4th edition', chapter: '1.2', page: 2, indent: 1},
43640
+ * {name: 'Changes', chapter: '1.2.1', page: 3, indent: 2},
43641
+ * {name: 'Note on the cover design', chapter: '1.3', page: 4, indent: 1},
43642
+ * {name: 'Acknowledgements', chapter: '1.4', page: 4, indent: 1},
43643
+ * {name: 'Introduction', chapter: '2', page: 9, indent: 0},
43644
+ * {name: 'Prerequisites', chapter: '2.1', page: 9, indent: 1},
43645
+ * {name: 'Learning Java', chapter: '2.2', page: 10, indent: 1},
43646
+ * {name: 'Goals', chapter: '2.3', page: 10, indent: 1},
43647
+ * {name: 'Teaching from this book', chapter: '2.4', page: 11, indent: 1},
43648
+ * {name: 'JDK HTML documentation', chapter: '2.5', page: 11, indent: 1},
43649
+ * ];
43650
+ * for (var r = 0; r < commands.length; r++) {
43651
+ * activeSheet.setValue(r, 0, commands[r]['name']);
43652
+ * activeSheet.setValue(r, 1, commands[r]['chapter']);
43653
+ * activeSheet.setValue(r, 2, commands[r]['page']);
43654
+ * activeSheet.getRange(r, 0, 1, 1).textIndent(commands[r].indent);
43655
+ * }
43656
+ * activeSheet.outlineColumn.options({
43657
+ * columnIndex: 0,
43658
+ * showImage: true,
43659
+ * showCheckBox: true,
43660
+ * images: ['star2.png', 'box4.png', 'rating4.png'],
43661
+ * maxLevel: 2
43662
+ * });
43663
+ * activeSheet.showRowOutline(true);
43664
+ * spread.invalidateLayout();
43665
+ * spread.resumePaint();
43666
+ *
43667
+ * console.log(activeSheet.outlineColumn.getCheckStatus(1)); // false
43668
+ * activeSheet.outlineColumn.setCheckStatus(1, true);
43669
+ * console.log(activeSheet.outlineColumn.getCheckStatus(1)); // true
43670
+ * console.log(activeSheet.outlineColumn.getCheckStatus(2)); // true -> sub node of row 1
43671
+ * ```
41500
43672
  */
41501
43673
  setCheckStatus(row: number, checkStatus: boolean): void;
41502
43674
  /**
41503
43675
  * Sets whether the row is collapsed.
41504
43676
  * @param {number} row The index of the row.
41505
43677
  * @param {boolean} collapsed The collapsed setting for the row.
43678
+ * @example
43679
+ * ```
43680
+ * spread.suspendPaint();
43681
+ * activeSheet.setValue(0, 0, "Name", GC.Spread.Sheets.SheetArea.colHeader);
43682
+ * activeSheet.setValue(0, 1, "Chapter", GC.Spread.Sheets.SheetArea.colHeader);
43683
+ * activeSheet.setValue(0, 2, "Page", GC.Spread.Sheets.SheetArea.colHeader);
43684
+ * activeSheet.setColumnWidth(0, 200);
43685
+ * activeSheet.setRowCount(13);
43686
+ * var commands = [
43687
+ * {name: 'Preface', chapter: '1', page: 1, indent: 0},
43688
+ * {name: 'Java SE5 and SE6', chapter: '1.1', page: 2, indent: 1},
43689
+ * {name: 'Java SE6', chapter: '1.1.1', page: 2, indent: 2},
43690
+ * {name: 'The 4th edition', chapter: '1.2', page: 2, indent: 1},
43691
+ * {name: 'Changes', chapter: '1.2.1', page: 3, indent: 2},
43692
+ * {name: 'Note on the cover design', chapter: '1.3', page: 4, indent: 1},
43693
+ * {name: 'Acknowledgements', chapter: '1.4', page: 4, indent: 1},
43694
+ * {name: 'Introduction', chapter: '2', page: 9, indent: 0},
43695
+ * {name: 'Prerequisites', chapter: '2.1', page: 9, indent: 1},
43696
+ * {name: 'Learning Java', chapter: '2.2', page: 10, indent: 1},
43697
+ * {name: 'Goals', chapter: '2.3', page: 10, indent: 1},
43698
+ * {name: 'Teaching from this book', chapter: '2.4', page: 11, indent: 1},
43699
+ * {name: 'JDK HTML documentation', chapter: '2.5', page: 11, indent: 1},
43700
+ * ];
43701
+ * for (var r = 0; r < commands.length; r++) {
43702
+ * activeSheet.setValue(r, 0, commands[r]['name']);
43703
+ * activeSheet.setValue(r, 1, commands[r]['chapter']);
43704
+ * activeSheet.setValue(r, 2, commands[r]['page']);
43705
+ * activeSheet.getRange(r, 0, 1, 1).textIndent(commands[r].indent);
43706
+ * }
43707
+ * activeSheet.outlineColumn.options({
43708
+ * columnIndex: 0,
43709
+ * showImage: true,
43710
+ * showCheckBox: true,
43711
+ * images: ['star2.png', 'box4.png', 'rating4.png'],
43712
+ * maxLevel: 2
43713
+ * });
43714
+ * activeSheet.showRowOutline(true);
43715
+ * spread.invalidateLayout();
43716
+ * spread.resumePaint();
43717
+ *
43718
+ * console.log(activeSheet.outlineColumn.getCollapsed(1)); // false
43719
+ * activeSheet.outlineColumn.setCollapsed(1, true);
43720
+ * console.log(activeSheet.outlineColumn.getCollapsed(1)); // true
43721
+ * console.log(activeSheet.outlineColumn.getCollapsed(2)); // false -> sub node of row 1
43722
+ * ```
41506
43723
  */
41507
43724
  setCollapsed(row: number, collapsed: boolean): void;
41508
43725
  }
@@ -41597,6 +43814,15 @@ declare module GC{
41597
43814
  * Expands or collapses the specified outline (range group) of rows or columns.
41598
43815
  * @param {GC.Spread.Sheets.Outlines.OutlineInfo} groupInfo The group information of the range group.
41599
43816
  * @param {boolean} expand Whether to expand the groups.
43817
+ * @example
43818
+ * ```
43819
+ * activeSheet.suspendPaint();
43820
+ * activeSheet.rowOutlines.group(2, 5);
43821
+ * var groupInfo = activeSheet.rowOutlines.find(2, 0);
43822
+ * activeSheet.rowOutlines.expandGroup(groupInfo, false);
43823
+ * activeSheet.resumePaint(); // the group is created and collapsed now.
43824
+ * activeSheet.rowOutlines.expandGroup(groupInfo, true); // the group and expand now.
43825
+ * ```
41600
43826
  */
41601
43827
  expandGroup(groupInfo: GC.Spread.Sheets.Outlines.OutlineInfo, expand: boolean): void;
41602
43828
  /**
@@ -41673,7 +43899,7 @@ declare module GC{
41673
43899
  * activeSheet.suspendPaint();
41674
43900
  * activeSheet.rowOutlines.group(0,5);
41675
43901
  * var rgi = activeSheet.rowOutlines.find(1, 0);
41676
- * rgi.state(GC.Spread.Sheets.Outlines.OutlineInfo.collapsed);
43902
+ * rgi.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
41677
43903
  * alert(activeSheet.rowOutlines.getState(rgi));
41678
43904
  * activeSheet.resumePaint();
41679
43905
  * ```
@@ -41712,7 +43938,19 @@ declare module GC{
41712
43938
  * Determines whether the specified index is the end of the group.
41713
43939
  * @param {number} index The index.
41714
43940
  * @param {number} processLevel The process level.
41715
- * @returns {boolean} `true` if the specfied index is the end of the group; otherwise, `false`.
43941
+ * @returns {boolean} `true` if the specified index is the end of the group; otherwise, `false`.
43942
+ * @example
43943
+ * ```
43944
+ * activeSheet.suspendPaint();
43945
+ * activeSheet.rowOutlines.group(2, 5);
43946
+ * activeSheet.rowOutlines.group(3, 2);
43947
+ * activeSheet.resumePaint();
43948
+ *
43949
+ * console.log(activeSheet.rowOutlines.isGroupEnd(2, 0)); // false
43950
+ * console.log(activeSheet.rowOutlines.isGroupEnd(4, 0)); // false
43951
+ * console.log(activeSheet.rowOutlines.isGroupEnd(4, 1)); // true
43952
+ * console.log(activeSheet.rowOutlines.isGroupEnd(6, 0)); // true
43953
+ * ```
41716
43954
  */
41717
43955
  isGroupEnd(index: number, processLevel: number): boolean;
41718
43956
  /**
@@ -41720,7 +43958,25 @@ declare module GC{
41720
43958
  */
41721
43959
  refresh(): void;
41722
43960
  /**
41723
- * Resumes the adding.
43961
+ * Resumes the adding group when the row/column is inserting the group range.
43962
+ * @example
43963
+ * ```
43964
+ * activeSheet.suspendPaint();
43965
+ * activeSheet.rowOutlines.group(2, 5);
43966
+ * activeSheet.resumePaint();
43967
+ *
43968
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 6
43969
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 6
43970
+ * activeSheet.addRows(4, 1);
43971
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 7
43972
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 7
43973
+ *
43974
+ * activeSheet.rowOutlines.suspendAdding();
43975
+ * activeSheet.addRows(4, 1);
43976
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 3 // cause adding suspended, the group spilt into two parts.
43977
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 8
43978
+ * activeSheet.rowOutlines.resumeAdding();
43979
+ * ```
41724
43980
  */
41725
43981
  resumeAdding(): void;
41726
43982
  /**
@@ -41738,7 +43994,25 @@ declare module GC{
41738
43994
  */
41739
43995
  setCollapsed(index: number, collapsed: boolean): void;
41740
43996
  /**
41741
- * Suspends the adding.
43997
+ * Suspends the adding group when the row/column is inserting the group range.
43998
+ * @example
43999
+ * ```
44000
+ * activeSheet.suspendPaint();
44001
+ * activeSheet.rowOutlines.group(2, 5);
44002
+ * activeSheet.resumePaint();
44003
+ *
44004
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 6
44005
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 6
44006
+ * activeSheet.addRows(4, 1);
44007
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 7
44008
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 7
44009
+ *
44010
+ * activeSheet.rowOutlines.suspendAdding();
44011
+ * activeSheet.addRows(4, 1);
44012
+ * console.log(activeSheet.rowOutlines.find(3, 0).end); // 3 // cause adding suspended, the group spilt into two parts.
44013
+ * console.log(activeSheet.rowOutlines.find(5, 0).end); // 8
44014
+ * activeSheet.rowOutlines.resumeAdding();
44015
+ * ```
41742
44016
  */
41743
44017
  suspendAdding(): void;
41744
44018
  /**
@@ -43319,7 +45593,12 @@ declare module GC{
43319
45593
  * Indicates that the string is found in the cell formula.
43320
45594
  * @type {number}
43321
45595
  */
43322
- cellFormula= 8
45596
+ cellFormula= 8,
45597
+ /**
45598
+ * Indicates that the string is found in the cell comment.
45599
+ * @type {number}
45600
+ */
45601
+ cellComment= 16
43323
45602
  }
43324
45603
 
43325
45604
  /**
@@ -46445,6 +48724,15 @@ declare module GC{
46445
48724
  * ```
46446
48725
  */
46447
48726
  toImageSrc(): string;
48727
+ /**
48728
+ * Get the shape Image src of type Base64 string.
48729
+ * @returns {Promise<string>} return the shape Image Base64 src string.
48730
+ * @example
48731
+ * ```
48732
+ * let shapeImageSrc = await sheet.shapes.all()[0].toImageSrcAsync();
48733
+ * ```
48734
+ */
48735
+ toImageSrcAsync(): Promise<string>;
46448
48736
  /**
46449
48737
  * Gets or sets the width of the shape.
46450
48738
  * @param {number | string} value The width of the shape specified by a number or formula (starts with =) can get a number value.
@@ -46890,6 +49178,7 @@ declare module GC{
46890
49178
  allowResize: (value?: boolean, shouldCallback?: boolean) => boolean | ISlicer;
46891
49179
  allowMove: (value?: boolean, shouldCallback?: boolean) => boolean | ISlicer;
46892
49180
  toImageSrc: () => string | ISlicer;
49181
+ toImageSrcAsync: () => Promise<string> | ISlicer;
46893
49182
  }
46894
49183
 
46895
49184
 
@@ -47397,6 +49686,15 @@ declare module GC{
47397
49686
  * ```
47398
49687
  */
47399
49688
  toImageSrc(): string;
49689
+ /**
49690
+ * Get the slicer Image src of type Base64 string.
49691
+ * @returns {Promise<string>} return the slicer Image Base64 src string.
49692
+ * @example
49693
+ * ```
49694
+ * let slicerImageSrc = await sheet.slicers.all()[0].toImageSrcAsync();
49695
+ * ```
49696
+ */
49697
+ toImageSrcAsync(): Promise<string>;
47400
49698
  /**
47401
49699
  * Gets or sets whether to visually distinguish the items with no data.
47402
49700
  * @param {boolean} [value] The setting for items with no data. The visuallyNoDataItems property of a slicer specifies the visual representation or handling of items with no associated data within the slicer.
@@ -48560,6 +50858,15 @@ declare module GC{
48560
50858
  * ```
48561
50859
  */
48562
50860
  toImageSrc(): string;
50861
+ /**
50862
+ * Get the slicer Image src of type Base64 string.
50863
+ * @returns {Promise<string>} return the slicer Image Base64 src string.
50864
+ * @example
50865
+ * ```
50866
+ * let slicerImageSrc = await sheet.slicers.all()[0].toImageSrcAsync();
50867
+ * ```
50868
+ */
50869
+ toImageSrcAsync(): Promise<string>;
48563
50870
  /**
48564
50871
  * Gets or sets the visuallyNoDataItems of the slicer.
48565
50872
  * @param {boolean} [value] The visuallyNoDataItems of the slicer. The visuallyNoDataItems property of a slicer specifies the visual representation or handling of items with no associated data within the slicer control.
@@ -49949,12 +52256,12 @@ declare module GC{
49949
52256
  */
49950
52257
  font(value?: string): any;
49951
52258
  /**
49952
- * Gets or sets the font size.
49953
- * @param {string} [value] The font size of the style information.
49954
- * @returns {string | GC.Spread.Sheets.Slicers.SlicerStyleInfo} If no value is set, returns the font size of the style information; otherwise, returns the slicer style information.
52259
+ * Gets or sets the font family.
52260
+ * @param {string} [value] The font family of the style information.
52261
+ * @returns {string | GC.Spread.Sheets.Slicers.SlicerStyleInfo} If no value is set, returns the font family of the style information; otherwise, returns the slicer style information.
49955
52262
  * @example
49956
52263
  * ```
49957
- * //This example sets a font size.
52264
+ * //This example sets a font family.
49958
52265
  * //create a table
49959
52266
  * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 2 });
49960
52267
  * var activeSheet = spread.getActiveSheet();
@@ -49974,23 +52281,24 @@ declare module GC{
49974
52281
  * table.setColumnName(4, dataColumns[4]);
49975
52282
  * //style
49976
52283
  * var hstyle = new GC.Spread.Sheets.Slicers.SlicerStyleInfo();
49977
- * hstyle.fontSize("18pt");
52284
+ * hstyle.fontFamily("Arial Black");
49978
52285
  * var style1 = new GC.Spread.Sheets.Slicers.SlicerStyle();
49979
52286
  * style1.hoveredSelectedItemWithDataStyle(hstyle);
49980
52287
  * //add a slicer to the sheet and return the slicer instance.
49981
52288
  * var slicer = activeSheet.slicers.add("slicer1",table.name(),"Name");
49982
- * //change the slicer properties.
52289
+ * //change the slicer properties.
49983
52290
  * slicer.position(new GC.Spread.Sheets.Point(100, 200));
49984
52291
  * slicer.style(style1);
49985
- */ ///* function fontFamily(value?: string): any
49986
- /**
49987
- * Gets or sets the font family.
49988
52292
  * ```
49989
- * @param {string} [value] The font family of the style information.
49990
- * @returns {string | GC.Spread.Sheets.Slicers.SlicerStyleInfo} If no value is set, returns the font family of the style information; otherwise, returns the slicer style information.
52293
+ */
52294
+ fontFamily(value?: string): any;
52295
+ /**
52296
+ * Gets or sets the font size.
52297
+ * @param {string} [value] The font size of the style information.
52298
+ * @returns {string | GC.Spread.Sheets.Slicers.SlicerStyleInfo} If no value is set, returns the font size of the style information; otherwise, returns the slicer style information.
49991
52299
  * @example
49992
52300
  * ```
49993
- * //This example sets a font family.
52301
+ * //This example sets a font size.
49994
52302
  * //create a table
49995
52303
  * var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 2 });
49996
52304
  * var activeSheet = spread.getActiveSheet();
@@ -50010,12 +52318,12 @@ declare module GC{
50010
52318
  * table.setColumnName(4, dataColumns[4]);
50011
52319
  * //style
50012
52320
  * var hstyle = new GC.Spread.Sheets.Slicers.SlicerStyleInfo();
50013
- * hstyle.fontFamily("Arial Black");
52321
+ * hstyle.fontSize("18pt");
50014
52322
  * var style1 = new GC.Spread.Sheets.Slicers.SlicerStyle();
50015
52323
  * style1.hoveredSelectedItemWithDataStyle(hstyle);
50016
52324
  * //add a slicer to the sheet and return the slicer instance.
50017
52325
  * var slicer = activeSheet.slicers.add("slicer1",table.name(),"Name");
50018
- * //change the slicer properties.
52326
+ * //change the slicer properties.
50019
52327
  * slicer.position(new GC.Spread.Sheets.Point(100, 200));
50020
52328
  * slicer.style(style1);
50021
52329
  * ```
@@ -52987,7 +55295,7 @@ declare module GC{
52987
55295
  * Gets or sets the dataSource and binding columns and path for the table.
52988
55296
  * @param {GC.Spread.Sheets.Tables.TableColumn[]} columns The array of table column information with data fields and names. Each item is GC.Spread.Sheets.Tables.TableColumn.
52989
55297
  * @param {string} [path] The binding path for binding in the table.
52990
- * @param {object} [dataSource] The data source for the table.
55298
+ * @param {object | string | GC.Data.Table} [dataSource] The data source for the table.
52991
55299
  * @returns {GC.Spread.Sheets.Tables.Table} returns the table.
52992
55300
  * @example
52993
55301
  * ```
@@ -53013,7 +55321,7 @@ declare module GC{
53013
55321
  * table.bind([tableColumn1, tableColumn2, tableColumn3, tableColumn4, tableColumn5], 'sales', data);
53014
55322
  * ```
53015
55323
  */
53016
- bind(columns: TableColumn[], path?: string, dataSource?: object): GC.Spread.Sheets.Tables.Table;
55324
+ bind(columns: TableColumn[], path?: string, dataSource?: object | string | GC.Data.Table): GC.Spread.Sheets.Tables.Table;
53017
55325
  /**
53018
55326
  * Binds the columns using the specified data fields.
53019
55327
  * @param {GC.Spread.Sheets.Tables.TableColumn[]} columns The array of table column information with data fields and names. Each item is GC.Spread.Sheets.Tables.TableColumn.
@@ -53724,7 +56032,7 @@ declare module GC{
53724
56032
  * @param {string} name The table name.
53725
56033
  * @param {number} row The row index.
53726
56034
  * @param {number} column The column index.
53727
- * @param {object} dataSource The data source for the table.
56035
+ * @param {object | string | GC.Data.Table} dataSource The data source for the table.
53728
56036
  * @param {GC.Spread.Sheets.Tables.TableTheme} style The style of the table.
53729
56037
  * @param {GC.Spread.Sheets.Tables.ITableOptions} [options] The initialization options of the table.
53730
56038
  * @returns {GC.Spread.Sheets.Tables.Table} The new table instance.
@@ -53739,7 +56047,7 @@ declare module GC{
53739
56047
  * activeSheet.tables.addFromDataSource("Table1", 5, 2, source, GC.Spread.Sheets.Tables.TableThemes.dark1);
53740
56048
  * ```
53741
56049
  */
53742
- addFromDataSource(name: string, row: number, column: number, dataSource: Object, style: GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions): GC.Spread.Sheets.Tables.Table;
56050
+ addFromDataSource(name: string, row: number, column: number, dataSource: Object | string | GC.Data.Table, style: GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions): GC.Spread.Sheets.Tables.Table;
53743
56051
  /**
53744
56052
  * Gets all tables of the sheet.
53745
56053
  * @returns {GC.Spread.Sheets.Tables.Table[]} The GC.Spread.Sheets.Tables.Table array of table instances. The array is never null.