@mescius/spread-sheets 19.0.5 → 19.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/gc.spread.sheets.all.min.js +2 -2
- package/dist/gc.spread.sheets.d.ts +1668 -246
- package/package.json +1 -1
- package/styles/gc.spread.sheets.css +294 -55
- package/styles/gc.spread.sheets.excel2013darkGray.css +294 -55
- package/styles/gc.spread.sheets.excel2013lightGray.css +294 -55
- package/styles/gc.spread.sheets.excel2013white.css +294 -55
- package/styles/gc.spread.sheets.excel2016black.css +294 -55
- package/styles/gc.spread.sheets.excel2016colorful.css +294 -55
- package/styles/gc.spread.sheets.excel2016darkGray.css +294 -55
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
declare
|
|
2
|
-
|
|
1
|
+
declare namespace GC{
|
|
2
|
+
namespace Data{
|
|
3
3
|
|
|
4
4
|
export interface IRelationship{
|
|
5
5
|
sourceTable: GC.Data.Table;
|
|
@@ -1413,7 +1413,7 @@ declare module GC{
|
|
|
1413
1413
|
* @property {string | string[]} caption - The caption of the column.
|
|
1414
1414
|
* @property {number | string} width - The width of the column, support number in pixel, or star size.
|
|
1415
1415
|
* @property {GC.Data.StyleOptions} style - The style of the column.
|
|
1416
|
-
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} conditionalFormats - The conditional formats array of the column.
|
|
1416
|
+
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions | GC.Data.SparklineRuleOptions)[]} conditionalFormats - The conditional formats array of the column.
|
|
1417
1417
|
* @property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} validator - The data validator of the column.
|
|
1418
1418
|
* @property {boolean} isPrimaryKey - Mark the column as primary key column.
|
|
1419
1419
|
* @property {boolean} readonly - Mark the column is readonly.
|
|
@@ -1435,6 +1435,8 @@ declare module GC{
|
|
|
1435
1435
|
* @property {string | (string | number | boolean | Date)[] | GC.Data.ILookupOptions} lookup - Define the lookup for the column, only be used in the columns of the schema of the data source.
|
|
1436
1436
|
* @property {boolean | GC.Data.IOutlineColumnOptions} outlineColumn - Define the outline column only when the data be the hierarchy data.
|
|
1437
1437
|
* @property {GC.Data.ITriggerFormulaOption} trigger - The trigger formula of the column.
|
|
1438
|
+
* @property {string} showNullAs - The display text for null or undefined values.
|
|
1439
|
+
* @property {string} showEmptyAs - The display text for empty string values.
|
|
1438
1440
|
*/
|
|
1439
1441
|
export type IColumn =
|
|
1440
1442
|
{
|
|
@@ -1465,7 +1467,7 @@ declare module GC{
|
|
|
1465
1467
|
/**
|
|
1466
1468
|
* The conditional formats array of the column.
|
|
1467
1469
|
*/
|
|
1468
|
-
conditionalFormats?: Array<GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions>;
|
|
1470
|
+
conditionalFormats?: Array<GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions | GC.Data.SparklineRuleOptions>;
|
|
1469
1471
|
/**
|
|
1470
1472
|
* The data validator of the column.
|
|
1471
1473
|
*/
|
|
@@ -1550,6 +1552,14 @@ declare module GC{
|
|
|
1550
1552
|
* The trigger formula of the column.
|
|
1551
1553
|
*/
|
|
1552
1554
|
trigger?: GC.Data.ITriggerFormulaOption;
|
|
1555
|
+
/**
|
|
1556
|
+
* The display text for null or undefined values.
|
|
1557
|
+
*/
|
|
1558
|
+
showNullAs?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* The display text for empty string values.
|
|
1561
|
+
*/
|
|
1562
|
+
showEmptyAs?: string;
|
|
1553
1563
|
}
|
|
1554
1564
|
|
|
1555
1565
|
|
|
@@ -2713,6 +2723,44 @@ declare module GC{
|
|
|
2713
2723
|
}
|
|
2714
2724
|
|
|
2715
2725
|
|
|
2726
|
+
/**
|
|
2727
|
+
* @typedef GC.Data.SparklineRuleOptions - The options of sparkline rule.
|
|
2728
|
+
* @property {"sparklineRule"} ruleType - The rule type if you want to use sparkline rule.
|
|
2729
|
+
* @property {string} sparklineType - The sparkline type.
|
|
2730
|
+
* @property {any} sparklineOptions - The sparkline options.
|
|
2731
|
+
* @property {boolean} showSparklineOnly - Whether to display the sparkline only.
|
|
2732
|
+
* @property {number} priority - The priority of the rule.
|
|
2733
|
+
* @property {boolean} stopIfTrue - Whether rules with lower priority are applied before this rule.
|
|
2734
|
+
*/
|
|
2735
|
+
export type SparklineRuleOptions =
|
|
2736
|
+
{
|
|
2737
|
+
/**
|
|
2738
|
+
* The rule type if you want to use sparkline rule.
|
|
2739
|
+
*/
|
|
2740
|
+
ruleType: "sparklineRule";
|
|
2741
|
+
/**
|
|
2742
|
+
* The sparkline type.
|
|
2743
|
+
*/
|
|
2744
|
+
sparklineType: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* The sparkline options.
|
|
2747
|
+
*/
|
|
2748
|
+
sparklineOptions: any;
|
|
2749
|
+
/**
|
|
2750
|
+
* Whether to display the sparkline only.
|
|
2751
|
+
*/
|
|
2752
|
+
showSparklineOnly: boolean;
|
|
2753
|
+
/**
|
|
2754
|
+
* The priority of the rule.
|
|
2755
|
+
*/
|
|
2756
|
+
priority: number;
|
|
2757
|
+
/**
|
|
2758
|
+
* Whether rules with lower priority are applied before this rule.
|
|
2759
|
+
*/
|
|
2760
|
+
stopIfTrue: boolean;
|
|
2761
|
+
}
|
|
2762
|
+
|
|
2763
|
+
|
|
2716
2764
|
/**
|
|
2717
2765
|
* @typedef GC.Data.SpecificTextComparisonOperator
|
|
2718
2766
|
* @type {"contains"|"doesNotContain"|"beginsWith"|"endsWith"}
|
|
@@ -3002,11 +3050,11 @@ declare module GC{
|
|
|
3002
3050
|
|
|
3003
3051
|
/**
|
|
3004
3052
|
* @typedef GC.Data.TextDecoration
|
|
3005
|
-
* @type {"underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline"}
|
|
3053
|
+
* @type {"underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline" | "accountingUnderline" | "doubleAccountingUnderline" | "lineThroughAccountingUnderline" | "lineThroughDoubleAccountingUnderline"}
|
|
3006
3054
|
* @description The text decoration.
|
|
3007
3055
|
*/
|
|
3008
3056
|
export type TextDecoration =
|
|
3009
|
-
"underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline"
|
|
3057
|
+
"underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline" | "accountingUnderline" | "doubleAccountingUnderline" | "lineThroughAccountingUnderline" | "lineThroughDoubleAccountingUnderline"
|
|
3010
3058
|
|
|
3011
3059
|
|
|
3012
3060
|
/**
|
|
@@ -3709,7 +3757,7 @@ declare module GC{
|
|
|
3709
3757
|
* @property {string | string[]} [caption] - The caption of the column.
|
|
3710
3758
|
* @property {number | string} [width] - The width of the column, support number in pixel, or star size.
|
|
3711
3759
|
* @property {GC.Data.StyleOptions} [style] - The column style options.
|
|
3712
|
-
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} [conditionalFormats] - The conditional rules array.
|
|
3760
|
+
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions | GC.Data.SparklineRuleOptions)[]} [conditionalFormats] - The conditional rules array.
|
|
3713
3761
|
* @property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} [validators] - The default data validator.
|
|
3714
3762
|
* @property {boolean} [isPrimaryKey] - Mark the column as primary key column.
|
|
3715
3763
|
* @property {boolean} [readonly] - Mark the column is readonly.
|
|
@@ -3888,7 +3936,7 @@ declare module GC{
|
|
|
3888
3936
|
* @property {string | string[]} [caption] - The caption of the column.
|
|
3889
3937
|
* @property {number | string} [width] - The width of the column, support number in pixel, or star size.
|
|
3890
3938
|
* @property {GC.Data.StyleOptions} [style] - The column style options.
|
|
3891
|
-
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} [conditionalFormats] - The conditional rules array.
|
|
3939
|
+
* @property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions | GC.Data.SparklineRuleOptions)[]} [conditionalFormats] - The conditional rules array.
|
|
3892
3940
|
* @property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} [validators] - The default data validator.
|
|
3893
3941
|
* @property {boolean} [isPrimaryKey] - Mark the column as primary key column.
|
|
3894
3942
|
* @property {boolean} [readonly] - Mark the column is readonly.
|
|
@@ -4053,7 +4101,7 @@ declare module GC{
|
|
|
4053
4101
|
}
|
|
4054
4102
|
}
|
|
4055
4103
|
|
|
4056
|
-
|
|
4104
|
+
namespace Pivot{
|
|
4057
4105
|
|
|
4058
4106
|
export interface ICustomSortCallBack{
|
|
4059
4107
|
(fieldItemNameArray: any[], sortInfo: GC.Pivot.IPivotCustomSortInfo) : any[];
|
|
@@ -4780,8 +4828,8 @@ declare module GC{
|
|
|
4780
4828
|
|
|
4781
4829
|
}
|
|
4782
4830
|
|
|
4783
|
-
|
|
4784
|
-
|
|
4831
|
+
namespace Spread{
|
|
4832
|
+
namespace CalcEngine{
|
|
4785
4833
|
/**
|
|
4786
4834
|
* Gets or Sets the Excel Compatible Mode for CalcEngine. Default value is FALSE.
|
|
4787
4835
|
* When ExcelCompatibleCalcMode disabled, SpreadJS will auto convert text to number for calculation.
|
|
@@ -4929,7 +4977,7 @@ declare module GC{
|
|
|
4929
4977
|
*/
|
|
4930
4978
|
type: GC.Spread.CalcEngine.ExpressionType;
|
|
4931
4979
|
}
|
|
4932
|
-
|
|
4980
|
+
namespace Functions{
|
|
4933
4981
|
/**
|
|
4934
4982
|
* Defines a global custom function, which can be used in formulas.
|
|
4935
4983
|
* The global custom function can be called from any spreadsheet.
|
|
@@ -5297,10 +5345,17 @@ declare module GC{
|
|
|
5297
5345
|
* ```
|
|
5298
5346
|
*/
|
|
5299
5347
|
isVolatile(): boolean;
|
|
5348
|
+
/**
|
|
5349
|
+
* Indicates whether this function can run in the Calc Worker.
|
|
5350
|
+
* If true, the function implementation will be serialized and
|
|
5351
|
+
* executed inside the Calc Worker.
|
|
5352
|
+
* @returns {boolean} `true` if the function supports running in the Calc Worker; otherwise, `false`.
|
|
5353
|
+
*/
|
|
5354
|
+
supportCalcWorker(): boolean;
|
|
5300
5355
|
}
|
|
5301
5356
|
}
|
|
5302
5357
|
|
|
5303
|
-
|
|
5358
|
+
namespace LanguagePackages{
|
|
5304
5359
|
/**
|
|
5305
5360
|
* Gets or Sets the language package for calc engine.
|
|
5306
5361
|
* @param {string} languageName the calc engine language name string;
|
|
@@ -5316,7 +5371,7 @@ declare module GC{
|
|
|
5316
5371
|
|
|
5317
5372
|
}
|
|
5318
5373
|
|
|
5319
|
-
|
|
5374
|
+
namespace Commands{
|
|
5320
5375
|
/**
|
|
5321
5376
|
* Represents the key code.
|
|
5322
5377
|
* @enum {number}
|
|
@@ -5561,7 +5616,7 @@ declare module GC{
|
|
|
5561
5616
|
}
|
|
5562
5617
|
}
|
|
5563
5618
|
|
|
5564
|
-
|
|
5619
|
+
namespace Common{
|
|
5565
5620
|
|
|
5566
5621
|
export interface ICurrentUserChangedEventArgs{
|
|
5567
5622
|
oldCurrentUser?: GC.Spread.Common.IUser;
|
|
@@ -6167,8 +6222,7 @@ declare module GC{
|
|
|
6167
6222
|
* @returns {void}
|
|
6168
6223
|
* @example
|
|
6169
6224
|
* ```javascript
|
|
6170
|
-
*
|
|
6171
|
-
* users.bind(GC.Spread.Common.Events.CurrentUserChanged, (event, args) => {
|
|
6225
|
+
* GC.Spread.Common.UserManager.bind(GC.Spread.Common.Events.CurrentUserChanged, (event, args) => {
|
|
6172
6226
|
* console.log(event);
|
|
6173
6227
|
* console.log(args.oldCurrentUser);
|
|
6174
6228
|
* console.log(args.newCurrentUser);
|
|
@@ -6214,7 +6268,7 @@ declare module GC{
|
|
|
6214
6268
|
}
|
|
6215
6269
|
}
|
|
6216
6270
|
|
|
6217
|
-
|
|
6271
|
+
namespace Formatter{
|
|
6218
6272
|
|
|
6219
6273
|
export class FormatterBase{
|
|
6220
6274
|
/**
|
|
@@ -6490,7 +6544,7 @@ declare module GC{
|
|
|
6490
6544
|
}
|
|
6491
6545
|
}
|
|
6492
6546
|
|
|
6493
|
-
|
|
6547
|
+
namespace Pivot{
|
|
6494
6548
|
|
|
6495
6549
|
export interface IPivotItemInfo{
|
|
6496
6550
|
fieldName: string;
|
|
@@ -7262,11 +7316,11 @@ declare module GC{
|
|
|
7262
7316
|
* @param {GC.Spread.Pivot.PivotTable} pivotTable Indicates the pivot table which is attached.
|
|
7263
7317
|
* @returns void
|
|
7264
7318
|
*/
|
|
7265
|
-
attach(pivotTable: GC.Spread.Pivot.PivotTable):
|
|
7319
|
+
attach(pivotTable: GC.Spread.Pivot.PivotTable): void;
|
|
7266
7320
|
/**
|
|
7267
7321
|
* @description destroy the PivotPanel.
|
|
7268
7322
|
*/
|
|
7269
|
-
destroy():
|
|
7323
|
+
destroy(): void;
|
|
7270
7324
|
/**
|
|
7271
7325
|
* @description detach the pivot table for pivot panel, stop the pivot panel control bound pivot table.
|
|
7272
7326
|
* @returns void
|
|
@@ -11406,7 +11460,7 @@ declare module GC{
|
|
|
11406
11460
|
*/
|
|
11407
11461
|
y(value?: number): any;
|
|
11408
11462
|
}
|
|
11409
|
-
|
|
11463
|
+
namespace PivotTable{
|
|
11410
11464
|
|
|
11411
11465
|
export class PivotTableViewManager{
|
|
11412
11466
|
/**
|
|
@@ -11487,7 +11541,7 @@ declare module GC{
|
|
|
11487
11541
|
|
|
11488
11542
|
}
|
|
11489
11543
|
|
|
11490
|
-
|
|
11544
|
+
namespace Report{
|
|
11491
11545
|
|
|
11492
11546
|
export interface IColumnLayoutSetting{
|
|
11493
11547
|
type: 'ColumnLayout';
|
|
@@ -12950,7 +13004,7 @@ declare module GC{
|
|
|
12950
13004
|
}
|
|
12951
13005
|
}
|
|
12952
13006
|
|
|
12953
|
-
|
|
13007
|
+
namespace Sheets{
|
|
12954
13008
|
/**
|
|
12955
13009
|
* Represents the license key for evaluation version and production version.
|
|
12956
13010
|
*/
|
|
@@ -13054,6 +13108,26 @@ declare module GC{
|
|
|
13054
13108
|
}
|
|
13055
13109
|
|
|
13056
13110
|
|
|
13111
|
+
export interface ICalculationProgressEventArgs{
|
|
13112
|
+
/**
|
|
13113
|
+
* The number of cells that are pending calculation.
|
|
13114
|
+
*/
|
|
13115
|
+
pendingCells?: number;
|
|
13116
|
+
/**
|
|
13117
|
+
* The total number of cells to be calculated.
|
|
13118
|
+
*/
|
|
13119
|
+
totalCells?: number;
|
|
13120
|
+
/**
|
|
13121
|
+
* The number of iteration calculations.
|
|
13122
|
+
*/
|
|
13123
|
+
iterate?: number;
|
|
13124
|
+
/**
|
|
13125
|
+
* The progress of data table calculation, range from 0 to 1.
|
|
13126
|
+
*/
|
|
13127
|
+
dataTableProgress?: number;
|
|
13128
|
+
}
|
|
13129
|
+
|
|
13130
|
+
|
|
13057
13131
|
export interface ICalendarDateRange{
|
|
13058
13132
|
start: Date;
|
|
13059
13133
|
end: Date;
|
|
@@ -13748,6 +13822,64 @@ declare module GC{
|
|
|
13748
13822
|
}
|
|
13749
13823
|
|
|
13750
13824
|
|
|
13825
|
+
export interface IImageRichData extends GC.Spread.Sheets.IRichData{
|
|
13826
|
+
/**
|
|
13827
|
+
* Discriminant tag identifying this as an image rich data object.
|
|
13828
|
+
*/
|
|
13829
|
+
richDataType: "Image";
|
|
13830
|
+
value: {
|
|
13831
|
+
/**
|
|
13832
|
+
* Required. The location of the image on the web or base64 string.
|
|
13833
|
+
*/
|
|
13834
|
+
src: string;
|
|
13835
|
+
/**
|
|
13836
|
+
* Optional. The base64 encoded image data.
|
|
13837
|
+
*/
|
|
13838
|
+
imageBase64Data?: string;
|
|
13839
|
+
/**
|
|
13840
|
+
* Optional. Alternative text that describes the image for accessibility.
|
|
13841
|
+
*/
|
|
13842
|
+
altText?: string;
|
|
13843
|
+
/**
|
|
13844
|
+
* Optional. Specification of how to size the image. 0 - keep the aspect ratio to fit the cell. 1 - make the image fit the entire cell. 2 - maintains original size even if it gets cropped. 3 - custom. The default value is 1.
|
|
13845
|
+
*/
|
|
13846
|
+
drawType?: number;
|
|
13847
|
+
/**
|
|
13848
|
+
* Optional. If drawType is 3 (custom), use this for the height.
|
|
13849
|
+
*/
|
|
13850
|
+
height?: number;
|
|
13851
|
+
/**
|
|
13852
|
+
* Optional. If drawType is 3 (custom), use this for the width.
|
|
13853
|
+
*/
|
|
13854
|
+
width?: number;
|
|
13855
|
+
/**
|
|
13856
|
+
* Optional. The x-axis coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context. The default value is 0.
|
|
13857
|
+
*/
|
|
13858
|
+
clipX?: number;
|
|
13859
|
+
/**
|
|
13860
|
+
* Optional. The y-axis coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context. The default value is 0.
|
|
13861
|
+
*/
|
|
13862
|
+
clipY?: number;
|
|
13863
|
+
/**
|
|
13864
|
+
* Optional. The height of the sub-rectangle of the source image to draw into the destination context. The default value is the height of the image.
|
|
13865
|
+
*/
|
|
13866
|
+
clipHeight?: number;
|
|
13867
|
+
/**
|
|
13868
|
+
* Optional. The width of the sub-rectangle of the source image to draw into the destination context. The default value is the width of the image.
|
|
13869
|
+
*/
|
|
13870
|
+
clipWidth?: number;
|
|
13871
|
+
/**
|
|
13872
|
+
* Optional. The vertical alignment of the image. 0 - top, 1 - center, 2 - bottom. The default value is 0 (top).
|
|
13873
|
+
*/
|
|
13874
|
+
vAlign?: number;
|
|
13875
|
+
/**
|
|
13876
|
+
* Optional. The horizontal alignment of the image. 0 - left, 1 - center, 2 - right. The default value is 0 (left).
|
|
13877
|
+
*/
|
|
13878
|
+
hAlign?: number;
|
|
13879
|
+
};
|
|
13880
|
+
}
|
|
13881
|
+
|
|
13882
|
+
|
|
13751
13883
|
export interface IImageSize{
|
|
13752
13884
|
/**
|
|
13753
13885
|
* Specific the image's width, default value is 16, unit is px.
|
|
@@ -14111,6 +14243,18 @@ declare module GC{
|
|
|
14111
14243
|
}
|
|
14112
14244
|
|
|
14113
14245
|
|
|
14246
|
+
export interface IRichData{
|
|
14247
|
+
/**
|
|
14248
|
+
* The type identifier for the rich data object.
|
|
14249
|
+
*/
|
|
14250
|
+
richDataType: string;
|
|
14251
|
+
/**
|
|
14252
|
+
* Rich data value, the structure of which depends on the richDataType.
|
|
14253
|
+
*/
|
|
14254
|
+
value: unknown;
|
|
14255
|
+
}
|
|
14256
|
+
|
|
14257
|
+
|
|
14114
14258
|
export interface IRowChangedEventArgs{
|
|
14115
14259
|
sheet: GC.Spread.Sheets.Worksheet;
|
|
14116
14260
|
sheetName: string;
|
|
@@ -14536,13 +14680,13 @@ declare module GC{
|
|
|
14536
14680
|
*/
|
|
14537
14681
|
showDragFillSmartTag?: boolean;
|
|
14538
14682
|
/**
|
|
14539
|
-
* Whether to display the horizontal scroll bar. The default value is true.
|
|
14683
|
+
* Whether to display the horizontal scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
14540
14684
|
*/
|
|
14541
|
-
showHorizontalScrollbar?: boolean;
|
|
14685
|
+
showHorizontalScrollbar?: boolean | "auto";
|
|
14542
14686
|
/**
|
|
14543
|
-
* Whether to display the vertical scroll bar. The default value is true.
|
|
14687
|
+
* Whether to display the vertical scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
14544
14688
|
*/
|
|
14545
|
-
showVerticalScrollbar?: boolean;
|
|
14689
|
+
showVerticalScrollbar?: boolean | "auto";
|
|
14546
14690
|
/**
|
|
14547
14691
|
* Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. The default value is true.
|
|
14548
14692
|
*/
|
|
@@ -14815,13 +14959,13 @@ declare module GC{
|
|
|
14815
14959
|
*/
|
|
14816
14960
|
showDragFillSmartTag: boolean;
|
|
14817
14961
|
/**
|
|
14818
|
-
* Whether to display the horizontal scroll bar. The default value is true.
|
|
14962
|
+
* Whether to display the horizontal scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
14819
14963
|
*/
|
|
14820
|
-
showHorizontalScrollbar: boolean;
|
|
14964
|
+
showHorizontalScrollbar: boolean | "auto";
|
|
14821
14965
|
/**
|
|
14822
|
-
* Whether to display the vertical scroll bar. The default value is true.
|
|
14966
|
+
* Whether to display the vertical scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
14823
14967
|
*/
|
|
14824
|
-
showVerticalScrollbar: boolean;
|
|
14968
|
+
showVerticalScrollbar: boolean | "auto";
|
|
14825
14969
|
/**
|
|
14826
14970
|
* Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. The default value is true.
|
|
14827
14971
|
*/
|
|
@@ -15204,11 +15348,11 @@ declare module GC{
|
|
|
15204
15348
|
|
|
15205
15349
|
/**
|
|
15206
15350
|
* @typedef GC.Spread.Sheets.ExcelFileType
|
|
15207
|
-
* @type {"XLSX" | "XLSM" | "XLTM"}
|
|
15351
|
+
* @type {"XLSX" | "XLSM" | "XLTM" | "XLTX"}
|
|
15208
15352
|
* @description Represents the fileType of Excel.
|
|
15209
15353
|
*/
|
|
15210
15354
|
export type ExcelFileType =
|
|
15211
|
-
"XLSX" | "XLSM" | "XLTM"
|
|
15355
|
+
"XLSX" | "XLSM" | "XLTM" | "XLTX"
|
|
15212
15356
|
|
|
15213
15357
|
|
|
15214
15358
|
/**
|
|
@@ -15287,7 +15431,7 @@ declare module GC{
|
|
|
15287
15431
|
* @property {boolean} [includeEmptyRegionCells] - Whether to include any empty cells(cells with no data or only style) outside the used data range, default true.
|
|
15288
15432
|
* @property {boolean} [losslessEditing] - Whether to include lossless editing content, default true.
|
|
15289
15433
|
* @property {string} [password] - Set the password to open the workbook.
|
|
15290
|
-
* @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The exporting excel file type ('XLSX' | 'XLSM' | 'XLTM'), default by XLSX.
|
|
15434
|
+
* @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The exporting excel file type ('XLSX' | 'XLSM' | 'XLTM' | 'XLTX'), default by XLSX.
|
|
15291
15435
|
*/
|
|
15292
15436
|
export type ExportXlsxOptions =
|
|
15293
15437
|
{
|
|
@@ -15391,7 +15535,7 @@ declare module GC{
|
|
|
15391
15535
|
* @property {string} [password] - The password to open the workbook.
|
|
15392
15536
|
* @property {GC.Spread.Sheets.OpenMode} [openMode] - The open mode of normal, lazy and incremental. By default is normal.
|
|
15393
15537
|
* @property {GC.Spread.Sheets.ProgressFunctionType} [progress] - The progress callback function for each open mode.
|
|
15394
|
-
* @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The importing excel file type ('XLSX' | 'XLSM' | 'XLTM'), default by XLSX.
|
|
15538
|
+
* @property {GC.Spread.Sheets.ExcelFileType} [excelFileType] - The importing excel file type ('XLSX' | 'XLSM' | 'XLTM' | 'XLTX'), default by XLSX.
|
|
15395
15539
|
*/
|
|
15396
15540
|
export type ImportXlsxOptions =
|
|
15397
15541
|
{
|
|
@@ -15785,7 +15929,11 @@ declare module GC{
|
|
|
15785
15929
|
/**
|
|
15786
15930
|
* Calculations only occur when the user requests them.
|
|
15787
15931
|
*/
|
|
15788
|
-
manual= 1
|
|
15932
|
+
manual= 1,
|
|
15933
|
+
/**
|
|
15934
|
+
* Calculate all formulas except the SJS.TABLE when the relevant data changes.
|
|
15935
|
+
*/
|
|
15936
|
+
partial= 2
|
|
15789
15937
|
}
|
|
15790
15938
|
|
|
15791
15939
|
/**
|
|
@@ -17599,6 +17747,14 @@ declare module GC{
|
|
|
17599
17747
|
/** Specifies to display double line below the text.
|
|
17600
17748
|
*/
|
|
17601
17749
|
doubleUnderline= 8,
|
|
17750
|
+
/**
|
|
17751
|
+
* Specifies to display a single accounting underline below the text.
|
|
17752
|
+
*/
|
|
17753
|
+
accountingUnderline= 16,
|
|
17754
|
+
/**
|
|
17755
|
+
* Specifies to display a double accounting underline below the text.
|
|
17756
|
+
*/
|
|
17757
|
+
doubleAccountingUnderline= 32,
|
|
17602
17758
|
/** Specifies normal text.
|
|
17603
17759
|
*/
|
|
17604
17760
|
none= 0
|
|
@@ -17955,6 +18111,17 @@ declare module GC{
|
|
|
17955
18111
|
* ```
|
|
17956
18112
|
*/
|
|
17957
18113
|
altText(value?: any): any;
|
|
18114
|
+
/**
|
|
18115
|
+
* Apply a named cell template to this range.
|
|
18116
|
+
* @param {string} name The name of a registered template (must be registered in workbook.namedCellTemplates).
|
|
18117
|
+
* @example
|
|
18118
|
+
* ```javascript
|
|
18119
|
+
* // Apply by name (template must be registered in workbook.namedCellTemplates)
|
|
18120
|
+
* sheet.getRange("A:A").applyNamedCellTemplate("MyTemplate");
|
|
18121
|
+
* sheet.getRange(1, 1, 3, 3).applyNamedCellTemplate("MyTemplate");
|
|
18122
|
+
* ```
|
|
18123
|
+
*/
|
|
18124
|
+
applyNamedCellTemplate(name: string): void;
|
|
17958
18125
|
/**
|
|
17959
18126
|
* Gets or sets the background color for the cell, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
|
|
17960
18127
|
* @param {string|undefined|GC.Spread.Sheets.IPatternFill|GC.Spread.Sheets.IGradientFill|GC.Spread.Sheets.IGradientPathFill} [value] The cell background color.
|
|
@@ -20130,13 +20297,11 @@ declare module GC{
|
|
|
20130
20297
|
* @param eventParam *{@link GC.Spread.Sheets.Collaboration.IPermission}* `permission` The sheet that triggered the event.
|
|
20131
20298
|
* @example
|
|
20132
20299
|
* ```javascript
|
|
20133
|
-
* ```javascript
|
|
20134
20300
|
* //This example uses the ThreadedCommentChanged event.
|
|
20135
20301
|
* spread.bind(GC.Spread.Sheets.Events.PermissionChanged, function (e, info) {
|
|
20136
20302
|
* console.log(info.permission);
|
|
20137
20303
|
* });
|
|
20138
20304
|
* ```
|
|
20139
|
-
* ```
|
|
20140
20305
|
*/
|
|
20141
20306
|
static PermissionChanged: string;
|
|
20142
20307
|
/**
|
|
@@ -20209,6 +20374,27 @@ declare module GC{
|
|
|
20209
20374
|
* ```
|
|
20210
20375
|
*/
|
|
20211
20376
|
static PivotTableChanged: string;
|
|
20377
|
+
/**
|
|
20378
|
+
* Before PivotTable fieldChanged.
|
|
20379
|
+
* @name GC.Spread.Sheets.Worksheet#PivotTableChanging
|
|
20380
|
+
* @event
|
|
20381
|
+
* @param eventParam *string* `pivotTableName` The PivotTable's name.
|
|
20382
|
+
* @param eventParam *string* `type` The specific operation name(fieldChanging).
|
|
20383
|
+
* @param eventParam *string* `[fieldName]` Changing fieldName.
|
|
20384
|
+
* @param eventParam *string* `[sourceName]` Changing field sourceName.
|
|
20385
|
+
* @param eventParam *number* `[newArea]` New PivotTable Field Type(fieldChanging).
|
|
20386
|
+
* @param eventParam *number* `[newIndex]` New PivotTable Field index(fieldChanging).
|
|
20387
|
+
* @param eventParam *boolean* `[autoGroupDateField]` Whether to automatically group the currently modified date field.
|
|
20388
|
+
* @param eventParam *boolean* `[cancel]` Whether to cancel the current operation.
|
|
20389
|
+
* @example
|
|
20390
|
+
* ```javascript
|
|
20391
|
+
* //This example.
|
|
20392
|
+
* sheet.bind(GC.Spread.Sheets.Events.PivotTableChanging, function (sender, args) {
|
|
20393
|
+
* alert("pivotTableName: " + args.pivotTableName + "changeType: " + args.type);
|
|
20394
|
+
* });
|
|
20395
|
+
* ```
|
|
20396
|
+
*/
|
|
20397
|
+
static PivotTableChanging: string;
|
|
20212
20398
|
/**
|
|
20213
20399
|
* Occurs when the cell range has changed.
|
|
20214
20400
|
* @name GC.Spread.Sheets.Worksheet#RangeChanged
|
|
@@ -21397,15 +21583,34 @@ declare module GC{
|
|
|
21397
21583
|
* @param eventParam *string[]* `userIds` The user ids that were mentioned.
|
|
21398
21584
|
* @example
|
|
21399
21585
|
* ```javascript
|
|
21400
|
-
* ```javascript
|
|
21401
21586
|
* //This example uses the ThreadedCommentChanged event.
|
|
21402
21587
|
* sheet.bind(GC.Spread.Sheets.Events.UserMentioned, function (e, info) {
|
|
21403
21588
|
* console.log(info.userId);
|
|
21404
21589
|
* });
|
|
21405
21590
|
* ```
|
|
21406
|
-
* ```
|
|
21407
21591
|
*/
|
|
21408
21592
|
static UserMentioned: string;
|
|
21593
|
+
/**
|
|
21594
|
+
* Occurs when a mention is about to be triggered. Set cancel to true to prevent the mention.
|
|
21595
|
+
* @name GC.Spread.Sheets.Worksheet#UserMentioning
|
|
21596
|
+
* @event
|
|
21597
|
+
* @param eventParam *{@link GC.Spread.Sheets.Worksheet}* `sheet` The sheet that triggered the event.
|
|
21598
|
+
* @param eventParam *string* `sheetName` The sheet's name.
|
|
21599
|
+
* @param eventParam *Object* `context` The mention trigger context.
|
|
21600
|
+
* @param eventParam *{@link GC.Spread.Sheets.MentionContextType}* `context.type` The mention context type.
|
|
21601
|
+
* @param {GC.Spread.Sheets.ThreadedComments.ThreadedComment} [context.threadedComment] The threaded comment where mention is being triggered.
|
|
21602
|
+
* @param eventParam *boolean* `cancel` Set to true to cancel the mention.
|
|
21603
|
+
* @example
|
|
21604
|
+
* ```javascript
|
|
21605
|
+
* ```javascript
|
|
21606
|
+
* //This example uses the ThreadedCommentChanged event.
|
|
21607
|
+
* sheet.bind(GC.Spread.Sheets.Events.UserMentioning, function (e, info) {
|
|
21608
|
+
* info.cancel = true;
|
|
21609
|
+
* });
|
|
21610
|
+
* ```
|
|
21611
|
+
* ```
|
|
21612
|
+
*/
|
|
21613
|
+
static UserMentioning: string;
|
|
21409
21614
|
/**
|
|
21410
21615
|
* Occurs when the applied cell value is invalid.
|
|
21411
21616
|
* @name GC.Spread.Sheets.Worksheet#ValidationError
|
|
@@ -21748,7 +21953,7 @@ declare module GC{
|
|
|
21748
21953
|
* sheet.pivotTables.remove("pivotTable_1");
|
|
21749
21954
|
* ```
|
|
21750
21955
|
*/
|
|
21751
|
-
remove(name: string):
|
|
21956
|
+
remove(name: string): void;
|
|
21752
21957
|
}
|
|
21753
21958
|
|
|
21754
21959
|
export class Point{
|
|
@@ -23083,7 +23288,7 @@ declare module GC{
|
|
|
23083
23288
|
* activeSheet.repaint();
|
|
23084
23289
|
* ```
|
|
23085
23290
|
*/
|
|
23086
|
-
Apex: ColorScheme;
|
|
23291
|
+
static Apex: ColorScheme;
|
|
23087
23292
|
/**
|
|
23088
23293
|
* The theme color of the Aspect theme.
|
|
23089
23294
|
* @example
|
|
@@ -23094,7 +23299,7 @@ declare module GC{
|
|
|
23094
23299
|
* activeSheet.repaint();
|
|
23095
23300
|
* ```
|
|
23096
23301
|
*/
|
|
23097
|
-
Aspect: ColorScheme;
|
|
23302
|
+
static Aspect: ColorScheme;
|
|
23098
23303
|
/**
|
|
23099
23304
|
* The theme color of the Civic theme.
|
|
23100
23305
|
* @example
|
|
@@ -23105,7 +23310,7 @@ declare module GC{
|
|
|
23105
23310
|
* activeSheet.repaint();
|
|
23106
23311
|
* ```
|
|
23107
23312
|
*/
|
|
23108
|
-
Civic: ColorScheme;
|
|
23313
|
+
static Civic: ColorScheme;
|
|
23109
23314
|
/**
|
|
23110
23315
|
* The theme color of the Concourse theme.
|
|
23111
23316
|
* @example
|
|
@@ -23116,7 +23321,7 @@ declare module GC{
|
|
|
23116
23321
|
* activeSheet.repaint();
|
|
23117
23322
|
* ```
|
|
23118
23323
|
*/
|
|
23119
|
-
Concourse: ColorScheme;
|
|
23324
|
+
static Concourse: ColorScheme;
|
|
23120
23325
|
/**
|
|
23121
23326
|
* The theme color of the Default theme.
|
|
23122
23327
|
* @example
|
|
@@ -23127,7 +23332,7 @@ declare module GC{
|
|
|
23127
23332
|
* activeSheet.repaint();
|
|
23128
23333
|
* ```
|
|
23129
23334
|
*/
|
|
23130
|
-
Default: ColorScheme;
|
|
23335
|
+
static Default: ColorScheme;
|
|
23131
23336
|
/**
|
|
23132
23337
|
* The theme color of the Equity theme.
|
|
23133
23338
|
* @example
|
|
@@ -23138,7 +23343,7 @@ declare module GC{
|
|
|
23138
23343
|
* activeSheet.repaint();
|
|
23139
23344
|
* ```
|
|
23140
23345
|
*/
|
|
23141
|
-
Equity: ColorScheme;
|
|
23346
|
+
static Equity: ColorScheme;
|
|
23142
23347
|
/**
|
|
23143
23348
|
* The theme color of the Flow theme.
|
|
23144
23349
|
* @example
|
|
@@ -23149,7 +23354,7 @@ declare module GC{
|
|
|
23149
23354
|
* activeSheet.repaint();
|
|
23150
23355
|
* ```
|
|
23151
23356
|
*/
|
|
23152
|
-
Flow: ColorScheme;
|
|
23357
|
+
static Flow: ColorScheme;
|
|
23153
23358
|
/**
|
|
23154
23359
|
* The theme color of the Foundry theme.
|
|
23155
23360
|
* @example
|
|
@@ -23160,7 +23365,7 @@ declare module GC{
|
|
|
23160
23365
|
* activeSheet.repaint();
|
|
23161
23366
|
* ```
|
|
23162
23367
|
*/
|
|
23163
|
-
Foundry: ColorScheme;
|
|
23368
|
+
static Foundry: ColorScheme;
|
|
23164
23369
|
/**
|
|
23165
23370
|
* The theme color of the Median theme.
|
|
23166
23371
|
* @example
|
|
@@ -23171,7 +23376,7 @@ declare module GC{
|
|
|
23171
23376
|
* activeSheet.repaint();
|
|
23172
23377
|
* ```
|
|
23173
23378
|
*/
|
|
23174
|
-
Median: ColorScheme;
|
|
23379
|
+
static Median: ColorScheme;
|
|
23175
23380
|
/**
|
|
23176
23381
|
* The theme color of the Metro theme.
|
|
23177
23382
|
* @example
|
|
@@ -23182,7 +23387,7 @@ declare module GC{
|
|
|
23182
23387
|
* activeSheet.repaint();
|
|
23183
23388
|
* ```
|
|
23184
23389
|
*/
|
|
23185
|
-
Metro: ColorScheme;
|
|
23390
|
+
static Metro: ColorScheme;
|
|
23186
23391
|
/**
|
|
23187
23392
|
* The theme color of the Module theme.
|
|
23188
23393
|
* @example
|
|
@@ -23193,7 +23398,7 @@ declare module GC{
|
|
|
23193
23398
|
* activeSheet.repaint();
|
|
23194
23399
|
* ```
|
|
23195
23400
|
*/
|
|
23196
|
-
Module: ColorScheme;
|
|
23401
|
+
static Module: ColorScheme;
|
|
23197
23402
|
/**
|
|
23198
23403
|
* The theme color of the Office theme.
|
|
23199
23404
|
* @example
|
|
@@ -23204,7 +23409,7 @@ declare module GC{
|
|
|
23204
23409
|
* activeSheet.repaint();
|
|
23205
23410
|
* ```
|
|
23206
23411
|
*/
|
|
23207
|
-
Office: ColorScheme;
|
|
23412
|
+
static Office: ColorScheme;
|
|
23208
23413
|
/**
|
|
23209
23414
|
* The theme color of the Office 2007 theme.
|
|
23210
23415
|
* @example
|
|
@@ -23215,7 +23420,7 @@ declare module GC{
|
|
|
23215
23420
|
* activeSheet.repaint();
|
|
23216
23421
|
* ```
|
|
23217
23422
|
*/
|
|
23218
|
-
Office2007: ColorScheme;
|
|
23423
|
+
static Office2007: ColorScheme;
|
|
23219
23424
|
/**
|
|
23220
23425
|
* The theme color of the Opulent theme.
|
|
23221
23426
|
* @example
|
|
@@ -23226,7 +23431,7 @@ declare module GC{
|
|
|
23226
23431
|
* activeSheet.repaint();
|
|
23227
23432
|
* ```
|
|
23228
23433
|
*/
|
|
23229
|
-
Opulent: ColorScheme;
|
|
23434
|
+
static Opulent: ColorScheme;
|
|
23230
23435
|
/**
|
|
23231
23436
|
* The theme color of the Oriel theme.
|
|
23232
23437
|
* @example
|
|
@@ -23237,7 +23442,7 @@ declare module GC{
|
|
|
23237
23442
|
* activeSheet.repaint();
|
|
23238
23443
|
* ```
|
|
23239
23444
|
*/
|
|
23240
|
-
Oriel: ColorScheme;
|
|
23445
|
+
static Oriel: ColorScheme;
|
|
23241
23446
|
/**
|
|
23242
23447
|
* The theme color of the Origin theme.
|
|
23243
23448
|
* @example
|
|
@@ -23248,7 +23453,7 @@ declare module GC{
|
|
|
23248
23453
|
* activeSheet.repaint();
|
|
23249
23454
|
* ```
|
|
23250
23455
|
*/
|
|
23251
|
-
Origin: ColorScheme;
|
|
23456
|
+
static Origin: ColorScheme;
|
|
23252
23457
|
/**
|
|
23253
23458
|
* The theme color of the Paper theme.
|
|
23254
23459
|
* @example
|
|
@@ -23259,7 +23464,7 @@ declare module GC{
|
|
|
23259
23464
|
* activeSheet.repaint();
|
|
23260
23465
|
* ```
|
|
23261
23466
|
*/
|
|
23262
|
-
Paper: ColorScheme;
|
|
23467
|
+
static Paper: ColorScheme;
|
|
23263
23468
|
/**
|
|
23264
23469
|
* The theme color of the Solstice theme.
|
|
23265
23470
|
* @example
|
|
@@ -23270,7 +23475,7 @@ declare module GC{
|
|
|
23270
23475
|
* activeSheet.repaint();
|
|
23271
23476
|
* ```
|
|
23272
23477
|
*/
|
|
23273
|
-
Solstice: ColorScheme;
|
|
23478
|
+
static Solstice: ColorScheme;
|
|
23274
23479
|
/**
|
|
23275
23480
|
* The theme color of the Technic theme.
|
|
23276
23481
|
* @example
|
|
@@ -23281,7 +23486,7 @@ declare module GC{
|
|
|
23281
23486
|
* activeSheet.repaint();
|
|
23282
23487
|
* ```
|
|
23283
23488
|
*/
|
|
23284
|
-
Technic: ColorScheme;
|
|
23489
|
+
static Technic: ColorScheme;
|
|
23285
23490
|
/**
|
|
23286
23491
|
* The theme color of the Trek theme.
|
|
23287
23492
|
* @example
|
|
@@ -23292,7 +23497,7 @@ declare module GC{
|
|
|
23292
23497
|
* activeSheet.repaint();
|
|
23293
23498
|
* ```
|
|
23294
23499
|
*/
|
|
23295
|
-
Trek: ColorScheme;
|
|
23500
|
+
static Trek: ColorScheme;
|
|
23296
23501
|
/**
|
|
23297
23502
|
* The theme color of the Urban theme.
|
|
23298
23503
|
* @example
|
|
@@ -23303,7 +23508,7 @@ declare module GC{
|
|
|
23303
23508
|
* activeSheet.repaint();
|
|
23304
23509
|
* ```
|
|
23305
23510
|
*/
|
|
23306
|
-
Urban: ColorScheme;
|
|
23511
|
+
static Urban: ColorScheme;
|
|
23307
23512
|
/**
|
|
23308
23513
|
* The theme color of the Verve theme.
|
|
23309
23514
|
* @example
|
|
@@ -23314,7 +23519,7 @@ declare module GC{
|
|
|
23314
23519
|
* activeSheet.repaint();
|
|
23315
23520
|
* ```
|
|
23316
23521
|
*/
|
|
23317
|
-
Verve: ColorScheme;
|
|
23522
|
+
static Verve: ColorScheme;
|
|
23318
23523
|
}
|
|
23319
23524
|
|
|
23320
23525
|
export class ThemeFont{
|
|
@@ -23437,87 +23642,87 @@ declare module GC{
|
|
|
23437
23642
|
/**
|
|
23438
23643
|
* The theme font named BookmanGillSansMT.
|
|
23439
23644
|
*/
|
|
23440
|
-
BookmanGillSansMT: GC.Spread.Sheets.ThemeFont;
|
|
23645
|
+
static BookmanGillSansMT: GC.Spread.Sheets.ThemeFont;
|
|
23441
23646
|
/**
|
|
23442
23647
|
* The theme font named CalibriConstantia.
|
|
23443
23648
|
*/
|
|
23444
|
-
CalibriConstantia: GC.Spread.Sheets.ThemeFont;
|
|
23649
|
+
static CalibriConstantia: GC.Spread.Sheets.ThemeFont;
|
|
23445
23650
|
/**
|
|
23446
23651
|
* The theme font named CenturyGothic.
|
|
23447
23652
|
*/
|
|
23448
|
-
CenturyGothic: GC.Spread.Sheets.ThemeFont;
|
|
23653
|
+
static CenturyGothic: GC.Spread.Sheets.ThemeFont;
|
|
23449
23654
|
/**
|
|
23450
23655
|
* The theme font named CenturySchoolbook.
|
|
23451
23656
|
*/
|
|
23452
|
-
CenturySchoolbook: GC.Spread.Sheets.ThemeFont;
|
|
23657
|
+
static CenturySchoolbook: GC.Spread.Sheets.ThemeFont;
|
|
23453
23658
|
/**
|
|
23454
23659
|
* The theme font named ConsolasCorbel.
|
|
23455
23660
|
*/
|
|
23456
|
-
ConsolasCorbel: GC.Spread.Sheets.ThemeFont;
|
|
23661
|
+
static ConsolasCorbel: GC.Spread.Sheets.ThemeFont;
|
|
23457
23662
|
/**
|
|
23458
23663
|
* The theme font named Constantia.
|
|
23459
23664
|
*/
|
|
23460
|
-
Constantia: GC.Spread.Sheets.ThemeFont;
|
|
23665
|
+
static Constantia: GC.Spread.Sheets.ThemeFont;
|
|
23461
23666
|
/**
|
|
23462
23667
|
* The theme font named Corbel.
|
|
23463
23668
|
*/
|
|
23464
|
-
Corbel: GC.Spread.Sheets.ThemeFont;
|
|
23669
|
+
static Corbel: GC.Spread.Sheets.ThemeFont;
|
|
23465
23670
|
/**
|
|
23466
23671
|
* The theme font named FranklinGothic.
|
|
23467
23672
|
*/
|
|
23468
|
-
FranklinGothic: GC.Spread.Sheets.ThemeFont;
|
|
23673
|
+
static FranklinGothic: GC.Spread.Sheets.ThemeFont;
|
|
23469
23674
|
/**
|
|
23470
23675
|
* The theme font named FranklinGothicArial.
|
|
23471
23676
|
*/
|
|
23472
|
-
FranklinGothicArial: GC.Spread.Sheets.ThemeFont;
|
|
23677
|
+
static FranklinGothicArial: GC.Spread.Sheets.ThemeFont;
|
|
23473
23678
|
/**
|
|
23474
23679
|
* The theme font named FranklinGothicPerpetua.
|
|
23475
23680
|
*/
|
|
23476
|
-
FranklinGothicPerpetua: GC.Spread.Sheets.ThemeFont;
|
|
23681
|
+
static FranklinGothicPerpetua: GC.Spread.Sheets.ThemeFont;
|
|
23477
23682
|
/**
|
|
23478
23683
|
* The theme font named Georgia.
|
|
23479
23684
|
*/
|
|
23480
|
-
Georgia: GC.Spread.Sheets.ThemeFont;
|
|
23685
|
+
static Georgia: GC.Spread.Sheets.ThemeFont;
|
|
23481
23686
|
/**
|
|
23482
23687
|
* The theme font named GillSansMT.
|
|
23483
23688
|
*/
|
|
23484
|
-
GillSansMT: GC.Spread.Sheets.ThemeFont;
|
|
23689
|
+
static GillSansMT: GC.Spread.Sheets.ThemeFont;
|
|
23485
23690
|
/**
|
|
23486
23691
|
* The theme font named LucidaBook.
|
|
23487
23692
|
*/
|
|
23488
|
-
LucidaBook: GC.Spread.Sheets.ThemeFont;
|
|
23693
|
+
static LucidaBook: GC.Spread.Sheets.ThemeFont;
|
|
23489
23694
|
/**
|
|
23490
23695
|
* The theme font named LucidaSansUnicode.
|
|
23491
23696
|
*/
|
|
23492
|
-
LucidaSansUnicode: GC.Spread.Sheets.ThemeFont;
|
|
23697
|
+
static LucidaSansUnicode: GC.Spread.Sheets.ThemeFont;
|
|
23493
23698
|
/**
|
|
23494
23699
|
* The theme font named Office.
|
|
23495
23700
|
*/
|
|
23496
|
-
Office: GC.Spread.Sheets.ThemeFont;
|
|
23701
|
+
static Office: GC.Spread.Sheets.ThemeFont;
|
|
23497
23702
|
/**
|
|
23498
23703
|
* The theme font named Office2007.
|
|
23499
23704
|
*/
|
|
23500
|
-
Office2007: GC.Spread.Sheets.ThemeFont;
|
|
23705
|
+
static Office2007: GC.Spread.Sheets.ThemeFont;
|
|
23501
23706
|
/**
|
|
23502
23707
|
* The theme font named Rockwell.
|
|
23503
23708
|
*/
|
|
23504
|
-
Rockwell: GC.Spread.Sheets.ThemeFont;
|
|
23709
|
+
static Rockwell: GC.Spread.Sheets.ThemeFont;
|
|
23505
23710
|
/**
|
|
23506
23711
|
* The theme font named TrebuchetGeorgia.
|
|
23507
23712
|
*/
|
|
23508
|
-
TrebuchetGeorgia: GC.Spread.Sheets.ThemeFont;
|
|
23713
|
+
static TrebuchetGeorgia: GC.Spread.Sheets.ThemeFont;
|
|
23509
23714
|
/**
|
|
23510
23715
|
* The theme font named TrebuchetMS.
|
|
23511
23716
|
*/
|
|
23512
|
-
TrebuchetMS: GC.Spread.Sheets.ThemeFont;
|
|
23717
|
+
static TrebuchetMS: GC.Spread.Sheets.ThemeFont;
|
|
23513
23718
|
/**
|
|
23514
23719
|
* The theme font named TwCenMT.
|
|
23515
23720
|
*/
|
|
23516
|
-
TwCenMT: GC.Spread.Sheets.ThemeFont;
|
|
23721
|
+
static TwCenMT: GC.Spread.Sheets.ThemeFont;
|
|
23517
23722
|
/**
|
|
23518
23723
|
* The theme font named Verdana.
|
|
23519
23724
|
*/
|
|
23520
|
-
Verdana: GC.Spread.Sheets.ThemeFont;
|
|
23725
|
+
static Verdana: GC.Spread.Sheets.ThemeFont;
|
|
23521
23726
|
}
|
|
23522
23727
|
|
|
23523
23728
|
export class Themes{
|
|
@@ -23529,91 +23734,91 @@ declare module GC{
|
|
|
23529
23734
|
/**
|
|
23530
23735
|
* Indicates the Apex theme.
|
|
23531
23736
|
*/
|
|
23532
|
-
Apex: Theme;
|
|
23737
|
+
static Apex: Theme;
|
|
23533
23738
|
/**
|
|
23534
23739
|
* Indicates the Aspect theme.
|
|
23535
23740
|
*/
|
|
23536
|
-
Aspect: Theme;
|
|
23741
|
+
static Aspect: Theme;
|
|
23537
23742
|
/**
|
|
23538
23743
|
* Indicates the Civic theme.
|
|
23539
23744
|
*/
|
|
23540
|
-
Civic: Theme;
|
|
23745
|
+
static Civic: Theme;
|
|
23541
23746
|
/**
|
|
23542
23747
|
* Indicates the Concourse theme.
|
|
23543
23748
|
*/
|
|
23544
|
-
Concourse: Theme;
|
|
23749
|
+
static Concourse: Theme;
|
|
23545
23750
|
/**
|
|
23546
23751
|
* Indicates the Default theme.
|
|
23547
23752
|
*/
|
|
23548
|
-
Default: Theme;
|
|
23753
|
+
static Default: Theme;
|
|
23549
23754
|
/**
|
|
23550
23755
|
* Indicates the Equity theme.
|
|
23551
23756
|
*/
|
|
23552
|
-
Equity: Theme;
|
|
23757
|
+
static Equity: Theme;
|
|
23553
23758
|
/**
|
|
23554
23759
|
* Indicates the Flow theme.
|
|
23555
23760
|
*/
|
|
23556
|
-
Flow: Theme;
|
|
23761
|
+
static Flow: Theme;
|
|
23557
23762
|
/**
|
|
23558
23763
|
* Indicates the Foundry theme.
|
|
23559
23764
|
*/
|
|
23560
|
-
Foundry: Theme;
|
|
23765
|
+
static Foundry: Theme;
|
|
23561
23766
|
/**
|
|
23562
23767
|
* Indicates the Median theme.
|
|
23563
23768
|
*/
|
|
23564
|
-
Median: Theme;
|
|
23769
|
+
static Median: Theme;
|
|
23565
23770
|
/**
|
|
23566
23771
|
* Indicates the Metro theme.
|
|
23567
23772
|
*/
|
|
23568
|
-
Metro: Theme;
|
|
23773
|
+
static Metro: Theme;
|
|
23569
23774
|
/**
|
|
23570
23775
|
* Indicates the Module theme.
|
|
23571
23776
|
*/
|
|
23572
|
-
Module: Theme;
|
|
23777
|
+
static Module: Theme;
|
|
23573
23778
|
/**
|
|
23574
23779
|
* Indicates the Office theme.
|
|
23575
23780
|
*/
|
|
23576
|
-
Office: Theme;
|
|
23781
|
+
static Office: Theme;
|
|
23577
23782
|
/**
|
|
23578
23783
|
* Indicates the Office 2007 theme.
|
|
23579
23784
|
*/
|
|
23580
|
-
Office2007: Theme;
|
|
23785
|
+
static Office2007: Theme;
|
|
23581
23786
|
/**
|
|
23582
23787
|
* Indicates the Opulent theme.
|
|
23583
23788
|
*/
|
|
23584
|
-
Opulent: Theme;
|
|
23789
|
+
static Opulent: Theme;
|
|
23585
23790
|
/**
|
|
23586
23791
|
* Indicates the Oriel theme.
|
|
23587
23792
|
*/
|
|
23588
|
-
Oriel: Theme;
|
|
23793
|
+
static Oriel: Theme;
|
|
23589
23794
|
/**
|
|
23590
23795
|
* Indicates the Origin theme.
|
|
23591
23796
|
*/
|
|
23592
|
-
Origin: Theme;
|
|
23797
|
+
static Origin: Theme;
|
|
23593
23798
|
/**
|
|
23594
23799
|
* Indicates the Paper theme.
|
|
23595
23800
|
*/
|
|
23596
|
-
Paper: Theme;
|
|
23801
|
+
static Paper: Theme;
|
|
23597
23802
|
/**
|
|
23598
23803
|
* Indicates the Solstice theme.
|
|
23599
23804
|
*/
|
|
23600
|
-
Solstice: Theme;
|
|
23805
|
+
static Solstice: Theme;
|
|
23601
23806
|
/**
|
|
23602
23807
|
* Indicates the Technic theme.
|
|
23603
23808
|
*/
|
|
23604
|
-
Technic: Theme;
|
|
23809
|
+
static Technic: Theme;
|
|
23605
23810
|
/**
|
|
23606
23811
|
* Indicates the Trek theme.
|
|
23607
23812
|
*/
|
|
23608
|
-
Trek: Theme;
|
|
23813
|
+
static Trek: Theme;
|
|
23609
23814
|
/**
|
|
23610
23815
|
* Indicates the Urban theme.
|
|
23611
23816
|
*/
|
|
23612
|
-
Urban: Theme;
|
|
23817
|
+
static Urban: Theme;
|
|
23613
23818
|
/**
|
|
23614
23819
|
* Indicates the Verve theme.
|
|
23615
23820
|
*/
|
|
23616
|
-
Verve: Theme;
|
|
23821
|
+
static Verve: Theme;
|
|
23617
23822
|
}
|
|
23618
23823
|
|
|
23619
23824
|
export class Workbook{
|
|
@@ -23636,8 +23841,8 @@ declare module GC{
|
|
|
23636
23841
|
* @param {boolean} [options.allowUserDeselect] - Whether to allow the user to can use deselect in selection. The default value is true.
|
|
23637
23842
|
* @param {GC.Spread.Sheets.Fill.AutoFillType} [options.defaultDragFillType] - The default fill type. The default value is GC.Spread.Sheets.Fill.AutoFillType.auto.
|
|
23638
23843
|
* @param {boolean} [options.showDragFillSmartTag] - Whether to display the drag fill dialog. The default value is true.
|
|
23639
|
-
* @param {boolean} [options.showHorizontalScrollbar] - Whether to display the horizontal scroll bar. The default value is true.
|
|
23640
|
-
* @param {boolean} [options.showVerticalScrollbar] - Whether to display the vertical scroll bar. The default value is true.
|
|
23844
|
+
* @param {boolean|"auto"} [options.showHorizontalScrollbar] - Whether to display the horizontal scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
23845
|
+
* @param {boolean|"auto"} [options.showVerticalScrollbar] - Whether to display the vertical scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
23641
23846
|
* @param {boolean} [options.scrollbarShowMax] - Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. The default value is true.
|
|
23642
23847
|
* @param {boolean} [options.scrollbarMaxAlign] - Whether the scroll bar aligns with the last row and column of the active sheet. The default value is false.
|
|
23643
23848
|
* @param {boolean} [options.tabStripVisible] - Whether to display the sheet tab strip. The default value is true.
|
|
@@ -23751,6 +23956,11 @@ declare module GC{
|
|
|
23751
23956
|
* ```
|
|
23752
23957
|
*/
|
|
23753
23958
|
name: string;
|
|
23959
|
+
/**
|
|
23960
|
+
* The named cell templates manager.
|
|
23961
|
+
* @type {GC.Spread.Sheets.NamedCellTemplates.NamedCellTemplatesManager}
|
|
23962
|
+
*/
|
|
23963
|
+
namedCellTemplates: GC.Spread.Sheets.NamedCellTemplates.NamedCellTemplatesManager;
|
|
23754
23964
|
/**
|
|
23755
23965
|
* Represents the options of the Spread control.
|
|
23756
23966
|
* @type {Object}
|
|
@@ -23766,8 +23976,8 @@ declare module GC{
|
|
|
23766
23976
|
* @property {boolean} allowUserDeselect - Whether to allow the user to can use deselect in selection. The default value is true.
|
|
23767
23977
|
* @property {GC.Spread.Sheets.Fill.AutoFillType} defaultDragFillType - The default fill type. The default value is GC.Spread.Sheets.Fill.AutoFillType.auto.
|
|
23768
23978
|
* @property {boolean} showDragFillSmartTag - Whether to display the drag fill dialog. The default value is true.
|
|
23769
|
-
* @property {boolean} showHorizontalScrollbar - Whether to display the horizontal scroll bar. The default value is true.
|
|
23770
|
-
* @property {boolean} showVerticalScrollbar - Whether to display the vertical scroll bar. The default value is true.
|
|
23979
|
+
* @property {boolean|"auto"} showHorizontalScrollbar - Whether to display the horizontal scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
23980
|
+
* @property {boolean|"auto"} showVerticalScrollbar - Whether to display the vertical scroll bar. The default value is true. Set to "auto" to show/hide based on scrollable and mouse hover.
|
|
23771
23981
|
* @property {boolean} scrollbarShowMax - Whether the displayed scroll bars are based on the entire number of columns and rows in the sheet. The default value is true.
|
|
23772
23982
|
* @property {boolean} scrollbarMaxAlign - Whether the scroll bar aligns with the last row and column of the active sheet. The default value is false.
|
|
23773
23983
|
* @property {boolean} tabStripVisible - Whether to display the sheet tab strip. The default value is true.
|
|
@@ -24895,7 +25105,7 @@ declare module GC{
|
|
|
24895
25105
|
*/
|
|
24896
25106
|
updateExternalReference(linkInfo: string | GC.Spread.Sheets.ExternalPartialValues, data?: object, filePath?: string, isMergeUpdate?: boolean): void;
|
|
24897
25107
|
/**
|
|
24898
|
-
* Waits for all
|
|
25108
|
+
* Waits for all calculation tasks to complete, including incrementalCalculation and SJS.TABLE.
|
|
24899
25109
|
* @returns {Promise<void>} A Promise that resolves when all calculations have finished.
|
|
24900
25110
|
* @example
|
|
24901
25111
|
* ```javascript
|
|
@@ -25319,6 +25529,28 @@ declare module GC{
|
|
|
25319
25529
|
* ```
|
|
25320
25530
|
*/
|
|
25321
25531
|
addSpans(spans: GC.Spread.Sheets.IRange[], sheetArea?: GC.Spread.Sheets.SheetArea): void;
|
|
25532
|
+
/**
|
|
25533
|
+
* Apply a named cell template to a range on this worksheet.
|
|
25534
|
+
* @param {string} name The name of a registered template (must be registered in workbook.namedCellTemplates).
|
|
25535
|
+
* @param {string} address The A1-style address of the range, or a table structured reference.
|
|
25536
|
+
* For example "A:A", "A1:C3", "1:3", "Table1", "Table1[Column1]", "Table1[[#Data]]", "Table1[[#Headers]]".
|
|
25537
|
+
* @example
|
|
25538
|
+
* ```javascript
|
|
25539
|
+
* // Apply template by name to column A
|
|
25540
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "A:A");
|
|
25541
|
+
* // Apply template by name to a range
|
|
25542
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "A1:C3");
|
|
25543
|
+
* // Apply template to entire table (uses table.layoutStyle)
|
|
25544
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "Table1");
|
|
25545
|
+
* // Apply template to table data area (uses layoutStyle.data)
|
|
25546
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "Table1[[#Data]]");
|
|
25547
|
+
* // Apply template to table header area (uses layoutStyle.header)
|
|
25548
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "Table1[[#Headers]]");
|
|
25549
|
+
* // Apply template to table footer/totals area (uses layoutStyle.footer)
|
|
25550
|
+
* sheet.applyNamedCellTemplate("MyTemplate", "Table1[[#Totals]]");
|
|
25551
|
+
* ```
|
|
25552
|
+
*/
|
|
25553
|
+
applyNamedCellTemplate(name: string, address: string): void;
|
|
25322
25554
|
/**
|
|
25323
25555
|
* Automatically fits the viewport column.
|
|
25324
25556
|
* @property {number} column The column index.
|
|
@@ -27891,21 +28123,28 @@ declare module GC{
|
|
|
27891
28123
|
*/
|
|
27892
28124
|
zoom(factor?: number): any;
|
|
27893
28125
|
}
|
|
27894
|
-
|
|
28126
|
+
namespace AI{
|
|
27895
28127
|
|
|
27896
28128
|
/**
|
|
27897
|
-
*
|
|
27898
|
-
* @
|
|
28129
|
+
* Callback function type for sending an AI request.
|
|
28130
|
+
* @typedef {Function} AIRequestCallback
|
|
28131
|
+
* @param {IAIConfig} config - Request parameters to forward to the AI provider.
|
|
28132
|
+
* @returns {Promise<any>} Promise that resolves with the provider response.
|
|
27899
28133
|
*/
|
|
27900
28134
|
export type AIRequestCallback =
|
|
27901
28135
|
(config: IAIConfig) => Promise<any>
|
|
27902
28136
|
|
|
27903
28137
|
|
|
27904
28138
|
/**
|
|
27905
|
-
*
|
|
27906
|
-
*
|
|
27907
|
-
*
|
|
27908
|
-
* @
|
|
28139
|
+
* Simplified request body passed to the AI provider.
|
|
28140
|
+
* This shape is compatible with the OpenAI Chat Completions API request body used by this plugin,
|
|
28141
|
+
* while allowing additional OpenAI-compatible fields to pass through as custom properties.
|
|
28142
|
+
* @typedef {Object} IAIConfig
|
|
28143
|
+
* @property {{ role: string; content: string }[]} [messages] - Array of message objects containing role and content pairs for conversation history
|
|
28144
|
+
* @property {number} [temperature] - Sampling temperature for the generated response. Higher values make output more random.
|
|
28145
|
+
* @property {number} [max_tokens] - Legacy maximum output token limit.
|
|
28146
|
+
* @property {boolean} [stream] - Whether to return the response as a server-sent event stream (SSE).
|
|
28147
|
+
* @property {any} [key: string] - Additional provider-specific or OpenAI-compatible request properties, such as `model` or `max_completion_tokens`.
|
|
27909
28148
|
*/
|
|
27910
28149
|
export type IAIConfig =
|
|
27911
28150
|
{
|
|
@@ -27918,20 +28157,31 @@ declare module GC{
|
|
|
27918
28157
|
|
|
27919
28158
|
|
|
27920
28159
|
/**
|
|
27921
|
-
*
|
|
27922
|
-
* @
|
|
27923
|
-
* @property {string}
|
|
28160
|
+
* Environment configuration for the AI service endpoint.
|
|
28161
|
+
* @typedef {Object} IAIEnvironment
|
|
28162
|
+
* @property {string} model - Model identifier added to the outbound request body, for example an OpenAI chat model name.
|
|
28163
|
+
* @property {string} key - API key used in the `Authorization: Bearer` request header.
|
|
28164
|
+
* @property {string} basePath - HTTP endpoint that receives the JSON request body, for example a server route or OpenAI-compatible API URL.
|
|
27924
28165
|
*/
|
|
27925
28166
|
export type IAIEnvironment =
|
|
27926
28167
|
{
|
|
28168
|
+
/**
|
|
28169
|
+
* Model identifier added to the outbound request body, for example an OpenAI chat model name.
|
|
28170
|
+
*/
|
|
27927
28171
|
model: string;
|
|
28172
|
+
/**
|
|
28173
|
+
* API key used in the `Authorization: Bearer` request header.
|
|
28174
|
+
*/
|
|
27928
28175
|
key: string;
|
|
28176
|
+
/**
|
|
28177
|
+
* HTTP endpoint that receives the JSON request body, for example a server route or OpenAI-compatible API URL.
|
|
28178
|
+
*/
|
|
27929
28179
|
basePath: string;
|
|
27930
28180
|
}
|
|
27931
28181
|
|
|
27932
28182
|
}
|
|
27933
28183
|
|
|
27934
|
-
|
|
28184
|
+
namespace AutoMerge{
|
|
27935
28185
|
|
|
27936
28186
|
export interface IRangeInfo{
|
|
27937
28187
|
range: GC.Spread.Sheets.Range;
|
|
@@ -28000,7 +28250,7 @@ declare module GC{
|
|
|
28000
28250
|
|
|
28001
28251
|
}
|
|
28002
28252
|
|
|
28003
|
-
|
|
28253
|
+
namespace Barcode{
|
|
28004
28254
|
|
|
28005
28255
|
export class Codabar extends GC.Spread.Sheets.Sparklines.SparklineEx{
|
|
28006
28256
|
/**
|
|
@@ -28102,7 +28352,7 @@ declare module GC{
|
|
|
28102
28352
|
}
|
|
28103
28353
|
}
|
|
28104
28354
|
|
|
28105
|
-
|
|
28355
|
+
namespace Bindings{
|
|
28106
28356
|
|
|
28107
28357
|
export class CellBindingSource{
|
|
28108
28358
|
/**
|
|
@@ -28175,7 +28425,7 @@ declare module GC{
|
|
|
28175
28425
|
}
|
|
28176
28426
|
}
|
|
28177
28427
|
|
|
28178
|
-
|
|
28428
|
+
namespace CalcEngine{
|
|
28179
28429
|
/**
|
|
28180
28430
|
* Evaluates the specified formula.
|
|
28181
28431
|
* @param {object} context The evaluation context; in general, you should use the active sheet object.
|
|
@@ -28290,7 +28540,11 @@ declare module GC{
|
|
|
28290
28540
|
* @param {number} formulaRow The row index of the cell that contains the formula that you want to resolve.
|
|
28291
28541
|
* @param {number} formulaColumn The column index of the cell that contains the formula that you want to resolve.
|
|
28292
28542
|
* @param {number} desiredResult The formula result that you want.
|
|
28293
|
-
* @
|
|
28543
|
+
* @param {IGoalSeekOptions} [options] Optional settings to control the goal seek process.
|
|
28544
|
+
* @param {number} [options.maximumIterations=200] The maximum number of iterations to attempt. Defaults to 200.
|
|
28545
|
+
* @param {number} [options.tolerance=0.001] The maximum acceptable difference between the formula result and the desired result. Defaults to 0.001.
|
|
28546
|
+
* @param {Function} [options.callback] A callback invoked after each iteration. Receives the current trial solution and returns true to stop goal seek early or false/void to continue. When the callback returns a Promise, goal seek waits for that promise to settle before proceeding to the next iteration.
|
|
28547
|
+
* @returns {boolean | Promise<boolean>} Indicate that whether a solution has been found. For synchronous calls (no incremental calculation and no callback), returns boolean. For incremental-calculation scenarios or when options.callback is provided, returns a Promise<boolean>.
|
|
28294
28548
|
* @example
|
|
28295
28549
|
* ```javascript
|
|
28296
28550
|
* // This sample shows how to use the goal seek.
|
|
@@ -28302,8 +28556,36 @@ declare module GC{
|
|
|
28302
28556
|
* sheet.setFormula(3, 1, "PMT(B3/12,B2,B1)"); // Payment
|
|
28303
28557
|
* GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600); // result in B3 is 10%
|
|
28304
28558
|
* ```
|
|
28559
|
+
* @example
|
|
28560
|
+
* ```javascript
|
|
28561
|
+
* // This sample shows how to use the goal seek with custom options.
|
|
28562
|
+
* sheet.setValue(0, 1, 10000);
|
|
28563
|
+
* sheet.setValue(1, 1, 18);
|
|
28564
|
+
* sheet.setFormatter(2, 1, "0%");
|
|
28565
|
+
* sheet.setFormatter(3, 1, "0.00");
|
|
28566
|
+
* sheet.setFormula(3, 1, "PMT(B3/12,B2,B1)");
|
|
28567
|
+
* GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600, {
|
|
28568
|
+
* maximumIterations: 200,
|
|
28569
|
+
* tolerance: 0.0001
|
|
28570
|
+
* });
|
|
28571
|
+
* ```
|
|
28572
|
+
* @example
|
|
28573
|
+
* ```javascript
|
|
28574
|
+
* // This sample shows how to use the goal seek with callback to observe and stop early.
|
|
28575
|
+
* GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600, {
|
|
28576
|
+
* maximumIterations: 200,
|
|
28577
|
+
* tolerance: 0,
|
|
28578
|
+
* callback: (info) => {
|
|
28579
|
+
* console.log(`iter=${info.currentIteration}, x=${info.currentValue}, f(x)=${info.currentFormulaResult}, succeeded=${info.succeeded}`);
|
|
28580
|
+
* if (Math.abs(info.currentFormulaResult / -600 - 1) < 1e-10) { // special tolerance
|
|
28581
|
+
* return true; // stop goal seek
|
|
28582
|
+
* }
|
|
28583
|
+
* return false; // continue
|
|
28584
|
+
* }
|
|
28585
|
+
* });
|
|
28586
|
+
* ```
|
|
28305
28587
|
*/
|
|
28306
|
-
function goalSeek(changingSheet: GC.Spread.Sheets.Worksheet, changingRow: number, changingColumn: number, formulaSheet: GC.Spread.Sheets.Worksheet, formulaRow: number, formulaColumn: number, desiredResult: number): boolean | Promise<boolean>;
|
|
28588
|
+
function goalSeek(changingSheet: GC.Spread.Sheets.Worksheet, changingRow: number, changingColumn: number, formulaSheet: GC.Spread.Sheets.Worksheet, formulaRow: number, formulaColumn: number, desiredResult: number, options?: IGoalSeekOptions): boolean | Promise<boolean>;
|
|
28307
28589
|
/**
|
|
28308
28590
|
* Converts the specified cell range to a formula string.
|
|
28309
28591
|
* @param {GC.Spread.Sheets.Range[]} ranges The cell range in the sheet.
|
|
@@ -28371,6 +28653,21 @@ declare module GC{
|
|
|
28371
28653
|
* ```
|
|
28372
28654
|
*/
|
|
28373
28655
|
function rangeToFormula(range: GC.Spread.Sheets.Range, baseRow?: number, baseCol?: number, rangeReferenceRelative?: GC.Spread.Sheets.CalcEngine.RangeReferenceRelative, useR1C1?: boolean): string;
|
|
28656
|
+
|
|
28657
|
+
export interface IGoalSeekOptions{
|
|
28658
|
+
maximumIterations: number;
|
|
28659
|
+
tolerance: number;
|
|
28660
|
+
callback: (info: IGoalSeekStepInfo) => boolean | void | Promise<boolean | void>;
|
|
28661
|
+
}
|
|
28662
|
+
|
|
28663
|
+
|
|
28664
|
+
export interface IGoalSeekStepInfo{
|
|
28665
|
+
currentIteration: number;
|
|
28666
|
+
currentValue: number;
|
|
28667
|
+
currentFormulaResult: number;
|
|
28668
|
+
succeeded: boolean;
|
|
28669
|
+
}
|
|
28670
|
+
|
|
28374
28671
|
/**
|
|
28375
28672
|
* Specifies whether the range reference is relative or absolute.
|
|
28376
28673
|
* @enum {number}
|
|
@@ -28412,7 +28709,7 @@ declare module GC{
|
|
|
28412
28709
|
|
|
28413
28710
|
}
|
|
28414
28711
|
|
|
28415
|
-
|
|
28712
|
+
namespace CellState{
|
|
28416
28713
|
|
|
28417
28714
|
export class CellStateManager{
|
|
28418
28715
|
/**
|
|
@@ -28451,7 +28748,7 @@ declare module GC{
|
|
|
28451
28748
|
}
|
|
28452
28749
|
}
|
|
28453
28750
|
|
|
28454
|
-
|
|
28751
|
+
namespace CellTypes{
|
|
28455
28752
|
|
|
28456
28753
|
export interface ICelltypeItemOption{
|
|
28457
28754
|
text: string;
|
|
@@ -28509,6 +28806,22 @@ declare module GC{
|
|
|
28509
28806
|
autoSize?: boolean;
|
|
28510
28807
|
}
|
|
28511
28808
|
|
|
28809
|
+
|
|
28810
|
+
/**
|
|
28811
|
+
* @typedef GC.Spread.Sheets.CellTypes.CheckBoxHitTestMode
|
|
28812
|
+
* @type {'cell' | 'checkbox'}
|
|
28813
|
+
*/
|
|
28814
|
+
export type CheckBoxHitTestMode =
|
|
28815
|
+
'cell' | 'checkbox'
|
|
28816
|
+
|
|
28817
|
+
|
|
28818
|
+
/**
|
|
28819
|
+
* @typedef GC.Spread.Sheets.CellTypes.CheckBoxMode
|
|
28820
|
+
* @type {'checkbox' | 'toggle' | 'modern'}
|
|
28821
|
+
*/
|
|
28822
|
+
export type CheckBoxMode =
|
|
28823
|
+
'checkbox' | 'toggle' | 'modern'
|
|
28824
|
+
|
|
28512
28825
|
/**
|
|
28513
28826
|
* Specifies the text alignment for check box cells.
|
|
28514
28827
|
* @enum {number}
|
|
@@ -29340,6 +29653,31 @@ declare module GC{
|
|
|
29340
29653
|
* ```
|
|
29341
29654
|
*/
|
|
29342
29655
|
caption(value?: string): any;
|
|
29656
|
+
/**
|
|
29657
|
+
* Gets or sets a value that indicates the hit test mode of the checkbox cell type in checkbox and modern mode.
|
|
29658
|
+
* This controls which area of the cell will respond to mouse interactions (clicks, cursor changes).
|
|
29659
|
+
* @param {GC.Spread.Sheets.CellTypes.CheckBoxHitTestMode} value The hit test mode. 'cell' means the entire cell area responds to interactions; 'checkbox' means only the checkbox area responds to interactions.
|
|
29660
|
+
* @returns {GC.Spread.Sheets.CellTypes.CheckBoxHitTestMode | GC.Spread.Sheets.CellTypes.CheckBox} If no value is set, returns the hit test mode of the checkbox cell type; otherwise, returns the checkbox cell type.
|
|
29661
|
+
* @example
|
|
29662
|
+
* ```javascript
|
|
29663
|
+
* // This example creates a check box cell with checkbox mode hit testing.
|
|
29664
|
+
* var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29665
|
+
* cellType1.textTrue("Yes");
|
|
29666
|
+
* cellType1.textFalse("No");
|
|
29667
|
+
* cellType1.hitTestMode("checkbox"); // Only the checkbox area responds to clicks
|
|
29668
|
+
* activeSheet.getCell(1, 1).cellType(cellType1);
|
|
29669
|
+
* ```
|
|
29670
|
+
* @example
|
|
29671
|
+
* ```javascript
|
|
29672
|
+
* // This example creates a check box cell with cell mode hit testing (default).
|
|
29673
|
+
* var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29674
|
+
* cellType2.textTrue("Checked");
|
|
29675
|
+
* cellType2.textFalse("Unchecked");
|
|
29676
|
+
* cellType2.hitTestMode("cell"); // The entire cell area responds to clicks
|
|
29677
|
+
* activeSheet.getCell(2, 1).cellType(cellType2);
|
|
29678
|
+
* ```
|
|
29679
|
+
*/
|
|
29680
|
+
hitTestMode(value?: GC.Spread.Sheets.CellTypes.CheckBoxHitTestMode): GC.Spread.Sheets.CellTypes.CheckBoxHitTestMode | GC.Spread.Sheets.CellTypes.CheckBox;
|
|
29343
29681
|
/**
|
|
29344
29682
|
* Gets or sets a value that indicates whether the check box supports three states.
|
|
29345
29683
|
* @param {boolean} value Whether the check box supports three states.
|
|
@@ -29361,11 +29699,11 @@ declare module GC{
|
|
|
29361
29699
|
isThreeState(value?: boolean): any;
|
|
29362
29700
|
/**
|
|
29363
29701
|
* Gets or sets a value that indicates the mode of the checkbox cell type.
|
|
29364
|
-
* @param {
|
|
29365
|
-
* @returns {
|
|
29702
|
+
* @param {GC.Spread.Sheets.CellTypes.CheckBoxMode} value The mode of the checkbox cell type. 'checkbox' is the default classic mode with square borders, 'toggle' is an animated switch button, and 'modern' is a rounded corner style with SVG rendering.
|
|
29703
|
+
* @returns {GC.Spread.Sheets.CellTypes.CheckBoxMode | GC.Spread.Sheets.CellTypes.CheckBox} If no value is set, returns the mode of the checkbox cell type.
|
|
29366
29704
|
* @example
|
|
29367
29705
|
* ```javascript
|
|
29368
|
-
* // This example creates a check box cell.
|
|
29706
|
+
* // This example creates a check box cell with toggle mode.
|
|
29369
29707
|
* var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29370
29708
|
* cellType1.caption("caption");
|
|
29371
29709
|
* cellType1.textTrue("true");
|
|
@@ -29374,8 +29712,16 @@ declare module GC{
|
|
|
29374
29712
|
* cellType1.mode("toggle");
|
|
29375
29713
|
* activeSheet.getCell(1, 1).cellType(cellType1);
|
|
29376
29714
|
* ```
|
|
29715
|
+
* @example
|
|
29716
|
+
* ```javascript
|
|
29717
|
+
* // This example creates a check box cell with modern mode.
|
|
29718
|
+
* var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29719
|
+
* cellType2.caption("Modern Checkbox");
|
|
29720
|
+
* cellType2.mode("modern");
|
|
29721
|
+
* activeSheet.getCell(2, 1).cellType(cellType2);
|
|
29722
|
+
* ```
|
|
29377
29723
|
*/
|
|
29378
|
-
mode(value?:
|
|
29724
|
+
mode(value?: GC.Spread.Sheets.CellTypes.CheckBoxMode): any;
|
|
29379
29725
|
/**
|
|
29380
29726
|
* Gets or sets the text alignment relative to the check box.
|
|
29381
29727
|
* @param {GC.Spread.Sheets.CellTypes.CheckBoxTextAlign} value The text alignment relative to the check box.
|
|
@@ -29395,6 +29741,31 @@ declare module GC{
|
|
|
29395
29741
|
* ```
|
|
29396
29742
|
*/
|
|
29397
29743
|
textAlign(value?: GC.Spread.Sheets.CellTypes.CheckBoxTextAlign): any;
|
|
29744
|
+
/**
|
|
29745
|
+
* Gets or sets a value that indicates whether the checkbox cell type allows text editing in checkbox and modern mode.
|
|
29746
|
+
* When set to false, the checkbox behaves like toggle mode and cannot enter text editing mode (double-click or F2).
|
|
29747
|
+
* @param {boolean} value Whether the checkbox text is editable. Default is true.
|
|
29748
|
+
* @returns {boolean | GC.Spread.Sheets.CellTypes.CheckBox} If no value is set, returns whether the checkbox text is editable; otherwise, returns the checkbox cell type.
|
|
29749
|
+
* @example
|
|
29750
|
+
* ```javascript
|
|
29751
|
+
* // This example creates a check box cell with non-editable text.
|
|
29752
|
+
* var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29753
|
+
* cellType1.textTrue("Yes");
|
|
29754
|
+
* cellType1.textFalse("No");
|
|
29755
|
+
* cellType1.textEditable(false); // Cannot double-click to edit text
|
|
29756
|
+
* activeSheet.getCell(1, 1).cellType(cellType1);
|
|
29757
|
+
* ```
|
|
29758
|
+
* @example
|
|
29759
|
+
* ```javascript
|
|
29760
|
+
* // This example creates a check box cell with editable text (default).
|
|
29761
|
+
* var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29762
|
+
* cellType2.textTrue("Checked");
|
|
29763
|
+
* cellType2.textFalse("Unchecked");
|
|
29764
|
+
* cellType2.textEditable(true); // Can double-click to edit text
|
|
29765
|
+
* activeSheet.getCell(2, 1).cellType(cellType2);
|
|
29766
|
+
* ```
|
|
29767
|
+
*/
|
|
29768
|
+
textEditable(value?: boolean): boolean | GC.Spread.Sheets.CellTypes.CheckBox;
|
|
29398
29769
|
/**
|
|
29399
29770
|
* Gets or sets the text in the cell when the cell's value is `false`.
|
|
29400
29771
|
* @param {string} value The text in the cell when the cell's value is `false`.
|
|
@@ -29598,18 +29969,26 @@ declare module GC{
|
|
|
29598
29969
|
maxRowCount(value?: number): any;
|
|
29599
29970
|
/**
|
|
29600
29971
|
* Gets or sets a value that indicates the mode of the checkbox list cell type.
|
|
29601
|
-
* @param {
|
|
29602
|
-
* @returns {
|
|
29972
|
+
* @param {GC.Spread.Sheets.CellTypes.CheckBoxMode} value The mode of the checkbox list cell type. 'checkbox' is the default classic mode with square borders, 'toggle' is an animated switch button, and 'modern' is a rounded corner style with SVG rendering.
|
|
29973
|
+
* @returns {GC.Spread.Sheets.CellTypes.CheckBoxMode | GC.Spread.Sheets.CellTypes.CheckBoxList} If no value is set, returns the mode of the checkbox list cell type.
|
|
29603
29974
|
* @example
|
|
29604
29975
|
* ```javascript
|
|
29605
|
-
* // This example creates a check box list cell.
|
|
29976
|
+
* // This example creates a check box list cell with toggle mode.
|
|
29606
29977
|
* var cellType = new GC.Spread.Sheets.CellTypes.CheckBoxList();
|
|
29607
29978
|
* cellType.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
|
|
29608
29979
|
* cellType.mode("toggle");
|
|
29609
29980
|
* activeSheet.getCell(2, 2).cellType(cellType);
|
|
29610
29981
|
* ```
|
|
29982
|
+
* @example
|
|
29983
|
+
* ```javascript
|
|
29984
|
+
* // This example creates a check box list cell with modern mode.
|
|
29985
|
+
* var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
|
|
29986
|
+
* cellType2.items([{text:"Option 1",value:1},{text:"Option 2",value:2}]);
|
|
29987
|
+
* cellType2.mode("modern");
|
|
29988
|
+
* activeSheet.getCell(3, 2).cellType(cellType2);
|
|
29989
|
+
* ```
|
|
29611
29990
|
*/
|
|
29612
|
-
mode(value?:
|
|
29991
|
+
mode(value?: GC.Spread.Sheets.CellTypes.CheckBoxMode): any;
|
|
29613
29992
|
/**
|
|
29614
29993
|
* Gets or sets the text of checkbox's position, only support left and right .
|
|
29615
29994
|
* @param {GC.Spread.Sheets.CellTypes.TextAlign} value the text of checkbox's position.
|
|
@@ -29807,7 +30186,20 @@ declare module GC{
|
|
|
29807
30186
|
* sheet.setCellType(1, 1, cellType1);
|
|
29808
30187
|
* ```
|
|
29809
30188
|
*/
|
|
29810
|
-
constructor();
|
|
30189
|
+
constructor(format: string);
|
|
30190
|
+
/**
|
|
30191
|
+
* Gets or sets the format string used to display the data object cell value.
|
|
30192
|
+
* @param {string} [value] The format string, that contains PROPERTY function or dot operator.
|
|
30193
|
+
* @returns {string | GC.Spread.Sheets.CellTypes.DataObject} If no value is set, returns the format string; otherwise, returns the data object cell type.
|
|
30194
|
+
* @example
|
|
30195
|
+
* ```javascript
|
|
30196
|
+
* sheet.setFormula(1, 1, '=FILTERJSON(WEBSERVICE("https://demodata.mescius.io/northwind/api/v1/Products/1"))');
|
|
30197
|
+
* var cellType1 = new GC.Spread.Sheets.CellTypes.DataObject('=@.productName & " " & @.unitPrice');
|
|
30198
|
+
* cellType1.formatString('=@.productName');
|
|
30199
|
+
* sheet.setCellType(1, 1, cellType1);
|
|
30200
|
+
* ```
|
|
30201
|
+
*/
|
|
30202
|
+
formatString(value?: string): any;
|
|
29811
30203
|
}
|
|
29812
30204
|
|
|
29813
30205
|
export class Diagonal extends Text{
|
|
@@ -30363,7 +30755,7 @@ declare module GC{
|
|
|
30363
30755
|
}
|
|
30364
30756
|
}
|
|
30365
30757
|
|
|
30366
|
-
|
|
30758
|
+
namespace Charts{
|
|
30367
30759
|
/**
|
|
30368
30760
|
* Get the specified color by colorScheme, index
|
|
30369
30761
|
* @param {GC.Spread.Sheets.Charts.ColorScheme} colorScheme The color scheme.
|
|
@@ -32660,7 +33052,7 @@ declare module GC{
|
|
|
32660
33052
|
}
|
|
32661
33053
|
}
|
|
32662
33054
|
|
|
32663
|
-
|
|
33055
|
+
namespace Collaboration{
|
|
32664
33056
|
|
|
32665
33057
|
export interface IChangeSet{
|
|
32666
33058
|
ops: GC.Spread.Sheets.Collaboration.IOpComponent[];
|
|
@@ -33002,6 +33394,42 @@ declare module GC{
|
|
|
33002
33394
|
* setSelectionPolicyAndUnit
|
|
33003
33395
|
*/
|
|
33004
33396
|
setSelectionPolicyAndUnit= 64,
|
|
33397
|
+
/**
|
|
33398
|
+
* addSheetTab
|
|
33399
|
+
*/
|
|
33400
|
+
addSheetTab= 65,
|
|
33401
|
+
/**
|
|
33402
|
+
* removeSheetTab
|
|
33403
|
+
*/
|
|
33404
|
+
removeSheetTab= 66,
|
|
33405
|
+
/**
|
|
33406
|
+
* clearSheetTabs
|
|
33407
|
+
*/
|
|
33408
|
+
clearSheetTabs= 67,
|
|
33409
|
+
/**
|
|
33410
|
+
* setSheetTabSelected
|
|
33411
|
+
*/
|
|
33412
|
+
setSheetTabSelected= 68,
|
|
33413
|
+
/**
|
|
33414
|
+
* setSheetTabName
|
|
33415
|
+
*/
|
|
33416
|
+
setSheetTabName= 69,
|
|
33417
|
+
/**
|
|
33418
|
+
* setSheetTabVisible
|
|
33419
|
+
*/
|
|
33420
|
+
setSheetTabVisible= 70,
|
|
33421
|
+
/**
|
|
33422
|
+
* addNamedCellTemplate
|
|
33423
|
+
*/
|
|
33424
|
+
addNamedCellTemplate= 71,
|
|
33425
|
+
/**
|
|
33426
|
+
* removeNamedCellTemplate
|
|
33427
|
+
*/
|
|
33428
|
+
removeNamedCellTemplate= 72,
|
|
33429
|
+
/**
|
|
33430
|
+
* clearNamedCellTemplates
|
|
33431
|
+
*/
|
|
33432
|
+
clearNamedCellTemplates= 73,
|
|
33005
33433
|
/**
|
|
33006
33434
|
* addExternalReference
|
|
33007
33435
|
*/
|
|
@@ -33146,6 +33574,10 @@ declare module GC{
|
|
|
33146
33574
|
* reorderChildShape
|
|
33147
33575
|
*/
|
|
33148
33576
|
reorderChildShape= 209,
|
|
33577
|
+
/**
|
|
33578
|
+
* updateChildShapeProp
|
|
33579
|
+
*/
|
|
33580
|
+
updateShapeCollectionOption= 210,
|
|
33149
33581
|
/**
|
|
33150
33582
|
* updateChartSeries
|
|
33151
33583
|
*/
|
|
@@ -33377,7 +33809,143 @@ declare module GC{
|
|
|
33377
33809
|
/**
|
|
33378
33810
|
* removeThreadedCommentReply
|
|
33379
33811
|
*/
|
|
33380
|
-
removeThreadedCommentReply= 415
|
|
33812
|
+
removeThreadedCommentReply= 415,
|
|
33813
|
+
/**
|
|
33814
|
+
* setRelationships
|
|
33815
|
+
*/
|
|
33816
|
+
setRelationships= 421,
|
|
33817
|
+
/**
|
|
33818
|
+
* addDataManagerTable
|
|
33819
|
+
*/
|
|
33820
|
+
addDataManagerTable= 423,
|
|
33821
|
+
/**
|
|
33822
|
+
* removeDataManagerTable
|
|
33823
|
+
*/
|
|
33824
|
+
removeDataManagerTable= 424,
|
|
33825
|
+
/**
|
|
33826
|
+
* setDataManagerTableName
|
|
33827
|
+
*/
|
|
33828
|
+
setDataManagerTableName= 425,
|
|
33829
|
+
/**
|
|
33830
|
+
* setDataManagerTableOptions
|
|
33831
|
+
*/
|
|
33832
|
+
setDataManagerTableOptions= 426,
|
|
33833
|
+
/**
|
|
33834
|
+
* setPrimaryKey
|
|
33835
|
+
*/
|
|
33836
|
+
setPrimaryKey= 427,
|
|
33837
|
+
/**
|
|
33838
|
+
* addView
|
|
33839
|
+
*/
|
|
33840
|
+
addView= 429,
|
|
33841
|
+
/**
|
|
33842
|
+
* removeView
|
|
33843
|
+
*/
|
|
33844
|
+
removeView= 430,
|
|
33845
|
+
/**
|
|
33846
|
+
* setViewsOptions
|
|
33847
|
+
*/
|
|
33848
|
+
setViewsOptions= 432,
|
|
33849
|
+
/**
|
|
33850
|
+
* setViewColumns
|
|
33851
|
+
*/
|
|
33852
|
+
setViewColumns= 434,
|
|
33853
|
+
/**
|
|
33854
|
+
* setDataManagerSortInfo
|
|
33855
|
+
*/
|
|
33856
|
+
setDataManagerSortInfo= 437,
|
|
33857
|
+
/**
|
|
33858
|
+
* setDataManagerFilterInfo
|
|
33859
|
+
*/
|
|
33860
|
+
setDataManagerFilterInfo= 438,
|
|
33861
|
+
/**
|
|
33862
|
+
* setDataManagerGroupInfo
|
|
33863
|
+
*/
|
|
33864
|
+
setDataManagerGroupInfo= 439,
|
|
33865
|
+
/**
|
|
33866
|
+
* setPinnedColumns
|
|
33867
|
+
*/
|
|
33868
|
+
setPinnedColumns= 440,
|
|
33869
|
+
/**
|
|
33870
|
+
* setPinnedRows
|
|
33871
|
+
*/
|
|
33872
|
+
setPinnedRows= 448,
|
|
33873
|
+
/**
|
|
33874
|
+
* updateLocalRecord
|
|
33875
|
+
*/
|
|
33876
|
+
updateLocalRecord= 441,
|
|
33877
|
+
/**
|
|
33878
|
+
* insertLocalRecord
|
|
33879
|
+
*/
|
|
33880
|
+
insertLocalRecord= 442,
|
|
33881
|
+
/**
|
|
33882
|
+
* removeLocalRecord
|
|
33883
|
+
*/
|
|
33884
|
+
removeLocalRecord= 443,
|
|
33885
|
+
/**
|
|
33886
|
+
* addLocalColumn
|
|
33887
|
+
*/
|
|
33888
|
+
addLocalColumn= 444,
|
|
33889
|
+
/**
|
|
33890
|
+
* removeLocalColumn
|
|
33891
|
+
*/
|
|
33892
|
+
removeLocalColumn= 445,
|
|
33893
|
+
/**
|
|
33894
|
+
* updateLocalColumn
|
|
33895
|
+
*/
|
|
33896
|
+
updateLocalColumn= 446,
|
|
33897
|
+
/**
|
|
33898
|
+
* setDataManagerTableSchema
|
|
33899
|
+
*/
|
|
33900
|
+
setDataManagerTableSchema= 447,
|
|
33901
|
+
/**
|
|
33902
|
+
* updateTableSheetDataView
|
|
33903
|
+
*/
|
|
33904
|
+
updateTableSheetDataView= 451,
|
|
33905
|
+
/**
|
|
33906
|
+
* updateTableSheetOptions
|
|
33907
|
+
*/
|
|
33908
|
+
updateTableSheetOptions= 452,
|
|
33909
|
+
/**
|
|
33910
|
+
* updateTableSheetRowActionOptions
|
|
33911
|
+
*/
|
|
33912
|
+
updateTableSheetRowActionOptions= 453,
|
|
33913
|
+
/**
|
|
33914
|
+
* updateTableSheetCurrentTheme
|
|
33915
|
+
*/
|
|
33916
|
+
updateTableSheetCurrentTheme= 454,
|
|
33917
|
+
/**
|
|
33918
|
+
* updateTableSheetDefaults
|
|
33919
|
+
*/
|
|
33920
|
+
updateTableSheetDefaults= 455,
|
|
33921
|
+
/**
|
|
33922
|
+
* updateTableSheetPrintInfo
|
|
33923
|
+
*/
|
|
33924
|
+
updateTableSheetPrintInfo= 456,
|
|
33925
|
+
/**
|
|
33926
|
+
* updateTableSheetFreeHeaderArea
|
|
33927
|
+
*/
|
|
33928
|
+
updateTableSheetFreeHeaderArea= 457,
|
|
33929
|
+
/**
|
|
33930
|
+
* setTableSheetFilterInfo
|
|
33931
|
+
*/
|
|
33932
|
+
setTableSheetFilterInfo= 458,
|
|
33933
|
+
/**
|
|
33934
|
+
* setTableSheetSortInfo
|
|
33935
|
+
*/
|
|
33936
|
+
setTableSheetSortInfo= 459,
|
|
33937
|
+
/**
|
|
33938
|
+
* setTableSheetJSON
|
|
33939
|
+
*/
|
|
33940
|
+
setTableSheetJSON= 460,
|
|
33941
|
+
/**
|
|
33942
|
+
* addRichDataImage
|
|
33943
|
+
*/
|
|
33944
|
+
addRichDataImage= 501,
|
|
33945
|
+
/**
|
|
33946
|
+
* removeRichDataImage
|
|
33947
|
+
*/
|
|
33948
|
+
removeRichDataImage= 502
|
|
33381
33949
|
}
|
|
33382
33950
|
|
|
33383
33951
|
/**
|
|
@@ -33567,7 +34135,7 @@ declare module GC{
|
|
|
33567
34135
|
}
|
|
33568
34136
|
}
|
|
33569
34137
|
|
|
33570
|
-
|
|
34138
|
+
namespace Commands{
|
|
33571
34139
|
/**
|
|
33572
34140
|
* Represents the command used to automatically resize the column in a sheet.
|
|
33573
34141
|
* @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
|
|
@@ -35545,7 +36113,7 @@ declare module GC{
|
|
|
35545
36113
|
function undoTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
|
|
35546
36114
|
}
|
|
35547
36115
|
|
|
35548
|
-
|
|
36116
|
+
namespace Comments{
|
|
35549
36117
|
/**
|
|
35550
36118
|
* Defines the comment state.
|
|
35551
36119
|
* @enum {number}
|
|
@@ -36195,7 +36763,7 @@ declare module GC{
|
|
|
36195
36763
|
}
|
|
36196
36764
|
}
|
|
36197
36765
|
|
|
36198
|
-
|
|
36766
|
+
namespace ConditionalFormatting{
|
|
36199
36767
|
|
|
36200
36768
|
export interface IIconInfo{
|
|
36201
36769
|
iconSetType:GC.Spread.Sheets.ConditionalFormatting.IconSetType;
|
|
@@ -37020,7 +37588,11 @@ declare module GC{
|
|
|
37020
37588
|
/** Specifies the column state rule.
|
|
37021
37589
|
* @type {number}
|
|
37022
37590
|
*/
|
|
37023
|
-
columnStateRule= 15
|
|
37591
|
+
columnStateRule= 15,
|
|
37592
|
+
/** Specifies the sparkline rule.
|
|
37593
|
+
* @type {number}
|
|
37594
|
+
*/
|
|
37595
|
+
sparklineRule= 16
|
|
37024
37596
|
}
|
|
37025
37597
|
|
|
37026
37598
|
/**
|
|
@@ -37818,6 +38390,51 @@ declare module GC{
|
|
|
37818
38390
|
* ```
|
|
37819
38391
|
*/
|
|
37820
38392
|
addRule(rule: GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase): GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase;
|
|
38393
|
+
/**
|
|
38394
|
+
* Adds a sparkline rule to the rule collection.
|
|
38395
|
+
* @param {GC.Spread.Sheets.Sparklines.SparklineExType} type The sparkline type name (for example, "PIESPARKLINE", "LINESPARKLINE", or a custom sparkline function name).
|
|
38396
|
+
* @param {GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[]} [options] The sparkline options. Can be either:
|
|
38397
|
+
* - An options object with named parameters (for built-in sparklines with known parameter order).
|
|
38398
|
+
* - An array of positional arguments (for custom sparklines or when explicit argument ordering is needed).
|
|
38399
|
+
* Supports special placeholders: `$CF_RANGE$` (replaced with rule ranges) and `@` (current cell value or index).
|
|
38400
|
+
* @param {GC.Spread.Sheets.Range[]} [ranges] The cell ranges where the rule is applied whose item type is GC.Spread.Sheets.Range.
|
|
38401
|
+
* @returns {GC.Spread.Sheets.ConditionalFormatting.SparklineRule} The sparkline rule added to the rule collection.
|
|
38402
|
+
* @example
|
|
38403
|
+
* ```javascript
|
|
38404
|
+
* // Example 1: Add a pie sparkline rule using options object
|
|
38405
|
+
* var ranges = [new GC.Spread.Sheets.Range(0, 0, 1, 1)];
|
|
38406
|
+
* activeSheet.setValue(1, 0, 10);
|
|
38407
|
+
* activeSheet.setValue(1, 1, 20);
|
|
38408
|
+
* activeSheet.setValue(1, 2, 30);
|
|
38409
|
+
* var options = {
|
|
38410
|
+
* value: "A2:C2",
|
|
38411
|
+
* colors: ["red", "green", "blue"]
|
|
38412
|
+
* };
|
|
38413
|
+
* activeSheet.conditionalFormats.addSparklineRule("PieSparkline", options, ranges);
|
|
38414
|
+
*
|
|
38415
|
+
* // Example 2: Add a year sparkline rule using positional array arguments
|
|
38416
|
+
* // This generates: =YEARSPARKLINE(2026, A2:B13, , , "#979797", "#f3f3f3")
|
|
38417
|
+
* var yearRanges = [new GC.Spread.Sheets.Range(0, 0, 1, 1)];
|
|
38418
|
+
* activeSheet.setArray(1, 0, [
|
|
38419
|
+
* [new Date(2026, 0, 5), 2],
|
|
38420
|
+
* [new Date(2026, 1, 14), 3],
|
|
38421
|
+
* [new Date(2026, 2, 27), 4],
|
|
38422
|
+
* [new Date(2026, 3, 10), 6],
|
|
38423
|
+
* [new Date(2026, 4, 22), 5],
|
|
38424
|
+
* [new Date(2026, 5, 18), 8],
|
|
38425
|
+
* [new Date(2026, 6, 9), 7],
|
|
38426
|
+
* [new Date(2026, 7, 25), 6],
|
|
38427
|
+
* [new Date(2026, 8, 16), 9],
|
|
38428
|
+
* [new Date(2026, 9, 28), 10],
|
|
38429
|
+
* [new Date(2026, 10, 11), 7],
|
|
38430
|
+
* [new Date(2026, 11, 20), 4]
|
|
38431
|
+
* ]);
|
|
38432
|
+
* activeSheet.conditionalFormats.addSparklineRule("YearSparkline",
|
|
38433
|
+
* [2026, 'A2:B13', undefined, undefined, '#979797', '#f3f3f3'],
|
|
38434
|
+
* yearRanges);
|
|
38435
|
+
* ```
|
|
38436
|
+
*/
|
|
38437
|
+
addSparklineRule(type: GC.Spread.Sheets.Sparklines.SparklineExType, options?: GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[], ranges?: GC.Spread.Sheets.Range[]): GC.Spread.Sheets.ConditionalFormatting.SparklineRule;
|
|
37821
38438
|
/**
|
|
37822
38439
|
* Adds the text rule to the rule collection.
|
|
37823
38440
|
* @param {GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators} comparisonOperator The comparison operator.
|
|
@@ -37845,21 +38462,22 @@ declare module GC{
|
|
|
37845
38462
|
* @param {number} rank The number of top or bottom items to apply the style to.
|
|
37846
38463
|
* @param {GC.Spread.Sheets.Style} style The style that is applied to the cell when the condition is met.
|
|
37847
38464
|
* @param {GC.Spread.Sheets.Range[]} ranges The cell ranges where the rule is applied whose item type is GC.Spread.Sheets.Range.
|
|
38465
|
+
* @param {boolean} [isPercent] Whether the rank value is number or percent.
|
|
37848
38466
|
* @returns {GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase} The top 10 rule added to the rule collection.
|
|
37849
38467
|
* @example
|
|
37850
38468
|
* ```javascript
|
|
37851
|
-
* //This example uses the addTop10Rule method.
|
|
38469
|
+
* //This example uses the addTop10Rule method to add top percent rule.
|
|
37852
38470
|
* var style = new GC.Spread.Sheets.Style();
|
|
37853
38471
|
* style.backColor = "red";
|
|
37854
38472
|
* var ranges=[new GC.Spread.Sheets.Range(0,0,10,1)];
|
|
37855
|
-
* activeSheet.conditionalFormats.addTop10Rule(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top, 2, style, ranges);
|
|
38473
|
+
* activeSheet.conditionalFormats.addTop10Rule(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top, 2, style, ranges, true);
|
|
37856
38474
|
* activeSheet.setValue(0, 0, 1);
|
|
37857
38475
|
* activeSheet.setValue(1, 0, 50);
|
|
37858
38476
|
* activeSheet.setValue(2, 0, 11);
|
|
37859
38477
|
* activeSheet.setValue(3, 0, 5);
|
|
37860
38478
|
* ```
|
|
37861
38479
|
*/
|
|
37862
|
-
addTop10Rule(type: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType, rank: number, style: GC.Spread.Sheets.Style, ranges: GC.Spread.Sheets.Range[]): GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase;
|
|
38480
|
+
addTop10Rule(type: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType, rank: number, style: GC.Spread.Sheets.Style, ranges: GC.Spread.Sheets.Range[], isPercent?: boolean): GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase;
|
|
37863
38481
|
/**
|
|
37864
38482
|
* Adds a unique rule to the rule collection.
|
|
37865
38483
|
* @param {GC.Spread.Sheets.Style} style The style that is applied to the cell when the condition is met.
|
|
@@ -38253,14 +38871,14 @@ declare module GC{
|
|
|
38253
38871
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38254
38872
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38255
38873
|
* style1.foreColor = "red";
|
|
38256
|
-
* var
|
|
38257
|
-
*
|
|
38258
|
-
*
|
|
38259
|
-
*
|
|
38260
|
-
*
|
|
38261
|
-
*
|
|
38262
|
-
*
|
|
38263
|
-
* activeSheet.conditionalFormats.addRule(
|
|
38874
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
38875
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
38876
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
38877
|
+
* topRule.rank(3);
|
|
38878
|
+
* topRule.style(style1);
|
|
38879
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
38880
|
+
* topRule.stopIfTrue(true);
|
|
38881
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
38264
38882
|
* ```
|
|
38265
38883
|
*/
|
|
38266
38884
|
ruleType(value?: GC.Spread.Sheets.ConditionalFormatting.RuleType): any;
|
|
@@ -38284,14 +38902,14 @@ declare module GC{
|
|
|
38284
38902
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38285
38903
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38286
38904
|
* style1.foreColor = "red";
|
|
38287
|
-
* var
|
|
38288
|
-
*
|
|
38289
|
-
*
|
|
38290
|
-
*
|
|
38291
|
-
*
|
|
38292
|
-
*
|
|
38293
|
-
*
|
|
38294
|
-
* activeSheet.conditionalFormats.addRule(
|
|
38905
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
38906
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
38907
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
38908
|
+
* topRule.rank(3);
|
|
38909
|
+
* topRule.style(style1);
|
|
38910
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
38911
|
+
* topRule.stopIfTrue(true);
|
|
38912
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
38295
38913
|
* ```
|
|
38296
38914
|
*/
|
|
38297
38915
|
stopIfTrue(value?: boolean): any;
|
|
@@ -38315,14 +38933,14 @@ declare module GC{
|
|
|
38315
38933
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38316
38934
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38317
38935
|
* style1.foreColor = "red";
|
|
38318
|
-
* var
|
|
38319
|
-
*
|
|
38320
|
-
*
|
|
38321
|
-
*
|
|
38322
|
-
*
|
|
38323
|
-
*
|
|
38324
|
-
*
|
|
38325
|
-
* activeSheet.conditionalFormats.addRule(
|
|
38936
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
38937
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
38938
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
38939
|
+
* topRule.rank(3);
|
|
38940
|
+
* topRule.style(style1);
|
|
38941
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
38942
|
+
* topRule.stopIfTrue(true);
|
|
38943
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
38326
38944
|
* ```
|
|
38327
38945
|
*/
|
|
38328
38946
|
style(value?: GC.Spread.Sheets.Style): any;
|
|
@@ -39104,6 +39722,7 @@ declare module GC{
|
|
|
39104
39722
|
* @param {string} formula The condition formula.
|
|
39105
39723
|
* @param {GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType} type The average condition type.
|
|
39106
39724
|
* @param {number} rank The number of top or bottom items to apply the style to.
|
|
39725
|
+
* @param {boolean} [isPercent] Whether the rank value is number or percent.
|
|
39107
39726
|
* @constructor
|
|
39108
39727
|
* @example
|
|
39109
39728
|
* ```javascript
|
|
@@ -39125,7 +39744,7 @@ declare module GC{
|
|
|
39125
39744
|
* });
|
|
39126
39745
|
* ```
|
|
39127
39746
|
*/
|
|
39128
|
-
constructor(ruleType: GC.Spread.Sheets.ConditionalFormatting.RuleType, ranges: GC.Spread.Sheets.Range[], style: GC.Spread.Sheets.Style, operator: GC.Spread.Sheets.ConditionalFormatting.LogicalOperators | GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators | GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators, value1: Object, value2: Object, text: string, formula: string, type: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType, rank: number);
|
|
39747
|
+
constructor(ruleType: GC.Spread.Sheets.ConditionalFormatting.RuleType, ranges: GC.Spread.Sheets.Range[], style: GC.Spread.Sheets.Style, operator: GC.Spread.Sheets.ConditionalFormatting.LogicalOperators | GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators | GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators, value1: Object, value2: Object, text: string, formula: string, type: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType, rank: number, isPercent?: boolean);
|
|
39129
39748
|
/**
|
|
39130
39749
|
* Creates a condition for the rule.
|
|
39131
39750
|
* @returns {GC.Spread.Sheets.ConditionalFormatting.Condition} The condition.
|
|
@@ -39165,6 +39784,28 @@ declare module GC{
|
|
|
39165
39784
|
* ```
|
|
39166
39785
|
*/
|
|
39167
39786
|
formula(formulaOrBaseRow?: string | number, baseColumn ?: number): any;
|
|
39787
|
+
/**
|
|
39788
|
+
* Gets or sets whether the rank value is number or percent.
|
|
39789
|
+
* @param {boolean} value Whether the rank value is number or percent.
|
|
39790
|
+
* @returns {boolean | GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule} If no value is set, returns whether the rank value is number or percent; otherwise, returns the number condition rule.
|
|
39791
|
+
* @example
|
|
39792
|
+
* ```javascript
|
|
39793
|
+
* //This example creates top percent rules.
|
|
39794
|
+
* activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
|
|
39795
|
+
* var style = new GC.Spread.Sheets.Style();
|
|
39796
|
+
* style.foreColor = "red";
|
|
39797
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
39798
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
39799
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
39800
|
+
* topRule.rank(30);
|
|
39801
|
+
* topRule.isPercent(true);
|
|
39802
|
+
* topRule.style(style);
|
|
39803
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
39804
|
+
* topRule.stopIfTrue(true);
|
|
39805
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
39806
|
+
* ```
|
|
39807
|
+
*/
|
|
39808
|
+
isPercent(value?: boolean): any;
|
|
39168
39809
|
/**
|
|
39169
39810
|
* Gets or sets the comparison operator.
|
|
39170
39811
|
* @param {GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators} value The comparison operator.
|
|
@@ -39185,14 +39826,14 @@ declare module GC{
|
|
|
39185
39826
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39186
39827
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39187
39828
|
* style1.foreColor = "red";
|
|
39188
|
-
* var
|
|
39189
|
-
*
|
|
39190
|
-
*
|
|
39191
|
-
*
|
|
39192
|
-
*
|
|
39193
|
-
*
|
|
39194
|
-
*
|
|
39195
|
-
* activeSheet.conditionalFormats.addRule(
|
|
39829
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
39830
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
39831
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
39832
|
+
* topRule.rank(3);
|
|
39833
|
+
* topRule.style(style1);
|
|
39834
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
39835
|
+
* topRule.stopIfTrue(true);
|
|
39836
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
39196
39837
|
* ```
|
|
39197
39838
|
*/
|
|
39198
39839
|
operator(value?: GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators): any;
|
|
@@ -39216,13 +39857,14 @@ declare module GC{
|
|
|
39216
39857
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39217
39858
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39218
39859
|
* style1.foreColor = "red";
|
|
39219
|
-
* var
|
|
39220
|
-
*
|
|
39221
|
-
*
|
|
39222
|
-
*
|
|
39223
|
-
*
|
|
39224
|
-
*
|
|
39225
|
-
*
|
|
39860
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
39861
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
39862
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
39863
|
+
* topRule.rank(3);
|
|
39864
|
+
* topRule.style(style1);
|
|
39865
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
39866
|
+
* topRule.stopIfTrue(true);
|
|
39867
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
39226
39868
|
* activeSheet.conditionalFormats.addRule(top);
|
|
39227
39869
|
* ```
|
|
39228
39870
|
*/
|
|
@@ -39300,14 +39942,14 @@ declare module GC{
|
|
|
39300
39942
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39301
39943
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39302
39944
|
* style1.foreColor = "red";
|
|
39303
|
-
* var
|
|
39304
|
-
*
|
|
39305
|
-
*
|
|
39306
|
-
*
|
|
39307
|
-
*
|
|
39308
|
-
*
|
|
39309
|
-
*
|
|
39310
|
-
* activeSheet.conditionalFormats.addRule(
|
|
39945
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
39946
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
39947
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
39948
|
+
* topRule.rank(3);
|
|
39949
|
+
* topRule.style(style1);
|
|
39950
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
39951
|
+
* topRule.stopIfTrue(true);
|
|
39952
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
39311
39953
|
* ```
|
|
39312
39954
|
*/
|
|
39313
39955
|
type(value?: GC.Spread.Sheets.ConditionalFormatting.AverageConditionType): any;
|
|
@@ -39332,14 +39974,14 @@ declare module GC{
|
|
|
39332
39974
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39333
39975
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39334
39976
|
* style1.foreColor = "red";
|
|
39335
|
-
* var
|
|
39336
|
-
*
|
|
39337
|
-
*
|
|
39338
|
-
*
|
|
39339
|
-
*
|
|
39340
|
-
*
|
|
39341
|
-
*
|
|
39342
|
-
* activeSheet.conditionalFormats.addRule(
|
|
39977
|
+
* var topRule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
|
|
39978
|
+
* topRule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
|
|
39979
|
+
* topRule.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
|
|
39980
|
+
* topRule.rank(3);
|
|
39981
|
+
* topRule.style(style1);
|
|
39982
|
+
* topRule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
39983
|
+
* topRule.stopIfTrue(true);
|
|
39984
|
+
* activeSheet.conditionalFormats.addRule(topRule);
|
|
39343
39985
|
* var formulaOfTheTopLeftCell = cell.value1();
|
|
39344
39986
|
* var formulaOfA5 = cell.value1(4, 0);
|
|
39345
39987
|
* var formulaOfA10 = cell.value1(9, 0);
|
|
@@ -39675,6 +40317,142 @@ declare module GC{
|
|
|
39675
40317
|
value: Object;
|
|
39676
40318
|
}
|
|
39677
40319
|
|
|
40320
|
+
export class SparklineRule extends ConditionRuleBase{
|
|
40321
|
+
/**
|
|
40322
|
+
* Represents a sparkline rule that renders sparkline charts in cells based on conditional formatting.
|
|
40323
|
+
* @class
|
|
40324
|
+
* @extends GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase
|
|
40325
|
+
* @param {GC.Spread.Sheets.Sparklines.SparklineExType} type The sparkline function name (e.g., 'PIESPARKLINE', 'BULLETSPARKLINE', 'HBARSPARKLINE', or a custom sparkline function name).
|
|
40326
|
+
* @param {GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[]} [sparklineOptions] The sparkline options. Can be either:
|
|
40327
|
+
* - An options object containing parameters for the sparkline formula (for built-in sparklines with known parameter order).
|
|
40328
|
+
* - An array of positional arguments (for custom sparklines or when explicit argument ordering is needed).
|
|
40329
|
+
* Supports special placeholders: `$CF_RANGE$` (replaced with rule ranges) and `@` (current cell value or index).
|
|
40330
|
+
* @param {GC.Spread.Sheets.Range[]} [ranges] The cell ranges where this rule applies.
|
|
40331
|
+
* @example
|
|
40332
|
+
* ```javascript
|
|
40333
|
+
* // Example 1: Create an HBar sparkline rule using options object
|
|
40334
|
+
* activeSheet.setArray(0, 0, [[0.2], [0.5], [0.75], [1.0], [0.6]]);
|
|
40335
|
+
* var rule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('HBARSPARKLINE', {
|
|
40336
|
+
* value: '@',
|
|
40337
|
+
* colorScheme: 'green'
|
|
40338
|
+
* }, [new GC.Spread.Sheets.Range(0, 0, 5, 1)]);
|
|
40339
|
+
* activeSheet.conditionalFormats.addRule(rule);
|
|
40340
|
+
*
|
|
40341
|
+
* // Example 2: Create a YEARSPARKLINE rule using positional array arguments
|
|
40342
|
+
* // This generates: =YEARSPARKLINE(2026, A2:B13, , , "#979797", "#f3f3f3")
|
|
40343
|
+
* // Simulate activity peaks across the year with busier summer and fall periods.
|
|
40344
|
+
* activeSheet.setArray(1, 0, [
|
|
40345
|
+
* [new Date(2026, 0, 5), 2],
|
|
40346
|
+
* [new Date(2026, 1, 14), 3],
|
|
40347
|
+
* [new Date(2026, 2, 27), 4],
|
|
40348
|
+
* [new Date(2026, 3, 10), 6],
|
|
40349
|
+
* [new Date(2026, 4, 22), 5],
|
|
40350
|
+
* [new Date(2026, 5, 18), 8],
|
|
40351
|
+
* [new Date(2026, 6, 9), 7],
|
|
40352
|
+
* [new Date(2026, 7, 25), 6],
|
|
40353
|
+
* [new Date(2026, 8, 16), 9],
|
|
40354
|
+
* [new Date(2026, 9, 28), 10],
|
|
40355
|
+
* [new Date(2026, 10, 11), 7],
|
|
40356
|
+
* [new Date(2026, 11, 20), 4]
|
|
40357
|
+
* ]);
|
|
40358
|
+
* var rule2 = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('YEARSPARKLINE',
|
|
40359
|
+
* [2026, 'A2:B13', undefined, undefined, '#979797', '#f3f3f3'],
|
|
40360
|
+
* [new GC.Spread.Sheets.Range(0, 0, 1, 1)]);
|
|
40361
|
+
* activeSheet.conditionalFormats.addRule(rule2);
|
|
40362
|
+
* ```
|
|
40363
|
+
*/
|
|
40364
|
+
constructor(type: GC.Spread.Sheets.Sparklines.SparklineExType, sparklineOptions?: GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[], ranges?: GC.Spread.Sheets.Range[]);
|
|
40365
|
+
/**
|
|
40366
|
+
* Returns the sparkline value of the rule if the cell is within the rule's ranges.
|
|
40367
|
+
* @param {Object} evaluator The evaluator (worksheet).
|
|
40368
|
+
* @param {number} baseRow The row index.
|
|
40369
|
+
* @param {number} baseColumn The column index.
|
|
40370
|
+
* @param {Object} actual The actual cell value.
|
|
40371
|
+
* @returns {any} The value object if the cell is in range; otherwise, null.
|
|
40372
|
+
* @example
|
|
40373
|
+
* ```javascript
|
|
40374
|
+
* var rule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('HBARSPARKLINE', {value: '@'}, [new GC.Spread.Sheets.Range(0, 0, 5, 1)]);
|
|
40375
|
+
* activeSheet.setArray(0, 0, [[0.2], [0.5], [0.75], [1.0], [0.6]]);
|
|
40376
|
+
* activeSheet.conditionalFormats.addRule(rule);
|
|
40377
|
+
* var result = rule.evaluate(activeSheet, 0, 0, 0.5);
|
|
40378
|
+
* console.log(result);
|
|
40379
|
+
* ```
|
|
40380
|
+
*/
|
|
40381
|
+
evaluate(evaluator: Object, baseRow: number, baseColumn: number, actual: Object): any;
|
|
40382
|
+
/**
|
|
40383
|
+
* Resets the rule to its default state.
|
|
40384
|
+
* @example
|
|
40385
|
+
* ```javascript
|
|
40386
|
+
* activeSheet.setArray(0, 0, [[0.2], [0.5], [0.75], [1.0], [0.6], [0.25], [0.35], [0.15], [0.45], [0.3]]);
|
|
40387
|
+
* var rule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('HBARSPARKLINE', {value: '@'}, [new GC.Spread.Sheets.Range(0, 0, 5, 1)]);
|
|
40388
|
+
* activeSheet.conditionalFormats.addRule(rule);
|
|
40389
|
+
* rule.reset();
|
|
40390
|
+
* rule.sparklineOptions({
|
|
40391
|
+
* value: '@',
|
|
40392
|
+
* colorScheme: 'blue'
|
|
40393
|
+
* });
|
|
40394
|
+
* rule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
40395
|
+
* activeSheet.repaint();
|
|
40396
|
+
* ```
|
|
40397
|
+
*/
|
|
40398
|
+
reset(): void;
|
|
40399
|
+
/**
|
|
40400
|
+
* Gets or sets whether to display the sparkline without cell text.
|
|
40401
|
+
* @param {boolean} value Whether to display the sparkline without cell text.
|
|
40402
|
+
* @returns {boolean | GC.Spread.Sheets.ConditionalFormatting.SparklineRule} If no value is set, returns whether the widget displays the sparkline without cell text; otherwise, returns the sparkline rule.
|
|
40403
|
+
* @example
|
|
40404
|
+
* ```javascript
|
|
40405
|
+
* //This example uses the showSparklineOnly method.
|
|
40406
|
+
* activeSheet.setValue(0, 0, 50);
|
|
40407
|
+
* activeSheet.setValue(1, 0, 75);
|
|
40408
|
+
* activeSheet.setValue(2, 0, 25);
|
|
40409
|
+
* var sparklineRule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('HBARSPARKLINE', {
|
|
40410
|
+
* value: '@',
|
|
40411
|
+
* colorScheme: 'green'
|
|
40412
|
+
* }, [new GC.Spread.Sheets.Range(0, 0, 3, 1)]);
|
|
40413
|
+
* sparklineRule.showSparklineOnly(true);
|
|
40414
|
+
* activeSheet.conditionalFormats.addRule(sparklineRule);
|
|
40415
|
+
* ```
|
|
40416
|
+
*/
|
|
40417
|
+
showSparklineOnly(value?: boolean): any;
|
|
40418
|
+
/**
|
|
40419
|
+
* Gets or sets the sparkline options.
|
|
40420
|
+
* @param {GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[]} [value] The sparkline options. Can be either:
|
|
40421
|
+
* - An options object with named parameters (for built-in sparklines with known parameter order).
|
|
40422
|
+
* - An array of positional arguments (for custom sparklines or explicit argument ordering).
|
|
40423
|
+
* Supports special placeholders: `$CF_RANGE$` (replaced with the rule's range string) and `@` (replaced with current cell value or cell index for index parameters like pointIndex).
|
|
40424
|
+
* @returns {GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[] | GC.Spread.Sheets.ConditionalFormatting.SparklineRule} If no value is set, returns the sparkline options; otherwise, returns the sparkline rule.
|
|
40425
|
+
* @example
|
|
40426
|
+
* ```javascript
|
|
40427
|
+
* // Example 1: Using options object
|
|
40428
|
+
* activeSheet.setArray(0, 0, [[0.2], [0.3], [0.5], [0.1], [0.4], [0.25], [0.35], [0.15], [0.45], [0.3]]);
|
|
40429
|
+
* var rule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('PIESPARKLINE', {
|
|
40430
|
+
* value: '@',
|
|
40431
|
+
* colors: ['red', 'green', 'blue']
|
|
40432
|
+
* }, [new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
|
|
40433
|
+
* activeSheet.conditionalFormats.addRule(rule);
|
|
40434
|
+
* console.log(rule.sparklineOptions()); // { value: '@', colors: ['red', 'green', 'blue'] }
|
|
40435
|
+
*
|
|
40436
|
+
* // Example 2: Using positional array arguments
|
|
40437
|
+
* rule.sparklineOptions(['@', 'skyblue', 'orange', 'lightgray']);
|
|
40438
|
+
* activeSheet.repaint();
|
|
40439
|
+
* ```
|
|
40440
|
+
*/
|
|
40441
|
+
sparklineOptions(value?: GC.Spread.Sheets.Sparklines.ISparklineOptions | GC.Spread.Sheets.Sparklines.SparklineParameterType[]): any;
|
|
40442
|
+
/**
|
|
40443
|
+
* Gets the sparkline function type name.
|
|
40444
|
+
* @returns {GC.Spread.Sheets.Sparklines.SparklineExType} The sparkline type name (e.g., 'PIESPARKLINE').
|
|
40445
|
+
* @example
|
|
40446
|
+
* ```javascript
|
|
40447
|
+
* activeSheet.setArray(0, 0, [[0.2], [0.5], [0.75], [1.0], [0.6]]);
|
|
40448
|
+
* var rule = new GC.Spread.Sheets.ConditionalFormatting.SparklineRule('HBARSPARKLINE', {value: '@'}, [new GC.Spread.Sheets.Range(0, 0, 5, 1)]);
|
|
40449
|
+
* activeSheet.conditionalFormats.addRule(rule);
|
|
40450
|
+
* console.log(rule.sparklineType()); // 'HBARSPARKLINE'
|
|
40451
|
+
* ```
|
|
40452
|
+
*/
|
|
40453
|
+
sparklineType(): GC.Spread.Sheets.Sparklines.SparklineExType;
|
|
40454
|
+
}
|
|
40455
|
+
|
|
39678
40456
|
export class StateRule extends GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase{
|
|
39679
40457
|
/**
|
|
39680
40458
|
* Represents a state rule.
|
|
@@ -39753,7 +40531,7 @@ declare module GC{
|
|
|
39753
40531
|
}
|
|
39754
40532
|
}
|
|
39755
40533
|
|
|
39756
|
-
|
|
40534
|
+
namespace ContextMenu{
|
|
39757
40535
|
|
|
39758
40536
|
export interface IMenuItemData{
|
|
39759
40537
|
/**
|
|
@@ -39789,7 +40567,7 @@ declare module GC{
|
|
|
39789
40567
|
*/
|
|
39790
40568
|
type?:string;
|
|
39791
40569
|
/**
|
|
39792
|
-
* Represents on which area this context menu item should be shown. Value can be a collection of conditions separated by whitespace. Include: "
|
|
40570
|
+
* Represents on which area this context menu item should be shown. Value can be a collection of conditions separated by whitespace. Include: "viewport", "rowHeader", "colHeader", "corner", "sheetTab", "outline", "slicer", "timeline", "chart", "shape", "table", "vpWithoutTb", "pivotPageFilter", "pivotTopLeft", "pivotEmptyLabel", "pivotHeader", "pivotGrandTotal", "pivotContent", "pivotTable", "GanttRowHeader", "GanttField", "GanttColumn".
|
|
39793
40571
|
*/
|
|
39794
40572
|
workArea?:string;
|
|
39795
40573
|
/**
|
|
@@ -39848,7 +40626,7 @@ declare module GC{
|
|
|
39848
40626
|
* @property {string} [group] - Represent this context menu item is a group menu item and this property's value should be it's group header's name.
|
|
39849
40627
|
* @property {Object[]} [subMenu] - Represent this context menu item has sub menu.
|
|
39850
40628
|
* @property {string} [type] - Represent a context menu's type.
|
|
39851
|
-
* @property {string} [workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "
|
|
40629
|
+
* @property {string} [workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
|
|
39852
40630
|
*/
|
|
39853
40631
|
menuData: GC.Spread.Sheets.ContextMenu.IMenuItemData[];
|
|
39854
40632
|
/**
|
|
@@ -39952,7 +40730,7 @@ declare module GC{
|
|
|
39952
40730
|
* @param {string} [menuData.group] - Represent this context menu item is a group menu item and this param's value should be it's group header's name.
|
|
39953
40731
|
* @param {Object[]} [menuData.subMenu] - Represent this context menu item has sub menu.
|
|
39954
40732
|
* @param {string} [menuData.type] - Represent a context menu's type.
|
|
39955
|
-
* @param {string} [menuData.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "
|
|
40733
|
+
* @param {string} [menuData.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
|
|
39956
40734
|
* @param {Object[]} itemsDataForShown
|
|
39957
40735
|
* @param {string} [itemsDataForShown.name] - Represent context menu item's identify.
|
|
39958
40736
|
* @param {string} [itemsDataForShown.text] - Represent the text to be shown,if this context menu item is a group,text will be shown as DOM element's title.
|
|
@@ -39962,7 +40740,7 @@ declare module GC{
|
|
|
39962
40740
|
* @param {string} [itemsDataForShown.group] - Represent this context menu item is a group menu item and this param's value should be it's group header's name.
|
|
39963
40741
|
* @param {Object[]} [itemsDataForShown.subMenu] - Represent this context menu item has sub menu.
|
|
39964
40742
|
* @param {string} [itemsDataForShown.type] - Represent a context menu's type.
|
|
39965
|
-
* @param {string} [itemsDataForShown.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "
|
|
40743
|
+
* @param {string} [itemsDataForShown.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
|
|
39966
40744
|
* @param {Object} hitInfo
|
|
39967
40745
|
* @param {Object} spread
|
|
39968
40746
|
* @return {boolean} indicate whether or not the contextmenu event has been processed done
|
|
@@ -40156,7 +40934,7 @@ declare module GC{
|
|
|
40156
40934
|
}
|
|
40157
40935
|
}
|
|
40158
40936
|
|
|
40159
|
-
|
|
40937
|
+
namespace DataCharts{
|
|
40160
40938
|
|
|
40161
40939
|
export interface IAnimationOption{
|
|
40162
40940
|
duration?: number;
|
|
@@ -40226,6 +41004,7 @@ declare module GC{
|
|
|
40226
41004
|
|
|
40227
41005
|
export interface ICategoryEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
|
|
40228
41006
|
sort?: GC.Spread.Sheets.DataCharts.ISortEncodingOption;
|
|
41007
|
+
child?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
|
|
40229
41008
|
}
|
|
40230
41009
|
|
|
40231
41010
|
|
|
@@ -40391,6 +41170,7 @@ declare module GC{
|
|
|
40391
41170
|
updateAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
|
|
40392
41171
|
funnel?: GC.Spread.Sheets.DataCharts.IFunnelOption;
|
|
40393
41172
|
waterfall?: GC.Spread.Sheets.DataCharts.IWaterfallOption;
|
|
41173
|
+
treemap?: GC.Spread.Sheets.DataCharts.ITreemapOption;
|
|
40394
41174
|
}
|
|
40395
41175
|
|
|
40396
41176
|
|
|
@@ -40414,7 +41194,7 @@ declare module GC{
|
|
|
40414
41194
|
|
|
40415
41195
|
|
|
40416
41196
|
export interface IPlotEncodingsOption{
|
|
40417
|
-
values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[];
|
|
41197
|
+
values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IRangeValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IStockValueEncodingOption[];
|
|
40418
41198
|
category?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
|
|
40419
41199
|
details?: GC.Spread.Sheets.DataCharts.IFieldBasicOption[];
|
|
40420
41200
|
color?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
@@ -40440,6 +41220,18 @@ declare module GC{
|
|
|
40440
41220
|
}
|
|
40441
41221
|
|
|
40442
41222
|
|
|
41223
|
+
export interface IRangeValueEncodingOption{
|
|
41224
|
+
vectors?: GC.Spread.Sheets.DataCharts.IRangeVectorsOption;
|
|
41225
|
+
aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
|
|
41226
|
+
}
|
|
41227
|
+
|
|
41228
|
+
|
|
41229
|
+
export interface IRangeVectorsOption{
|
|
41230
|
+
lower?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41231
|
+
upper?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41232
|
+
}
|
|
41233
|
+
|
|
41234
|
+
|
|
40443
41235
|
export interface ISortEncodingOption{
|
|
40444
41236
|
field: string;
|
|
40445
41237
|
aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
|
|
@@ -40447,6 +41239,19 @@ declare module GC{
|
|
|
40447
41239
|
}
|
|
40448
41240
|
|
|
40449
41241
|
|
|
41242
|
+
export interface IStockValueEncodingOption{
|
|
41243
|
+
vectors?: GC.Spread.Sheets.DataCharts.IStockVectorsOption;
|
|
41244
|
+
}
|
|
41245
|
+
|
|
41246
|
+
|
|
41247
|
+
export interface IStockVectorsOption{
|
|
41248
|
+
high?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41249
|
+
low?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41250
|
+
open?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41251
|
+
close?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
41252
|
+
}
|
|
41253
|
+
|
|
41254
|
+
|
|
40450
41255
|
export interface IStyleOption{
|
|
40451
41256
|
fill?: GC.Spread.Sheets.DataCharts.ColorOptions;
|
|
40452
41257
|
fillOpacity?: number;
|
|
@@ -40513,6 +41318,17 @@ declare module GC{
|
|
|
40513
41318
|
}
|
|
40514
41319
|
|
|
40515
41320
|
|
|
41321
|
+
export interface ITreemapHeaderOption{
|
|
41322
|
+
template?: string;
|
|
41323
|
+
textStyle?: GC.Spread.Sheets.DataCharts.ITextStyleOption;
|
|
41324
|
+
}
|
|
41325
|
+
|
|
41326
|
+
|
|
41327
|
+
export interface ITreemapOption{
|
|
41328
|
+
header?: GC.Spread.Sheets.DataCharts.ITreemapHeaderOption;
|
|
41329
|
+
}
|
|
41330
|
+
|
|
41331
|
+
|
|
40516
41332
|
export interface IValueEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
|
|
40517
41333
|
aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
|
|
40518
41334
|
}
|
|
@@ -41139,10 +41955,22 @@ declare module GC{
|
|
|
41139
41955
|
* spline
|
|
41140
41956
|
*/
|
|
41141
41957
|
spline= "Spline",
|
|
41958
|
+
/**
|
|
41959
|
+
* stepLeft
|
|
41960
|
+
*/
|
|
41961
|
+
stepLeft= "StepLeft",
|
|
41962
|
+
/**
|
|
41963
|
+
* stepRight
|
|
41964
|
+
*/
|
|
41965
|
+
stepRight= "StepRight",
|
|
41142
41966
|
/**
|
|
41143
41967
|
* stepCenter
|
|
41144
41968
|
*/
|
|
41145
|
-
stepCenter= "StepCenter"
|
|
41969
|
+
stepCenter= "StepCenter",
|
|
41970
|
+
/**
|
|
41971
|
+
* bezierCurve
|
|
41972
|
+
*/
|
|
41973
|
+
bezierCurve= "BezierCurve"
|
|
41146
41974
|
}
|
|
41147
41975
|
|
|
41148
41976
|
/**
|
|
@@ -41682,7 +42510,7 @@ declare module GC{
|
|
|
41682
42510
|
}
|
|
41683
42511
|
}
|
|
41684
42512
|
|
|
41685
|
-
|
|
42513
|
+
namespace DataRange{
|
|
41686
42514
|
|
|
41687
42515
|
export interface IDataProvider{
|
|
41688
42516
|
/**
|
|
@@ -41847,7 +42675,7 @@ declare module GC{
|
|
|
41847
42675
|
}
|
|
41848
42676
|
}
|
|
41849
42677
|
|
|
41850
|
-
|
|
42678
|
+
namespace DataValidation{
|
|
41851
42679
|
/**
|
|
41852
42680
|
* Creates a validator based on the data.
|
|
41853
42681
|
* @static
|
|
@@ -42616,7 +43444,7 @@ declare module GC{
|
|
|
42616
43444
|
}
|
|
42617
43445
|
}
|
|
42618
43446
|
|
|
42619
|
-
|
|
43447
|
+
namespace Fill{
|
|
42620
43448
|
|
|
42621
43449
|
export interface IFillOptions{
|
|
42622
43450
|
fillType: GC.Spread.Sheets.Fill.FillType;
|
|
@@ -42815,7 +43643,7 @@ declare module GC{
|
|
|
42815
43643
|
|
|
42816
43644
|
}
|
|
42817
43645
|
|
|
42818
|
-
|
|
43646
|
+
namespace Filter{
|
|
42819
43647
|
|
|
42820
43648
|
export interface IFilterDialogVisibleInfo{
|
|
42821
43649
|
/**
|
|
@@ -43280,7 +44108,7 @@ declare module GC{
|
|
|
43280
44108
|
}
|
|
43281
44109
|
}
|
|
43282
44110
|
|
|
43283
|
-
|
|
44111
|
+
namespace FloatingObjects{
|
|
43284
44112
|
|
|
43285
44113
|
export class FloatingObject{
|
|
43286
44114
|
/**
|
|
@@ -44137,7 +44965,7 @@ declare module GC{
|
|
|
44137
44965
|
}
|
|
44138
44966
|
}
|
|
44139
44967
|
|
|
44140
|
-
|
|
44968
|
+
namespace FormulaPanel{
|
|
44141
44969
|
/**
|
|
44142
44970
|
* Gets the FormulaEditor instance by the host element.
|
|
44143
44971
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -44193,7 +45021,7 @@ declare module GC{
|
|
|
44193
45021
|
* @param {GC.Spread.Sheets.Workbook} workbook Indicates the workbook which is attached.
|
|
44194
45022
|
* @returns void
|
|
44195
45023
|
*/
|
|
44196
|
-
attach(workbook: GC.Spread.Sheets.Workbook):
|
|
45024
|
+
attach(workbook: GC.Spread.Sheets.Workbook): void;
|
|
44197
45025
|
/**
|
|
44198
45026
|
* Gets the command manager.
|
|
44199
45027
|
* @returns {GC.Spread.Commands.CommandManager} The command manager.
|
|
@@ -44228,7 +45056,7 @@ declare module GC{
|
|
|
44228
45056
|
*/
|
|
44229
45057
|
text(value?: string): string;
|
|
44230
45058
|
}
|
|
44231
|
-
|
|
45059
|
+
namespace Commands{
|
|
44232
45060
|
/**
|
|
44233
45061
|
* Represents the command used to close hints.
|
|
44234
45062
|
* @property {function} execute - performs an execute operation.
|
|
@@ -44293,7 +45121,7 @@ declare module GC{
|
|
|
44293
45121
|
|
|
44294
45122
|
}
|
|
44295
45123
|
|
|
44296
|
-
|
|
45124
|
+
namespace FormulaTextBox{
|
|
44297
45125
|
/**
|
|
44298
45126
|
* Gets the FormulaTextBox instance by the host element.
|
|
44299
45127
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -44507,7 +45335,7 @@ declare module GC{
|
|
|
44507
45335
|
}
|
|
44508
45336
|
}
|
|
44509
45337
|
|
|
44510
|
-
|
|
45338
|
+
namespace GanttSheet{
|
|
44511
45339
|
|
|
44512
45340
|
/**
|
|
44513
45341
|
* Represents a duration in scheduling. To create a valid duration, please call project.parseDuration method.
|
|
@@ -44583,6 +45411,7 @@ declare module GC{
|
|
|
44583
45411
|
* @property {boolean} [enableGanttColumn] Whether to show the gantt column. Default is true.
|
|
44584
45412
|
* @property {boolean} [allowAddNew] - Whether to allow to add new empty row.
|
|
44585
45413
|
* @property {boolean} [sheetTabColor] - A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
|
|
45414
|
+
* @property {GC.Spread.Sheets.GanttSheet.TaskScheduleMode} [defaultMode] - the default task mode.
|
|
44586
45415
|
*/
|
|
44587
45416
|
export type IGanttSheetOptions =
|
|
44588
45417
|
{
|
|
@@ -44598,6 +45427,10 @@ declare module GC{
|
|
|
44598
45427
|
* A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
|
|
44599
45428
|
*/
|
|
44600
45429
|
sheetTabColor?: string;
|
|
45430
|
+
/**
|
|
45431
|
+
* the default task mode
|
|
45432
|
+
*/
|
|
45433
|
+
defaultMode?: GC.Spread.Sheets.GanttSheet.TaskScheduleMode;
|
|
44601
45434
|
}
|
|
44602
45435
|
|
|
44603
45436
|
|
|
@@ -44804,6 +45637,15 @@ declare module GC{
|
|
|
44804
45637
|
{ hour: number, minute: number };
|
|
44805
45638
|
|
|
44806
45639
|
|
|
45640
|
+
/**
|
|
45641
|
+
* @typedef GC.Spread.Sheets.GanttSheet.TimeScaleAutoFitMode
|
|
45642
|
+
* @type {"none" | "project"}
|
|
45643
|
+
* @description Represents the auto-fit mode for the timescale.
|
|
45644
|
+
*/
|
|
45645
|
+
export type TimeScaleAutoFitMode =
|
|
45646
|
+
"none" | "project"
|
|
45647
|
+
|
|
45648
|
+
|
|
44807
45649
|
/**
|
|
44808
45650
|
* This callback is used to format timescale labels.
|
|
44809
45651
|
* @callback GC.Spread.Sheets.GanttSheet.TimescaleLabelFormatter
|
|
@@ -45866,6 +46708,11 @@ declare module GC{
|
|
|
45866
46708
|
* @classdesc Represents the timescale of GanttChart.
|
|
45867
46709
|
*/
|
|
45868
46710
|
constructor();
|
|
46711
|
+
/**
|
|
46712
|
+
* Gets or sets the auto-fit mode of the timescale. When set to "project", the minDate and maxDate will be automatically adjusted to the project's actual date range after each schedule. The default value is "none".
|
|
46713
|
+
* @type {GC.Spread.Sheets.GanttSheet.TimeScaleAutoFitMode}
|
|
46714
|
+
*/
|
|
46715
|
+
autoFitMode: GC.Spread.Sheets.GanttSheet.TimeScaleAutoFitMode;
|
|
45869
46716
|
/**
|
|
45870
46717
|
* Gets the bottom tier of the timescale.
|
|
45871
46718
|
* @type {GC.Spread.Sheets.GanttSheet.TimescaleTier}
|
|
@@ -45878,6 +46725,11 @@ declare module GC{
|
|
|
45878
46725
|
* @readonly
|
|
45879
46726
|
*/
|
|
45880
46727
|
currentDate: Date;
|
|
46728
|
+
/**
|
|
46729
|
+
* Gets or sets the margin of the timescale. The margin extends the scrollable range before minDate and after maxDate by the specified number of minimum tier units. The default value is 0.
|
|
46730
|
+
* @type {number}
|
|
46731
|
+
*/
|
|
46732
|
+
margin: number;
|
|
45881
46733
|
/**
|
|
45882
46734
|
* Gets or sets the maximum date of the scrollable area of the timescale. The default value is 2030-1-1.
|
|
45883
46735
|
* @type {Date}
|
|
@@ -46071,7 +46923,7 @@ declare module GC{
|
|
|
46071
46923
|
}
|
|
46072
46924
|
}
|
|
46073
46925
|
|
|
46074
|
-
|
|
46926
|
+
namespace Hyperlink{
|
|
46075
46927
|
/**
|
|
46076
46928
|
* Present the way that user open the hyperlinked document. Default is blank.
|
|
46077
46929
|
* @enum {number}
|
|
@@ -46106,7 +46958,7 @@ declare module GC{
|
|
|
46106
46958
|
|
|
46107
46959
|
}
|
|
46108
46960
|
|
|
46109
|
-
|
|
46961
|
+
namespace InputMask{
|
|
46110
46962
|
/**
|
|
46111
46963
|
* Get all named patterns.
|
|
46112
46964
|
* @static
|
|
@@ -46146,7 +46998,7 @@ declare module GC{
|
|
|
46146
46998
|
|
|
46147
46999
|
}
|
|
46148
47000
|
|
|
46149
|
-
|
|
47001
|
+
namespace IO{
|
|
46150
47002
|
/**
|
|
46151
47003
|
* Gets the the values of specific reference path list from file directly.
|
|
46152
47004
|
* @static
|
|
@@ -46236,7 +47088,7 @@ declare module GC{
|
|
|
46236
47088
|
|
|
46237
47089
|
}
|
|
46238
47090
|
|
|
46239
|
-
|
|
47091
|
+
namespace NameBox{
|
|
46240
47092
|
/**
|
|
46241
47093
|
* Gets the NameBox instance by the host element.
|
|
46242
47094
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -46329,7 +47181,199 @@ declare module GC{
|
|
|
46329
47181
|
}
|
|
46330
47182
|
}
|
|
46331
47183
|
|
|
46332
|
-
|
|
47184
|
+
namespace NamedCellTemplates{
|
|
47185
|
+
|
|
47186
|
+
export interface ICellStateTemplateDefinition{
|
|
47187
|
+
state: GC.Spread.Sheets.CellStatesType;
|
|
47188
|
+
style: Object;
|
|
47189
|
+
}
|
|
47190
|
+
|
|
47191
|
+
|
|
47192
|
+
export interface ICellTemplateOptions{
|
|
47193
|
+
style?: boolean;
|
|
47194
|
+
conditionalFormat?: boolean;
|
|
47195
|
+
dataValidation?: boolean;
|
|
47196
|
+
cellState?: boolean;
|
|
47197
|
+
}
|
|
47198
|
+
|
|
47199
|
+
|
|
47200
|
+
export interface IConditionRuleTemplateDefinition{
|
|
47201
|
+
ruleType?: GC.Spread.Sheets.ConditionalFormatting.RuleType;
|
|
47202
|
+
style?: Object;
|
|
47203
|
+
operator?: GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators;
|
|
47204
|
+
text?: string;
|
|
47205
|
+
formula?: string;
|
|
47206
|
+
type?: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType;
|
|
47207
|
+
rank?: number;
|
|
47208
|
+
priority?: number;
|
|
47209
|
+
stopIfTrue?: boolean;
|
|
47210
|
+
isPercent?: boolean;
|
|
47211
|
+
value1?: any;
|
|
47212
|
+
value2?: any;
|
|
47213
|
+
iconCriteria?: any;
|
|
47214
|
+
icons?: Object;
|
|
47215
|
+
condition?: GC.Spread.Sheets.NamedCellTemplates.IConditionTemplateDefinition;
|
|
47216
|
+
}
|
|
47217
|
+
|
|
47218
|
+
|
|
47219
|
+
export interface IConditionTemplateDefinition{
|
|
47220
|
+
conType?: GC.Spread.Sheets.ConditionalFormatting.ConditionType;
|
|
47221
|
+
compareType?: GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators | GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators | GC.Spread.Sheets.ConditionalFormatting.TextCompareType | GC.Spread.Sheets.ConditionalFormatting.DateCompareType | GC.Spread.Sheets.ConditionalFormatting.LogicalOperators | GC.Spread.Sheets.ConditionalFormatting.ColorCompareType;
|
|
47222
|
+
item1?: GC.Spread.Sheets.NamedCellTemplates.IConditionTemplateDefinition;
|
|
47223
|
+
item2?: GC.Spread.Sheets.NamedCellTemplates.IConditionTemplateDefinition;
|
|
47224
|
+
ignoreBlank?: boolean;
|
|
47225
|
+
preciseCompareDate?: boolean;
|
|
47226
|
+
expected?: any;
|
|
47227
|
+
formula?: string;
|
|
47228
|
+
treatNullValueAsZero?: boolean;
|
|
47229
|
+
useWildCards?: boolean;
|
|
47230
|
+
ignoreCase?: boolean;
|
|
47231
|
+
customValueType?: GC.Spread.Sheets.ConditionalFormatting.CustomValueType;
|
|
47232
|
+
expectTypeId?: number;
|
|
47233
|
+
type?: GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType;
|
|
47234
|
+
isPercent?: boolean;
|
|
47235
|
+
integerValue?: boolean;
|
|
47236
|
+
forceValue2Text?: boolean;
|
|
47237
|
+
regex?: string;
|
|
47238
|
+
}
|
|
47239
|
+
|
|
47240
|
+
|
|
47241
|
+
export interface INamedCellTemplate{
|
|
47242
|
+
name?: string;
|
|
47243
|
+
style?: GC.Spread.Sheets.NamedCellTemplates.IStyleTemplateDefinition;
|
|
47244
|
+
conditionalFormats?: GC.Spread.Sheets.NamedCellTemplates.IConditionRuleTemplateDefinition[];
|
|
47245
|
+
cellStates?: GC.Spread.Sheets.NamedCellTemplates.ICellStateTemplateDefinition[];
|
|
47246
|
+
dataValidations?: GC.Spread.Sheets.NamedCellTemplates.IValidatorTemplateDefinition[];
|
|
47247
|
+
}
|
|
47248
|
+
|
|
47249
|
+
|
|
47250
|
+
export interface IValidatorTemplateDefinition{
|
|
47251
|
+
type?: GC.Spread.Sheets.DataValidation.CriteriaType;
|
|
47252
|
+
comparisonOperator?: GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators;
|
|
47253
|
+
errorStyle?: GC.Spread.Sheets.DataValidation.ErrorStyle;
|
|
47254
|
+
ignoreBlank?: boolean;
|
|
47255
|
+
preciseCompareDate?: boolean;
|
|
47256
|
+
inCellDropdown?: boolean;
|
|
47257
|
+
showInputMessage?: boolean;
|
|
47258
|
+
showErrorMessage?: boolean;
|
|
47259
|
+
inputTitle?: string;
|
|
47260
|
+
inputMessage?: string;
|
|
47261
|
+
errorTitle?: string;
|
|
47262
|
+
errorMessage?: string;
|
|
47263
|
+
condition?: GC.Spread.Sheets.NamedCellTemplates.IConditionTemplateDefinition;
|
|
47264
|
+
highlightStyle?: GC.Spread.Sheets.DataValidation.IHighLightStyle;
|
|
47265
|
+
}
|
|
47266
|
+
|
|
47267
|
+
|
|
47268
|
+
/**
|
|
47269
|
+
* @typedef GC.Spread.Sheets.NamedCellTemplates.IStyleTemplateDefinition
|
|
47270
|
+
* @type {Object|string}
|
|
47271
|
+
* @description Style template definition, can be a style object or style name string.
|
|
47272
|
+
*/
|
|
47273
|
+
export type IStyleTemplateDefinition =
|
|
47274
|
+
Object | string
|
|
47275
|
+
|
|
47276
|
+
|
|
47277
|
+
export class NamedCellTemplatesManager{
|
|
47278
|
+
/**
|
|
47279
|
+
* Represents a manager for named cell templates.
|
|
47280
|
+
* Stores and retrieves cell configuration templates that can be applied to cells.
|
|
47281
|
+
* @class
|
|
47282
|
+
*/
|
|
47283
|
+
constructor();
|
|
47284
|
+
/**
|
|
47285
|
+
* Add a new named template. If name exists, overwrites the old template.
|
|
47286
|
+
* @param name {string} The unique name for this template.
|
|
47287
|
+
* @param template {GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate} The template definition.
|
|
47288
|
+
* @example
|
|
47289
|
+
* ```javascript
|
|
47290
|
+
* var template = {
|
|
47291
|
+
* style: { backColor: 'red', foreColor: 'white' },
|
|
47292
|
+
* dataValidations: [{ type: 1, comparisonOperator: 6, condition: { expected: [1, 100] } }]
|
|
47293
|
+
* };
|
|
47294
|
+
* workbook.namedCellTemplates.add('myTemplate', template);
|
|
47295
|
+
* ```
|
|
47296
|
+
*/
|
|
47297
|
+
add(name: string, template: GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate): void;
|
|
47298
|
+
/**
|
|
47299
|
+
* Get all templates.
|
|
47300
|
+
* @returns {GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate[]} Array of all templates (copies).
|
|
47301
|
+
* @example
|
|
47302
|
+
* ```javascript
|
|
47303
|
+
* var templates = workbook.namedCellTemplates.all();
|
|
47304
|
+
* templates.forEach(function(template) {
|
|
47305
|
+
* console.log(template.name);
|
|
47306
|
+
* });
|
|
47307
|
+
* ```
|
|
47308
|
+
*/
|
|
47309
|
+
all(): GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate[];
|
|
47310
|
+
/**
|
|
47311
|
+
* Clear all templates.
|
|
47312
|
+
* @example
|
|
47313
|
+
* ```javascript
|
|
47314
|
+
* workbook.namedCellTemplates.clear();
|
|
47315
|
+
* ```
|
|
47316
|
+
*/
|
|
47317
|
+
clear(): void;
|
|
47318
|
+
/**
|
|
47319
|
+
* Create a template from an existing cell's configuration.
|
|
47320
|
+
* @param name {string} The unique name for this template.
|
|
47321
|
+
* @param sheet {GC.Spread.Sheets.Worksheet} The worksheet containing the cell.
|
|
47322
|
+
* @param row {number} The row index of the cell.
|
|
47323
|
+
* @param col {number} The column index of the cell.
|
|
47324
|
+
* @param [templateOptions] {GC.Spread.Sheets.NamedCellTemplates.ICellTemplateOptions} Options to specify which properties to include (default all true).
|
|
47325
|
+
* @example
|
|
47326
|
+
* ```javascript
|
|
47327
|
+
* var sheet = spread.getActiveSheet();
|
|
47328
|
+
* // Create a template from cell A1 with all properties
|
|
47329
|
+
* workbook.namedCellTemplates.createFromCell('cellTemplate', sheet, 0, 0);
|
|
47330
|
+
* // Create a template from cell B2 with only style
|
|
47331
|
+
* workbook.namedCellTemplates.createFromCell('styleOnly', sheet, 1, 1, { style: true, conditionalFormat: false, dataValidation: false, cellState: false });
|
|
47332
|
+
* ```
|
|
47333
|
+
*/
|
|
47334
|
+
createFromCell(name: string, sheet: GC.Spread.Sheets.Worksheet, row: number, col: number, templateOptions?: GC.Spread.Sheets.NamedCellTemplates.ICellTemplateOptions): void;
|
|
47335
|
+
/**
|
|
47336
|
+
* Get a template by name. Returns a copy of the template.
|
|
47337
|
+
* @param name {string} The name of the template to retrieve.
|
|
47338
|
+
* @returns {GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate | null} The template or null if not found.
|
|
47339
|
+
* @example
|
|
47340
|
+
* ```javascript
|
|
47341
|
+
* var template = workbook.namedCellTemplates.get('myTemplate');
|
|
47342
|
+
* if (template) {
|
|
47343
|
+
* console.log(template.style);
|
|
47344
|
+
* }
|
|
47345
|
+
* ```
|
|
47346
|
+
*/
|
|
47347
|
+
get(name: string): GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate | null;
|
|
47348
|
+
/**
|
|
47349
|
+
* Check whether a template with the given name exists.
|
|
47350
|
+
* @param name {string} The name of the template to check.
|
|
47351
|
+
* @returns {boolean} True if the template exists, false otherwise.
|
|
47352
|
+
* @example
|
|
47353
|
+
* ```javascript
|
|
47354
|
+
* if (workbook.namedCellTemplates.has('myTemplate')) {
|
|
47355
|
+
* console.log('Template exists');
|
|
47356
|
+
* }
|
|
47357
|
+
* ```
|
|
47358
|
+
*/
|
|
47359
|
+
has(name: string): boolean;
|
|
47360
|
+
/**
|
|
47361
|
+
* Remove a template by name.
|
|
47362
|
+
* @param name {string} The name of the template to remove.
|
|
47363
|
+
* @returns {GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate | null} The removed template or null if not found.
|
|
47364
|
+
* @example
|
|
47365
|
+
* ```javascript
|
|
47366
|
+
* var removedTemplate = workbook.namedCellTemplates.remove('myTemplate');
|
|
47367
|
+
* if (removedTemplate) {
|
|
47368
|
+
* console.log('Template removed:', removedTemplate.name);
|
|
47369
|
+
* }
|
|
47370
|
+
* ```
|
|
47371
|
+
*/
|
|
47372
|
+
remove(name: string): GC.Spread.Sheets.NamedCellTemplates.INamedCellTemplate | null;
|
|
47373
|
+
}
|
|
47374
|
+
}
|
|
47375
|
+
|
|
47376
|
+
namespace OutlineColumn{
|
|
46333
47377
|
|
|
46334
47378
|
export interface IOutlineColumnOptions{
|
|
46335
47379
|
/**
|
|
@@ -46668,7 +47712,7 @@ declare module GC{
|
|
|
46668
47712
|
}
|
|
46669
47713
|
}
|
|
46670
47714
|
|
|
46671
|
-
|
|
47715
|
+
namespace Outlines{
|
|
46672
47716
|
/**
|
|
46673
47717
|
* Specifies the status of an outline (range group) summary row or column position.
|
|
46674
47718
|
* @enum {number}
|
|
@@ -47102,7 +48146,7 @@ declare module GC{
|
|
|
47102
48146
|
}
|
|
47103
48147
|
}
|
|
47104
48148
|
|
|
47105
|
-
|
|
48149
|
+
namespace PDF{
|
|
47106
48150
|
|
|
47107
48151
|
export class PDFFontsManager{
|
|
47108
48152
|
/**
|
|
@@ -47151,7 +48195,7 @@ declare module GC{
|
|
|
47151
48195
|
}
|
|
47152
48196
|
}
|
|
47153
48197
|
|
|
47154
|
-
|
|
48198
|
+
namespace Print{
|
|
47155
48199
|
|
|
47156
48200
|
export interface IPageCustomHeaderFooterOptions{
|
|
47157
48201
|
normal?: GC.Spread.Sheets.Print.IPageHeaderFooterOptions;
|
|
@@ -48476,7 +49520,7 @@ declare module GC{
|
|
|
48476
49520
|
}
|
|
48477
49521
|
}
|
|
48478
49522
|
|
|
48479
|
-
|
|
49523
|
+
namespace Search{
|
|
48480
49524
|
/**
|
|
48481
49525
|
* Specifies the type of search flags.
|
|
48482
49526
|
* @enum {number}
|
|
@@ -48976,7 +50020,7 @@ declare module GC{
|
|
|
48976
50020
|
}
|
|
48977
50021
|
}
|
|
48978
50022
|
|
|
48979
|
-
|
|
50023
|
+
namespace Shapes{
|
|
48980
50024
|
|
|
48981
50025
|
export interface IBoundingRect{
|
|
48982
50026
|
left: number;
|
|
@@ -50274,7 +51318,11 @@ declare module GC{
|
|
|
50274
51318
|
/**
|
|
50275
51319
|
* Specifies an elbow connector.
|
|
50276
51320
|
*/
|
|
50277
|
-
elbow= 1
|
|
51321
|
+
elbow= 1,
|
|
51322
|
+
/**
|
|
51323
|
+
* Specifies a curve connector.
|
|
51324
|
+
*/
|
|
51325
|
+
curve= 2
|
|
50278
51326
|
}
|
|
50279
51327
|
|
|
50280
51328
|
/**
|
|
@@ -52160,7 +53208,7 @@ declare module GC{
|
|
|
52160
53208
|
}
|
|
52161
53209
|
}
|
|
52162
53210
|
|
|
52163
|
-
|
|
53211
|
+
namespace Slicers{
|
|
52164
53212
|
|
|
52165
53213
|
export interface ISlicer{
|
|
52166
53214
|
style: (style?: string | SlicerStyle, shouldCallback?: boolean) => SlicerStyle | ISlicer;
|
|
@@ -57026,7 +58074,235 @@ declare module GC{
|
|
|
57026
58074
|
}
|
|
57027
58075
|
}
|
|
57028
58076
|
|
|
57029
|
-
|
|
58077
|
+
namespace Sparklines{
|
|
58078
|
+
|
|
58079
|
+
export interface IAreaSparklineOptions{
|
|
58080
|
+
points: string | number[];
|
|
58081
|
+
mini?: number;
|
|
58082
|
+
maxi?: number;
|
|
58083
|
+
line1?: number;
|
|
58084
|
+
line2?: number;
|
|
58085
|
+
colorPositive?: string;
|
|
58086
|
+
colorNegative?: string;
|
|
58087
|
+
}
|
|
58088
|
+
|
|
58089
|
+
|
|
58090
|
+
export interface IBoxPlotSparklineOptions{
|
|
58091
|
+
points: string | number[];
|
|
58092
|
+
boxPlotClass?: '5ns' | '7ns' | 'tukey' | 'bowley' | 'sigma3';
|
|
58093
|
+
showAverage?: boolean;
|
|
58094
|
+
scaleStart?: string | number;
|
|
58095
|
+
scaleEnd?: string | number;
|
|
58096
|
+
acceptableStart?: string | number;
|
|
58097
|
+
acceptableEnd?: string | number;
|
|
58098
|
+
colorScheme?: string;
|
|
58099
|
+
style?: 0 | 1;
|
|
58100
|
+
vertical?: boolean;
|
|
58101
|
+
}
|
|
58102
|
+
|
|
58103
|
+
|
|
58104
|
+
export interface IBulletSparklineOptions{
|
|
58105
|
+
measure: string | number;
|
|
58106
|
+
target: string | number;
|
|
58107
|
+
maxi: string | number;
|
|
58108
|
+
good?: string | number;
|
|
58109
|
+
bad?: string | number;
|
|
58110
|
+
forecast?: string | number;
|
|
58111
|
+
tickUnit?: string | number;
|
|
58112
|
+
colorScheme?: string;
|
|
58113
|
+
vertical?: boolean;
|
|
58114
|
+
measureColor?: string;
|
|
58115
|
+
targetColor?: string;
|
|
58116
|
+
maxiColor?: string;
|
|
58117
|
+
goodColor?: string;
|
|
58118
|
+
badColor?: string;
|
|
58119
|
+
forecastColor?: string;
|
|
58120
|
+
allowMeasureOverMaxi?: boolean;
|
|
58121
|
+
barSize?: number;
|
|
58122
|
+
}
|
|
58123
|
+
|
|
58124
|
+
|
|
58125
|
+
export interface ICascadeSparklineOptions{
|
|
58126
|
+
pointsRange: string | number[];
|
|
58127
|
+
pointIndex?: string | number;
|
|
58128
|
+
labelsRange?: string | string[];
|
|
58129
|
+
minimum?: string | number;
|
|
58130
|
+
maximum?: string | number;
|
|
58131
|
+
colorPositive?: string;
|
|
58132
|
+
colorNegative?: string;
|
|
58133
|
+
vertical?: boolean;
|
|
58134
|
+
itemTypeRange?: string | string[];
|
|
58135
|
+
colorTotal?: string;
|
|
58136
|
+
}
|
|
58137
|
+
|
|
58138
|
+
|
|
58139
|
+
export interface IColumnSparklineOptions{
|
|
58140
|
+
data: string | number[];
|
|
58141
|
+
dataOrientation: number;
|
|
58142
|
+
dateAxisData?: string | number[];
|
|
58143
|
+
dateAxisOrientation?: number;
|
|
58144
|
+
setting?: GC.Spread.Sheets.Sparklines.ISparklineSetting;
|
|
58145
|
+
}
|
|
58146
|
+
|
|
58147
|
+
|
|
58148
|
+
export interface IGaugeKPIRange{
|
|
58149
|
+
start: number;
|
|
58150
|
+
end: number;
|
|
58151
|
+
color: string;
|
|
58152
|
+
}
|
|
58153
|
+
|
|
58154
|
+
|
|
58155
|
+
export interface IGaugeKPISparklineOptions{
|
|
58156
|
+
targetValue: string | number;
|
|
58157
|
+
currentValue: string | number;
|
|
58158
|
+
minValue: string | number;
|
|
58159
|
+
maxValue: string | number;
|
|
58160
|
+
showLabel?: boolean;
|
|
58161
|
+
targetValueLabel?: string;
|
|
58162
|
+
currentValueLabel?: string;
|
|
58163
|
+
minValueLabel?: string;
|
|
58164
|
+
maxValueLabel?: string;
|
|
58165
|
+
fontArray?: string[];
|
|
58166
|
+
minAngle?: number;
|
|
58167
|
+
maxAngle?: number;
|
|
58168
|
+
radiusRatio?: number;
|
|
58169
|
+
gaugeType?: 0 | 1 | 2;
|
|
58170
|
+
colorRange?: IGaugeKPIRange[];
|
|
58171
|
+
}
|
|
58172
|
+
|
|
58173
|
+
|
|
58174
|
+
export interface IHBarSparklineOptions{
|
|
58175
|
+
value: string | number;
|
|
58176
|
+
colorScheme?: string;
|
|
58177
|
+
axisVisible?: boolean;
|
|
58178
|
+
barHeight?: number;
|
|
58179
|
+
}
|
|
58180
|
+
|
|
58181
|
+
|
|
58182
|
+
export interface IHistogramSparklineOptions{
|
|
58183
|
+
dataRange: string;
|
|
58184
|
+
continuous?: boolean;
|
|
58185
|
+
paintLabel?: boolean;
|
|
58186
|
+
scale?: number;
|
|
58187
|
+
barWidth?: number;
|
|
58188
|
+
barColor?: string;
|
|
58189
|
+
labelFontStyle?: string;
|
|
58190
|
+
labelColor?: string;
|
|
58191
|
+
edgeColor?: string;
|
|
58192
|
+
}
|
|
58193
|
+
|
|
58194
|
+
|
|
58195
|
+
export interface IImageSparklineOptions{
|
|
58196
|
+
source: string;
|
|
58197
|
+
alt_text?: string;
|
|
58198
|
+
sizing?: 0 | 1 | 2 | 3;
|
|
58199
|
+
height?: number;
|
|
58200
|
+
width?: number;
|
|
58201
|
+
clipY?: number;
|
|
58202
|
+
clipX?: number;
|
|
58203
|
+
clipHeight?: number;
|
|
58204
|
+
clipWidth?: number;
|
|
58205
|
+
vAlign?: 0 | 1 | 2;
|
|
58206
|
+
hAlign?: 0 | 1 | 2;
|
|
58207
|
+
}
|
|
58208
|
+
|
|
58209
|
+
|
|
58210
|
+
export interface ILineSparklineOptions{
|
|
58211
|
+
data: string | number[];
|
|
58212
|
+
dataOrientation: GC.Spread.Sheets.Sparklines.DataOrientation;
|
|
58213
|
+
dateAxisData?: string | number[];
|
|
58214
|
+
dateAxisOrientation?: GC.Spread.Sheets.Sparklines.DataOrientation;
|
|
58215
|
+
setting?: GC.Spread.Sheets.Sparklines.ISparklineSetting;
|
|
58216
|
+
}
|
|
58217
|
+
|
|
58218
|
+
|
|
58219
|
+
export interface ILollipopVariSparklineOptions{
|
|
58220
|
+
plannedValue: string | number[];
|
|
58221
|
+
actualValue: string | number[];
|
|
58222
|
+
index: number | string;
|
|
58223
|
+
absolute?: boolean;
|
|
58224
|
+
reference?: string | number;
|
|
58225
|
+
mini?: string | number;
|
|
58226
|
+
maxi?: string | number;
|
|
58227
|
+
tickUnit?: string | number;
|
|
58228
|
+
legend?: boolean;
|
|
58229
|
+
colorPositive?: string;
|
|
58230
|
+
colorNegative?: string;
|
|
58231
|
+
lollipopHeaderColor?: string;
|
|
58232
|
+
vertical?: boolean;
|
|
58233
|
+
}
|
|
58234
|
+
|
|
58235
|
+
|
|
58236
|
+
export interface IMonthSparklineOptions{
|
|
58237
|
+
year: number;
|
|
58238
|
+
month: number;
|
|
58239
|
+
dataRange: string;
|
|
58240
|
+
emptyColor?: string;
|
|
58241
|
+
startColor?: string;
|
|
58242
|
+
middleColor?: string;
|
|
58243
|
+
endColor?: string;
|
|
58244
|
+
colorRange?: string;
|
|
58245
|
+
}
|
|
58246
|
+
|
|
58247
|
+
|
|
58248
|
+
export interface IParetoSparklineOptions{
|
|
58249
|
+
points: string | number[];
|
|
58250
|
+
pointIndex: string | number;
|
|
58251
|
+
colorRange?: string | string[];
|
|
58252
|
+
target?: string | number;
|
|
58253
|
+
target2?: string | number;
|
|
58254
|
+
highlightPosition?: string | number;
|
|
58255
|
+
label?: 0 | 1 | 2;
|
|
58256
|
+
vertical?: boolean;
|
|
58257
|
+
targetColor?: string;
|
|
58258
|
+
target2Color?: string;
|
|
58259
|
+
labelColor?: string;
|
|
58260
|
+
barSize?: number;
|
|
58261
|
+
}
|
|
58262
|
+
|
|
58263
|
+
|
|
58264
|
+
export interface IPieSparklineOptions{
|
|
58265
|
+
value: string | number | number[];
|
|
58266
|
+
colors?: string[];
|
|
58267
|
+
}
|
|
58268
|
+
|
|
58269
|
+
|
|
58270
|
+
export interface IProgressSparklineOptions{
|
|
58271
|
+
value: string | number;
|
|
58272
|
+
mode: string | number;
|
|
58273
|
+
barColor?: string;
|
|
58274
|
+
bandColor?: string;
|
|
58275
|
+
showValue?: boolean;
|
|
58276
|
+
}
|
|
58277
|
+
|
|
58278
|
+
|
|
58279
|
+
export interface IRangeBlockSparklineOptions{
|
|
58280
|
+
template_range: string;
|
|
58281
|
+
data_expression: object;
|
|
58282
|
+
}
|
|
58283
|
+
|
|
58284
|
+
|
|
58285
|
+
export interface IScatterSparklineOptions{
|
|
58286
|
+
points1: string | number[];
|
|
58287
|
+
points2: string | number[];
|
|
58288
|
+
minX?: number;
|
|
58289
|
+
maxX?: number;
|
|
58290
|
+
minY?: number;
|
|
58291
|
+
maxY?: number;
|
|
58292
|
+
hLine?: number;
|
|
58293
|
+
vLine?: number;
|
|
58294
|
+
xMinZone?: number;
|
|
58295
|
+
xMaxZone?: number;
|
|
58296
|
+
yMinZone?: number;
|
|
58297
|
+
yMaxZone?: number;
|
|
58298
|
+
tags?: string;
|
|
58299
|
+
drawSymbol?: boolean;
|
|
58300
|
+
drawLines?: boolean;
|
|
58301
|
+
color1?: string;
|
|
58302
|
+
color2?: string;
|
|
58303
|
+
dash?: boolean;
|
|
58304
|
+
}
|
|
58305
|
+
|
|
57030
58306
|
|
|
57031
58307
|
export interface ISparklineSetting{
|
|
57032
58308
|
/**
|
|
@@ -57131,6 +58407,100 @@ declare module GC{
|
|
|
57131
58407
|
lineWeight?: number;
|
|
57132
58408
|
}
|
|
57133
58409
|
|
|
58410
|
+
|
|
58411
|
+
export interface ISpreadSparklineOptions{
|
|
58412
|
+
points: string | number[];
|
|
58413
|
+
showAverage?: boolean;
|
|
58414
|
+
scaleStart?: number;
|
|
58415
|
+
scaleEnd?: number;
|
|
58416
|
+
style?: 1 | 2 | 3 | 4 | 5 | 6;
|
|
58417
|
+
colorScheme?: string;
|
|
58418
|
+
vertical?: boolean;
|
|
58419
|
+
}
|
|
58420
|
+
|
|
58421
|
+
|
|
58422
|
+
export interface IStackedSparklineOptions{
|
|
58423
|
+
points: string | number[];
|
|
58424
|
+
colorRange?: string | string[];
|
|
58425
|
+
labelRange?: string | string[];
|
|
58426
|
+
maximum?: number;
|
|
58427
|
+
targetRed?: number;
|
|
58428
|
+
targetGreen?: number;
|
|
58429
|
+
targetBlue?: number;
|
|
58430
|
+
targetYellow?: number;
|
|
58431
|
+
color?: string;
|
|
58432
|
+
highlightPosition?: number;
|
|
58433
|
+
vertical?: boolean;
|
|
58434
|
+
textOrientation?: 0 | 1;
|
|
58435
|
+
textSize?: number;
|
|
58436
|
+
}
|
|
58437
|
+
|
|
58438
|
+
|
|
58439
|
+
export interface IVariSparklineOptions{
|
|
58440
|
+
variance: string | number;
|
|
58441
|
+
reference?: string | number;
|
|
58442
|
+
mini?: string | number;
|
|
58443
|
+
maxi?: string | number;
|
|
58444
|
+
mark?: string | number;
|
|
58445
|
+
tickUnit?: string | number;
|
|
58446
|
+
legend?: boolean;
|
|
58447
|
+
colorPositive?: string;
|
|
58448
|
+
colorNegative?: string;
|
|
58449
|
+
vertical?: boolean;
|
|
58450
|
+
}
|
|
58451
|
+
|
|
58452
|
+
|
|
58453
|
+
export interface IVBarSparklineOptions{
|
|
58454
|
+
value: string | number;
|
|
58455
|
+
colorScheme?: string;
|
|
58456
|
+
axisVisible?: boolean;
|
|
58457
|
+
barWidth?: number;
|
|
58458
|
+
}
|
|
58459
|
+
|
|
58460
|
+
|
|
58461
|
+
export interface IWinLossSparklineOptions{
|
|
58462
|
+
data: string | number[];
|
|
58463
|
+
dataOrientation: number;
|
|
58464
|
+
dateAxisData?: string | number[];
|
|
58465
|
+
dateAxisOrientation?: number;
|
|
58466
|
+
setting?: GC.Spread.Sheets.Sparklines.ISparklineSetting;
|
|
58467
|
+
}
|
|
58468
|
+
|
|
58469
|
+
|
|
58470
|
+
export interface IYearSparklineOptions{
|
|
58471
|
+
year: number;
|
|
58472
|
+
dataRange: string;
|
|
58473
|
+
emptyColor?: string;
|
|
58474
|
+
startColor?: string;
|
|
58475
|
+
middleColor?: string;
|
|
58476
|
+
endColor?: string;
|
|
58477
|
+
colorRange?: string;
|
|
58478
|
+
}
|
|
58479
|
+
|
|
58480
|
+
|
|
58481
|
+
/**
|
|
58482
|
+
* @typedef GC.Spread.Sheets.Sparklines.ISparklineOptions
|
|
58483
|
+
* @type {IPieSparklineOptions|IAreaSparklineOptions|IScatterSparklineOptions|IBulletSparklineOptions|ISpreadSparklineOptions|IStackedSparklineOptions|IHBarSparklineOptions|IVBarSparklineOptions|IVariSparklineOptions|ILollipopVariSparklineOptions|IBoxPlotSparklineOptions|ICascadeSparklineOptions|IParetoSparklineOptions|IMonthSparklineOptions|IYearSparklineOptions|ILineSparklineOptions|IColumnSparklineOptions|IWinLossSparklineOptions|IRangeBlockSparklineOptions|IGaugeKPISparklineOptions|IHistogramSparklineOptions|IProgressSparklineOptions|IImageSparklineOptions}
|
|
58484
|
+
*/
|
|
58485
|
+
export type ISparklineOptions =
|
|
58486
|
+
IPieSparklineOptions | IAreaSparklineOptions | IScatterSparklineOptions | IBulletSparklineOptions | ISpreadSparklineOptions | IStackedSparklineOptions | IHBarSparklineOptions | IVBarSparklineOptions | IVariSparklineOptions | ILollipopVariSparklineOptions | IBoxPlotSparklineOptions | ICascadeSparklineOptions | IParetoSparklineOptions | IMonthSparklineOptions | IYearSparklineOptions | ILineSparklineOptions | IColumnSparklineOptions | IWinLossSparklineOptions | IRangeBlockSparklineOptions | IGaugeKPISparklineOptions | IHistogramSparklineOptions | IProgressSparklineOptions | IImageSparklineOptions
|
|
58487
|
+
|
|
58488
|
+
|
|
58489
|
+
/**
|
|
58490
|
+
* @typedef GC.Spread.Sheets.Sparklines.SparklineExType
|
|
58491
|
+
* @type {"PIESPARKLINE"|"AREASPARKLINE"|"SCATTERSPARKLINE"|"BULLETSPARKLINE"|"SPREADSPARKLINE"|"STACKEDSPARKLINE"|"HBARSPARKLINE"|"VBARSPARKLINE"|"VARISPARKLINE"|"LOLLIPOPVARISPARKLINE"|"BOXPLOTSPARKLINE"|"CASCADESPARKLINE"|"PARETOSPARKLINE"|"MONTHSPARKLINE"|"YEARSPARKLINE"|"LINESPARKLINE"|"COLUMNSPARKLINE"|"WINLOSSSPARKLINE"|"RANGEBLOCKSPARKLINE"|"GAUGEKPISPARKLINE"|"HISTOGRAMSPARKLINE"|"IMAGE"|(string & {})}
|
|
58492
|
+
*/
|
|
58493
|
+
export type SparklineExType =
|
|
58494
|
+
"PIESPARKLINE" | "AREASPARKLINE" | "SCATTERSPARKLINE" | "BULLETSPARKLINE" | "SPREADSPARKLINE" | "STACKEDSPARKLINE" | "HBARSPARKLINE" | "VBARSPARKLINE" | "VARISPARKLINE" | "LOLLIPOPVARISPARKLINE" | "BOXPLOTSPARKLINE" | "CASCADESPARKLINE" | "PARETOSPARKLINE" | "MONTHSPARKLINE" | "YEARSPARKLINE" | "LINESPARKLINE" | "COLUMNSPARKLINE" | "WINLOSSSPARKLINE" | "RANGEBLOCKSPARKLINE" | "GAUGEKPISPARKLINE" | "HISTOGRAMSPARKLINE" | "IMAGE" | (string & {})
|
|
58495
|
+
|
|
58496
|
+
|
|
58497
|
+
/**
|
|
58498
|
+
* @typedef GC.Spread.Sheets.Sparklines.SparklineParameterType
|
|
58499
|
+
* @type {string|number|boolean|string[]|number[]|IGaugeKPIRange[]|Record<string, any>|SparklineSetting|undefined}
|
|
58500
|
+
*/
|
|
58501
|
+
export type SparklineParameterType =
|
|
58502
|
+
string | number | boolean | string[] | number[] | IGaugeKPIRange[] | Record<string, any> | SparklineSetting | undefined
|
|
58503
|
+
|
|
57134
58504
|
/**
|
|
57135
58505
|
* Represents the orientation of the range.
|
|
57136
58506
|
* @enum {number}
|
|
@@ -57424,6 +58794,15 @@ declare module GC{
|
|
|
57424
58794
|
constructor();
|
|
57425
58795
|
}
|
|
57426
58796
|
|
|
58797
|
+
export class ProgressSparkline extends SparklineEx{
|
|
58798
|
+
/**
|
|
58799
|
+
* Represents the class for the progress sparkline.
|
|
58800
|
+
* @extends GC.Spread.Sheets.Sparklines.SparklineEx
|
|
58801
|
+
* @class
|
|
58802
|
+
*/
|
|
58803
|
+
constructor();
|
|
58804
|
+
}
|
|
58805
|
+
|
|
57427
58806
|
export class RangeBlockSparkline extends SparklineEx{
|
|
57428
58807
|
/**
|
|
57429
58808
|
* Represents the class for the range block sparkline.
|
|
@@ -58132,7 +59511,7 @@ declare module GC{
|
|
|
58132
59511
|
}
|
|
58133
59512
|
}
|
|
58134
59513
|
|
|
58135
|
-
|
|
59514
|
+
namespace StatusBar{
|
|
58136
59515
|
/**
|
|
58137
59516
|
* Gets the StatusBar instance by the host element.
|
|
58138
59517
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -58379,7 +59758,7 @@ declare module GC{
|
|
|
58379
59758
|
*/
|
|
58380
59759
|
onUpdate(content?: string): void;
|
|
58381
59760
|
}
|
|
58382
|
-
|
|
59761
|
+
namespace StatusItem{
|
|
58383
59762
|
|
|
58384
59763
|
export interface IStatusItemOptions{
|
|
58385
59764
|
/**
|
|
@@ -58421,7 +59800,7 @@ declare module GC{
|
|
|
58421
59800
|
|
|
58422
59801
|
}
|
|
58423
59802
|
|
|
58424
|
-
|
|
59803
|
+
namespace Tables{
|
|
58425
59804
|
|
|
58426
59805
|
export interface IRowState{
|
|
58427
59806
|
row: number;
|
|
@@ -61074,7 +62453,7 @@ declare module GC{
|
|
|
61074
62453
|
}
|
|
61075
62454
|
}
|
|
61076
62455
|
|
|
61077
|
-
|
|
62456
|
+
namespace TableSheet{
|
|
61078
62457
|
|
|
61079
62458
|
export interface IAlternatingRowOptions{
|
|
61080
62459
|
/**
|
|
@@ -61151,7 +62530,7 @@ declare module GC{
|
|
|
61151
62530
|
* the column header style
|
|
61152
62531
|
*/
|
|
61153
62532
|
headerStyle?: GC.Data.HeaderStyleOptions;
|
|
61154
|
-
conditionalFormats?: (GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[];
|
|
62533
|
+
conditionalFormats?: (GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions | GC.Data.SparklineRuleOptions)[];
|
|
61155
62534
|
validator?: GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions;
|
|
61156
62535
|
/**
|
|
61157
62536
|
* the header fit mode, default is normal
|
|
@@ -61169,6 +62548,14 @@ declare module GC{
|
|
|
61169
62548
|
* Whether show filter by list after opening filer dialog. If allowSort, allowFilterByValue and allowFilterByList are all false, not show the filter button in this column.
|
|
61170
62549
|
*/
|
|
61171
62550
|
allowFilterByList?: boolean;
|
|
62551
|
+
/**
|
|
62552
|
+
* The display text for null or undefined values.
|
|
62553
|
+
*/
|
|
62554
|
+
showNullAs?: string;
|
|
62555
|
+
/**
|
|
62556
|
+
* The display text for empty string values.
|
|
62557
|
+
*/
|
|
62558
|
+
showEmptyAs?: string;
|
|
61172
62559
|
}
|
|
61173
62560
|
|
|
61174
62561
|
|
|
@@ -61273,6 +62660,7 @@ declare module GC{
|
|
|
61273
62660
|
name?: string;
|
|
61274
62661
|
icons?: (string | GC.Spread.Sheets.ButtonImageType)[];
|
|
61275
62662
|
iconSelector?: (item: any, index: number, context: any) => number | boolean;
|
|
62663
|
+
iconSize?: number | GC.Spread.Sheets.IImageSize;
|
|
61276
62664
|
tooltip?: string;
|
|
61277
62665
|
shortcutKey?: GC.Spread.Sheets.TableSheet.IShortcutKey;
|
|
61278
62666
|
command?: string;
|
|
@@ -61293,6 +62681,10 @@ declare module GC{
|
|
|
61293
62681
|
* Whether to allow to add new empty row.
|
|
61294
62682
|
*/
|
|
61295
62683
|
allowAddNew?: boolean;
|
|
62684
|
+
/**
|
|
62685
|
+
* Whether to allow to sort multiple columns.
|
|
62686
|
+
*/
|
|
62687
|
+
allowSorts?: boolean;
|
|
61296
62688
|
/**
|
|
61297
62689
|
* Defines the alternating row style options.
|
|
61298
62690
|
*/
|
|
@@ -61543,6 +62935,7 @@ declare module GC{
|
|
|
61543
62935
|
* @param {GC.Data.View} [dataView] - The table sheet data view.
|
|
61544
62936
|
* @param {Object} [options] - The initialization options.
|
|
61545
62937
|
* @param {boolean} [options.allowAddNew] - Whether to allow to add new empty row.
|
|
62938
|
+
* @param {boolean} [options.allowSorts] - Whether to allow to sort multiple columns.
|
|
61546
62939
|
* @param {boolean} [options.showRowNumber] - Whether to show the row number header.
|
|
61547
62940
|
* @param {boolean} [options.enableDefineColumn] - Whether to enable defining column.
|
|
61548
62941
|
* @param {string} [options.defineColumnCommand] - Specify the command for defining column options.
|
|
@@ -61600,6 +62993,7 @@ declare module GC{
|
|
|
61600
62993
|
* Represents the options of the table sheet.
|
|
61601
62994
|
* @type {Object}
|
|
61602
62995
|
* @property {boolean} [allowAddNew] - Whether to allow to add new empty row.
|
|
62996
|
+
* @property {boolean} [allowSorts] - Whether to allow to sort multiple columns.
|
|
61603
62997
|
* @property {string} [sheetTabColor] - A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
|
|
61604
62998
|
* @property {GC.Spread.Sheets.TableSheet.IAlternatingRowOptions} [alternatingRowOptions] - Defines the alternating row style options.
|
|
61605
62999
|
* @property {number} [defaultStackRowHeight] - Tablesheet default stack row height, will calculate the average height by default.
|
|
@@ -61682,6 +63076,19 @@ declare module GC{
|
|
|
61682
63076
|
* @param {Object} sheetJson - a Worksheet JSON, which can be gotten easily by Worksheet's toJSON method.
|
|
61683
63077
|
*/
|
|
61684
63078
|
applyFreeHeaderArea(sheetJson?: any): any;
|
|
63079
|
+
/**
|
|
63080
|
+
* Apply a named cell template to columns on this table sheet.
|
|
63081
|
+
* @param {string} name The name of a registered template (must be registered in workbook.namedCellTemplates).
|
|
63082
|
+
* @param {string[]} fieldNames The target column(s) specified as an array of field names from the data source.
|
|
63083
|
+
* @example
|
|
63084
|
+
* ```javascript
|
|
63085
|
+
* // Apply template to a single column by field name
|
|
63086
|
+
* tableSheet.applyNamedCellTemplate("MyTemplate", ["productName"]);
|
|
63087
|
+
* // Apply template to multiple columns by field names
|
|
63088
|
+
* tableSheet.applyNamedCellTemplate("MyTemplate", ["price", "quantity"]);
|
|
63089
|
+
* ```
|
|
63090
|
+
*/
|
|
63091
|
+
applyNamedCellTemplate(name: string, fieldNames: string[]): void;
|
|
61685
63092
|
/**
|
|
61686
63093
|
* Applies a table theme to current TableSheet.
|
|
61687
63094
|
* @param {GC.Spread.Sheets.Tables.TableTheme} tableTheme - A table theme instance.
|
|
@@ -61706,6 +63113,17 @@ declare module GC{
|
|
|
61706
63113
|
* ```
|
|
61707
63114
|
*/
|
|
61708
63115
|
collapseAllHierarchyLevels(): void;
|
|
63116
|
+
/**
|
|
63117
|
+
* Gets or sets the current theme for the sheet.
|
|
63118
|
+
* @param {string|GC.Spread.Common.Theme} [value] The theme name or the theme.
|
|
63119
|
+
* @returns {GC.Spread.Sheets.Theme|void} If no value is set, returns the current theme; otherwise, returns void.
|
|
63120
|
+
* @example
|
|
63121
|
+
* ```javascript
|
|
63122
|
+
* //This example sets a theme.
|
|
63123
|
+
* sheet.currentTheme("Civic");
|
|
63124
|
+
* ```
|
|
63125
|
+
*/
|
|
63126
|
+
currentTheme(value?: string | GC.Spread.Sheets.Theme): GC.Spread.Sheets.Theme | void;
|
|
61709
63127
|
/**
|
|
61710
63128
|
* Demote the hierarchy data level of the specified row.
|
|
61711
63129
|
* @param {number} row - The row index.
|
|
@@ -61800,6 +63218,10 @@ declare module GC{
|
|
|
61800
63218
|
* ```
|
|
61801
63219
|
*/
|
|
61802
63220
|
getDataView(): GC.Data.View;
|
|
63221
|
+
/**
|
|
63222
|
+
* get the current table theme of the TableSheet.
|
|
63223
|
+
*/
|
|
63224
|
+
getTableTheme(): GC.Spread.Sheets.Tables.TableTheme;
|
|
61803
63225
|
/**
|
|
61804
63226
|
* group the table sheet by options
|
|
61805
63227
|
* @param {GC.Spread.Sheets.TableSheet.IGroupByOptions[]} options - The options of the groupBy
|
|
@@ -62079,7 +63501,7 @@ declare module GC{
|
|
|
62079
63501
|
}
|
|
62080
63502
|
}
|
|
62081
63503
|
|
|
62082
|
-
|
|
63504
|
+
namespace ThreadedComments{
|
|
62083
63505
|
|
|
62084
63506
|
export interface ILinkBlock{
|
|
62085
63507
|
type: GC.Spread.Sheets.ThreadedComments.ContentType;
|
|
@@ -62368,11 +63790,11 @@ declare module GC{
|
|
|
62368
63790
|
* @param {GC.Spread.Sheets.Workbook} workbook Indicates the workbook which is attached.
|
|
62369
63791
|
* @returns void
|
|
62370
63792
|
*/
|
|
62371
|
-
attach(workbook: GC.Spread.Sheets.Workbook):
|
|
63793
|
+
attach(workbook: GC.Spread.Sheets.Workbook): void;
|
|
62372
63794
|
/**
|
|
62373
63795
|
* @description destroy the PivotPanel.
|
|
62374
63796
|
*/
|
|
62375
|
-
destroy():
|
|
63797
|
+
destroy(): void;
|
|
62376
63798
|
/**
|
|
62377
63799
|
* @description detach the workbook for threaded comment panel.
|
|
62378
63800
|
* @returns void
|
|
@@ -62400,7 +63822,7 @@ declare module GC{
|
|
|
62400
63822
|
}
|
|
62401
63823
|
}
|
|
62402
63824
|
|
|
62403
|
-
|
|
63825
|
+
namespace Touch{
|
|
62404
63826
|
|
|
62405
63827
|
export class TouchToolStrip{
|
|
62406
63828
|
/**
|
|
@@ -62688,7 +64110,7 @@ declare module GC{
|
|
|
62688
64110
|
|
|
62689
64111
|
}
|
|
62690
64112
|
|
|
62691
|
-
|
|
64113
|
+
namespace Slicers{
|
|
62692
64114
|
|
|
62693
64115
|
export interface ISlicerConditional{
|
|
62694
64116
|
/**
|