@mescius/spread-sheets 19.0.6 → 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 +1566 -158
- 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;
|
|
@@ -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.
|
|
@@ -20207,6 +20374,27 @@ declare module GC{
|
|
|
20207
20374
|
* ```
|
|
20208
20375
|
*/
|
|
20209
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;
|
|
20210
20398
|
/**
|
|
20211
20399
|
* Occurs when the cell range has changed.
|
|
20212
20400
|
* @name GC.Spread.Sheets.Worksheet#RangeChanged
|
|
@@ -21402,6 +21590,27 @@ declare module GC{
|
|
|
21402
21590
|
* ```
|
|
21403
21591
|
*/
|
|
21404
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;
|
|
21405
21614
|
/**
|
|
21406
21615
|
* Occurs when the applied cell value is invalid.
|
|
21407
21616
|
* @name GC.Spread.Sheets.Worksheet#ValidationError
|
|
@@ -23632,8 +23841,8 @@ declare module GC{
|
|
|
23632
23841
|
* @param {boolean} [options.allowUserDeselect] - Whether to allow the user to can use deselect in selection. The default value is true.
|
|
23633
23842
|
* @param {GC.Spread.Sheets.Fill.AutoFillType} [options.defaultDragFillType] - The default fill type. The default value is GC.Spread.Sheets.Fill.AutoFillType.auto.
|
|
23634
23843
|
* @param {boolean} [options.showDragFillSmartTag] - Whether to display the drag fill dialog. The default value is true.
|
|
23635
|
-
* @param {boolean} [options.showHorizontalScrollbar] - Whether to display the horizontal scroll bar. The default value is true.
|
|
23636
|
-
* @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.
|
|
23637
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.
|
|
23638
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.
|
|
23639
23848
|
* @param {boolean} [options.tabStripVisible] - Whether to display the sheet tab strip. The default value is true.
|
|
@@ -23747,6 +23956,11 @@ declare module GC{
|
|
|
23747
23956
|
* ```
|
|
23748
23957
|
*/
|
|
23749
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;
|
|
23750
23964
|
/**
|
|
23751
23965
|
* Represents the options of the Spread control.
|
|
23752
23966
|
* @type {Object}
|
|
@@ -23762,8 +23976,8 @@ declare module GC{
|
|
|
23762
23976
|
* @property {boolean} allowUserDeselect - Whether to allow the user to can use deselect in selection. The default value is true.
|
|
23763
23977
|
* @property {GC.Spread.Sheets.Fill.AutoFillType} defaultDragFillType - The default fill type. The default value is GC.Spread.Sheets.Fill.AutoFillType.auto.
|
|
23764
23978
|
* @property {boolean} showDragFillSmartTag - Whether to display the drag fill dialog. The default value is true.
|
|
23765
|
-
* @property {boolean} showHorizontalScrollbar - Whether to display the horizontal scroll bar. The default value is true.
|
|
23766
|
-
* @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.
|
|
23767
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.
|
|
23768
23982
|
* @property {boolean} scrollbarMaxAlign - Whether the scroll bar aligns with the last row and column of the active sheet. The default value is false.
|
|
23769
23983
|
* @property {boolean} tabStripVisible - Whether to display the sheet tab strip. The default value is true.
|
|
@@ -24891,7 +25105,7 @@ declare module GC{
|
|
|
24891
25105
|
*/
|
|
24892
25106
|
updateExternalReference(linkInfo: string | GC.Spread.Sheets.ExternalPartialValues, data?: object, filePath?: string, isMergeUpdate?: boolean): void;
|
|
24893
25107
|
/**
|
|
24894
|
-
* Waits for all
|
|
25108
|
+
* Waits for all calculation tasks to complete, including incrementalCalculation and SJS.TABLE.
|
|
24895
25109
|
* @returns {Promise<void>} A Promise that resolves when all calculations have finished.
|
|
24896
25110
|
* @example
|
|
24897
25111
|
* ```javascript
|
|
@@ -25315,6 +25529,28 @@ declare module GC{
|
|
|
25315
25529
|
* ```
|
|
25316
25530
|
*/
|
|
25317
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;
|
|
25318
25554
|
/**
|
|
25319
25555
|
* Automatically fits the viewport column.
|
|
25320
25556
|
* @property {number} column The column index.
|
|
@@ -27887,7 +28123,7 @@ declare module GC{
|
|
|
27887
28123
|
*/
|
|
27888
28124
|
zoom(factor?: number): any;
|
|
27889
28125
|
}
|
|
27890
|
-
|
|
28126
|
+
namespace AI{
|
|
27891
28127
|
|
|
27892
28128
|
/**
|
|
27893
28129
|
* Callback function type for sending an AI request.
|
|
@@ -27945,7 +28181,7 @@ declare module GC{
|
|
|
27945
28181
|
|
|
27946
28182
|
}
|
|
27947
28183
|
|
|
27948
|
-
|
|
28184
|
+
namespace AutoMerge{
|
|
27949
28185
|
|
|
27950
28186
|
export interface IRangeInfo{
|
|
27951
28187
|
range: GC.Spread.Sheets.Range;
|
|
@@ -28014,7 +28250,7 @@ declare module GC{
|
|
|
28014
28250
|
|
|
28015
28251
|
}
|
|
28016
28252
|
|
|
28017
|
-
|
|
28253
|
+
namespace Barcode{
|
|
28018
28254
|
|
|
28019
28255
|
export class Codabar extends GC.Spread.Sheets.Sparklines.SparklineEx{
|
|
28020
28256
|
/**
|
|
@@ -28116,7 +28352,7 @@ declare module GC{
|
|
|
28116
28352
|
}
|
|
28117
28353
|
}
|
|
28118
28354
|
|
|
28119
|
-
|
|
28355
|
+
namespace Bindings{
|
|
28120
28356
|
|
|
28121
28357
|
export class CellBindingSource{
|
|
28122
28358
|
/**
|
|
@@ -28189,7 +28425,7 @@ declare module GC{
|
|
|
28189
28425
|
}
|
|
28190
28426
|
}
|
|
28191
28427
|
|
|
28192
|
-
|
|
28428
|
+
namespace CalcEngine{
|
|
28193
28429
|
/**
|
|
28194
28430
|
* Evaluates the specified formula.
|
|
28195
28431
|
* @param {object} context The evaluation context; in general, you should use the active sheet object.
|
|
@@ -28304,7 +28540,11 @@ declare module GC{
|
|
|
28304
28540
|
* @param {number} formulaRow The row index of the cell that contains the formula that you want to resolve.
|
|
28305
28541
|
* @param {number} formulaColumn The column index of the cell that contains the formula that you want to resolve.
|
|
28306
28542
|
* @param {number} desiredResult The formula result that you want.
|
|
28307
|
-
* @
|
|
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>.
|
|
28308
28548
|
* @example
|
|
28309
28549
|
* ```javascript
|
|
28310
28550
|
* // This sample shows how to use the goal seek.
|
|
@@ -28316,8 +28556,36 @@ declare module GC{
|
|
|
28316
28556
|
* sheet.setFormula(3, 1, "PMT(B3/12,B2,B1)"); // Payment
|
|
28317
28557
|
* GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600); // result in B3 is 10%
|
|
28318
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
|
+
* ```
|
|
28319
28587
|
*/
|
|
28320
|
-
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>;
|
|
28321
28589
|
/**
|
|
28322
28590
|
* Converts the specified cell range to a formula string.
|
|
28323
28591
|
* @param {GC.Spread.Sheets.Range[]} ranges The cell range in the sheet.
|
|
@@ -28385,6 +28653,21 @@ declare module GC{
|
|
|
28385
28653
|
* ```
|
|
28386
28654
|
*/
|
|
28387
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
|
+
|
|
28388
28671
|
/**
|
|
28389
28672
|
* Specifies whether the range reference is relative or absolute.
|
|
28390
28673
|
* @enum {number}
|
|
@@ -28426,7 +28709,7 @@ declare module GC{
|
|
|
28426
28709
|
|
|
28427
28710
|
}
|
|
28428
28711
|
|
|
28429
|
-
|
|
28712
|
+
namespace CellState{
|
|
28430
28713
|
|
|
28431
28714
|
export class CellStateManager{
|
|
28432
28715
|
/**
|
|
@@ -28465,7 +28748,7 @@ declare module GC{
|
|
|
28465
28748
|
}
|
|
28466
28749
|
}
|
|
28467
28750
|
|
|
28468
|
-
|
|
28751
|
+
namespace CellTypes{
|
|
28469
28752
|
|
|
28470
28753
|
export interface ICelltypeItemOption{
|
|
28471
28754
|
text: string;
|
|
@@ -28523,6 +28806,22 @@ declare module GC{
|
|
|
28523
28806
|
autoSize?: boolean;
|
|
28524
28807
|
}
|
|
28525
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
|
+
|
|
28526
28825
|
/**
|
|
28527
28826
|
* Specifies the text alignment for check box cells.
|
|
28528
28827
|
* @enum {number}
|
|
@@ -29354,6 +29653,31 @@ declare module GC{
|
|
|
29354
29653
|
* ```
|
|
29355
29654
|
*/
|
|
29356
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;
|
|
29357
29681
|
/**
|
|
29358
29682
|
* Gets or sets a value that indicates whether the check box supports three states.
|
|
29359
29683
|
* @param {boolean} value Whether the check box supports three states.
|
|
@@ -29375,11 +29699,11 @@ declare module GC{
|
|
|
29375
29699
|
isThreeState(value?: boolean): any;
|
|
29376
29700
|
/**
|
|
29377
29701
|
* Gets or sets a value that indicates the mode of the checkbox cell type.
|
|
29378
|
-
* @param {
|
|
29379
|
-
* @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.
|
|
29380
29704
|
* @example
|
|
29381
29705
|
* ```javascript
|
|
29382
|
-
* // This example creates a check box cell.
|
|
29706
|
+
* // This example creates a check box cell with toggle mode.
|
|
29383
29707
|
* var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
|
|
29384
29708
|
* cellType1.caption("caption");
|
|
29385
29709
|
* cellType1.textTrue("true");
|
|
@@ -29388,8 +29712,16 @@ declare module GC{
|
|
|
29388
29712
|
* cellType1.mode("toggle");
|
|
29389
29713
|
* activeSheet.getCell(1, 1).cellType(cellType1);
|
|
29390
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
|
+
* ```
|
|
29391
29723
|
*/
|
|
29392
|
-
mode(value?:
|
|
29724
|
+
mode(value?: GC.Spread.Sheets.CellTypes.CheckBoxMode): any;
|
|
29393
29725
|
/**
|
|
29394
29726
|
* Gets or sets the text alignment relative to the check box.
|
|
29395
29727
|
* @param {GC.Spread.Sheets.CellTypes.CheckBoxTextAlign} value The text alignment relative to the check box.
|
|
@@ -29409,6 +29741,31 @@ declare module GC{
|
|
|
29409
29741
|
* ```
|
|
29410
29742
|
*/
|
|
29411
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;
|
|
29412
29769
|
/**
|
|
29413
29770
|
* Gets or sets the text in the cell when the cell's value is `false`.
|
|
29414
29771
|
* @param {string} value The text in the cell when the cell's value is `false`.
|
|
@@ -29612,18 +29969,26 @@ declare module GC{
|
|
|
29612
29969
|
maxRowCount(value?: number): any;
|
|
29613
29970
|
/**
|
|
29614
29971
|
* Gets or sets a value that indicates the mode of the checkbox list cell type.
|
|
29615
|
-
* @param {
|
|
29616
|
-
* @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.
|
|
29617
29974
|
* @example
|
|
29618
29975
|
* ```javascript
|
|
29619
|
-
* // This example creates a check box list cell.
|
|
29976
|
+
* // This example creates a check box list cell with toggle mode.
|
|
29620
29977
|
* var cellType = new GC.Spread.Sheets.CellTypes.CheckBoxList();
|
|
29621
29978
|
* cellType.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
|
|
29622
29979
|
* cellType.mode("toggle");
|
|
29623
29980
|
* activeSheet.getCell(2, 2).cellType(cellType);
|
|
29624
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
|
+
* ```
|
|
29625
29990
|
*/
|
|
29626
|
-
mode(value?:
|
|
29991
|
+
mode(value?: GC.Spread.Sheets.CellTypes.CheckBoxMode): any;
|
|
29627
29992
|
/**
|
|
29628
29993
|
* Gets or sets the text of checkbox's position, only support left and right .
|
|
29629
29994
|
* @param {GC.Spread.Sheets.CellTypes.TextAlign} value the text of checkbox's position.
|
|
@@ -29821,7 +30186,20 @@ declare module GC{
|
|
|
29821
30186
|
* sheet.setCellType(1, 1, cellType1);
|
|
29822
30187
|
* ```
|
|
29823
30188
|
*/
|
|
29824
|
-
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;
|
|
29825
30203
|
}
|
|
29826
30204
|
|
|
29827
30205
|
export class Diagonal extends Text{
|
|
@@ -30377,7 +30755,7 @@ declare module GC{
|
|
|
30377
30755
|
}
|
|
30378
30756
|
}
|
|
30379
30757
|
|
|
30380
|
-
|
|
30758
|
+
namespace Charts{
|
|
30381
30759
|
/**
|
|
30382
30760
|
* Get the specified color by colorScheme, index
|
|
30383
30761
|
* @param {GC.Spread.Sheets.Charts.ColorScheme} colorScheme The color scheme.
|
|
@@ -32674,7 +33052,7 @@ declare module GC{
|
|
|
32674
33052
|
}
|
|
32675
33053
|
}
|
|
32676
33054
|
|
|
32677
|
-
|
|
33055
|
+
namespace Collaboration{
|
|
32678
33056
|
|
|
32679
33057
|
export interface IChangeSet{
|
|
32680
33058
|
ops: GC.Spread.Sheets.Collaboration.IOpComponent[];
|
|
@@ -33016,6 +33394,42 @@ declare module GC{
|
|
|
33016
33394
|
* setSelectionPolicyAndUnit
|
|
33017
33395
|
*/
|
|
33018
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,
|
|
33019
33433
|
/**
|
|
33020
33434
|
* addExternalReference
|
|
33021
33435
|
*/
|
|
@@ -33160,6 +33574,10 @@ declare module GC{
|
|
|
33160
33574
|
* reorderChildShape
|
|
33161
33575
|
*/
|
|
33162
33576
|
reorderChildShape= 209,
|
|
33577
|
+
/**
|
|
33578
|
+
* updateChildShapeProp
|
|
33579
|
+
*/
|
|
33580
|
+
updateShapeCollectionOption= 210,
|
|
33163
33581
|
/**
|
|
33164
33582
|
* updateChartSeries
|
|
33165
33583
|
*/
|
|
@@ -33391,7 +33809,143 @@ declare module GC{
|
|
|
33391
33809
|
/**
|
|
33392
33810
|
* removeThreadedCommentReply
|
|
33393
33811
|
*/
|
|
33394
|
-
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
|
|
33395
33949
|
}
|
|
33396
33950
|
|
|
33397
33951
|
/**
|
|
@@ -33581,7 +34135,7 @@ declare module GC{
|
|
|
33581
34135
|
}
|
|
33582
34136
|
}
|
|
33583
34137
|
|
|
33584
|
-
|
|
34138
|
+
namespace Commands{
|
|
33585
34139
|
/**
|
|
33586
34140
|
* Represents the command used to automatically resize the column in a sheet.
|
|
33587
34141
|
* @property {boolean} canUndo - indicates whether the command supports undo and redo operations.
|
|
@@ -35559,7 +36113,7 @@ declare module GC{
|
|
|
35559
36113
|
function undoTransaction(context: GC.Spread.Sheets.Workbook, options: any): void;
|
|
35560
36114
|
}
|
|
35561
36115
|
|
|
35562
|
-
|
|
36116
|
+
namespace Comments{
|
|
35563
36117
|
/**
|
|
35564
36118
|
* Defines the comment state.
|
|
35565
36119
|
* @enum {number}
|
|
@@ -36209,7 +36763,7 @@ declare module GC{
|
|
|
36209
36763
|
}
|
|
36210
36764
|
}
|
|
36211
36765
|
|
|
36212
|
-
|
|
36766
|
+
namespace ConditionalFormatting{
|
|
36213
36767
|
|
|
36214
36768
|
export interface IIconInfo{
|
|
36215
36769
|
iconSetType:GC.Spread.Sheets.ConditionalFormatting.IconSetType;
|
|
@@ -37034,7 +37588,11 @@ declare module GC{
|
|
|
37034
37588
|
/** Specifies the column state rule.
|
|
37035
37589
|
* @type {number}
|
|
37036
37590
|
*/
|
|
37037
|
-
columnStateRule= 15
|
|
37591
|
+
columnStateRule= 15,
|
|
37592
|
+
/** Specifies the sparkline rule.
|
|
37593
|
+
* @type {number}
|
|
37594
|
+
*/
|
|
37595
|
+
sparklineRule= 16
|
|
37038
37596
|
}
|
|
37039
37597
|
|
|
37040
37598
|
/**
|
|
@@ -37832,6 +38390,51 @@ declare module GC{
|
|
|
37832
38390
|
* ```
|
|
37833
38391
|
*/
|
|
37834
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;
|
|
37835
38438
|
/**
|
|
37836
38439
|
* Adds the text rule to the rule collection.
|
|
37837
38440
|
* @param {GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators} comparisonOperator The comparison operator.
|
|
@@ -37859,21 +38462,22 @@ declare module GC{
|
|
|
37859
38462
|
* @param {number} rank The number of top or bottom items to apply the style to.
|
|
37860
38463
|
* @param {GC.Spread.Sheets.Style} style The style that is applied to the cell when the condition is met.
|
|
37861
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.
|
|
37862
38466
|
* @returns {GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase} The top 10 rule added to the rule collection.
|
|
37863
38467
|
* @example
|
|
37864
38468
|
* ```javascript
|
|
37865
|
-
* //This example uses the addTop10Rule method.
|
|
38469
|
+
* //This example uses the addTop10Rule method to add top percent rule.
|
|
37866
38470
|
* var style = new GC.Spread.Sheets.Style();
|
|
37867
38471
|
* style.backColor = "red";
|
|
37868
38472
|
* var ranges=[new GC.Spread.Sheets.Range(0,0,10,1)];
|
|
37869
|
-
* 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);
|
|
37870
38474
|
* activeSheet.setValue(0, 0, 1);
|
|
37871
38475
|
* activeSheet.setValue(1, 0, 50);
|
|
37872
38476
|
* activeSheet.setValue(2, 0, 11);
|
|
37873
38477
|
* activeSheet.setValue(3, 0, 5);
|
|
37874
38478
|
* ```
|
|
37875
38479
|
*/
|
|
37876
|
-
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;
|
|
37877
38481
|
/**
|
|
37878
38482
|
* Adds a unique rule to the rule collection.
|
|
37879
38483
|
* @param {GC.Spread.Sheets.Style} style The style that is applied to the cell when the condition is met.
|
|
@@ -38267,14 +38871,14 @@ declare module GC{
|
|
|
38267
38871
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38268
38872
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38269
38873
|
* style1.foreColor = "red";
|
|
38270
|
-
* var
|
|
38271
|
-
*
|
|
38272
|
-
*
|
|
38273
|
-
*
|
|
38274
|
-
*
|
|
38275
|
-
*
|
|
38276
|
-
*
|
|
38277
|
-
* 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);
|
|
38278
38882
|
* ```
|
|
38279
38883
|
*/
|
|
38280
38884
|
ruleType(value?: GC.Spread.Sheets.ConditionalFormatting.RuleType): any;
|
|
@@ -38298,14 +38902,14 @@ declare module GC{
|
|
|
38298
38902
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38299
38903
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38300
38904
|
* style1.foreColor = "red";
|
|
38301
|
-
* var
|
|
38302
|
-
*
|
|
38303
|
-
*
|
|
38304
|
-
*
|
|
38305
|
-
*
|
|
38306
|
-
*
|
|
38307
|
-
*
|
|
38308
|
-
* 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);
|
|
38309
38913
|
* ```
|
|
38310
38914
|
*/
|
|
38311
38915
|
stopIfTrue(value?: boolean): any;
|
|
@@ -38329,14 +38933,14 @@ declare module GC{
|
|
|
38329
38933
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
38330
38934
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
38331
38935
|
* style1.foreColor = "red";
|
|
38332
|
-
* var
|
|
38333
|
-
*
|
|
38334
|
-
*
|
|
38335
|
-
*
|
|
38336
|
-
*
|
|
38337
|
-
*
|
|
38338
|
-
*
|
|
38339
|
-
* 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);
|
|
38340
38944
|
* ```
|
|
38341
38945
|
*/
|
|
38342
38946
|
style(value?: GC.Spread.Sheets.Style): any;
|
|
@@ -39118,6 +39722,7 @@ declare module GC{
|
|
|
39118
39722
|
* @param {string} formula The condition formula.
|
|
39119
39723
|
* @param {GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType | GC.Spread.Sheets.ConditionalFormatting.AverageConditionType | GC.Spread.Sheets.ConditionalFormatting.DateOccurringType} type The average condition type.
|
|
39120
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.
|
|
39121
39726
|
* @constructor
|
|
39122
39727
|
* @example
|
|
39123
39728
|
* ```javascript
|
|
@@ -39139,7 +39744,7 @@ declare module GC{
|
|
|
39139
39744
|
* });
|
|
39140
39745
|
* ```
|
|
39141
39746
|
*/
|
|
39142
|
-
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);
|
|
39143
39748
|
/**
|
|
39144
39749
|
* Creates a condition for the rule.
|
|
39145
39750
|
* @returns {GC.Spread.Sheets.ConditionalFormatting.Condition} The condition.
|
|
@@ -39179,6 +39784,28 @@ declare module GC{
|
|
|
39179
39784
|
* ```
|
|
39180
39785
|
*/
|
|
39181
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;
|
|
39182
39809
|
/**
|
|
39183
39810
|
* Gets or sets the comparison operator.
|
|
39184
39811
|
* @param {GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators} value The comparison operator.
|
|
@@ -39199,14 +39826,14 @@ declare module GC{
|
|
|
39199
39826
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39200
39827
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39201
39828
|
* style1.foreColor = "red";
|
|
39202
|
-
* var
|
|
39203
|
-
*
|
|
39204
|
-
*
|
|
39205
|
-
*
|
|
39206
|
-
*
|
|
39207
|
-
*
|
|
39208
|
-
*
|
|
39209
|
-
* 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);
|
|
39210
39837
|
* ```
|
|
39211
39838
|
*/
|
|
39212
39839
|
operator(value?: GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators): any;
|
|
@@ -39230,13 +39857,14 @@ declare module GC{
|
|
|
39230
39857
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39231
39858
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39232
39859
|
* style1.foreColor = "red";
|
|
39233
|
-
* var
|
|
39234
|
-
*
|
|
39235
|
-
*
|
|
39236
|
-
*
|
|
39237
|
-
*
|
|
39238
|
-
*
|
|
39239
|
-
*
|
|
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);
|
|
39240
39868
|
* activeSheet.conditionalFormats.addRule(top);
|
|
39241
39869
|
* ```
|
|
39242
39870
|
*/
|
|
@@ -39314,14 +39942,14 @@ declare module GC{
|
|
|
39314
39942
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39315
39943
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39316
39944
|
* style1.foreColor = "red";
|
|
39317
|
-
* var
|
|
39318
|
-
*
|
|
39319
|
-
*
|
|
39320
|
-
*
|
|
39321
|
-
*
|
|
39322
|
-
*
|
|
39323
|
-
*
|
|
39324
|
-
* 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);
|
|
39325
39953
|
* ```
|
|
39326
39954
|
*/
|
|
39327
39955
|
type(value?: GC.Spread.Sheets.ConditionalFormatting.AverageConditionType): any;
|
|
@@ -39346,14 +39974,14 @@ declare module GC{
|
|
|
39346
39974
|
* activeSheet.conditionalFormats.addRule(cell);
|
|
39347
39975
|
* var style1 = new GC.Spread.Sheets.Style();
|
|
39348
39976
|
* style1.foreColor = "red";
|
|
39349
|
-
* var
|
|
39350
|
-
*
|
|
39351
|
-
*
|
|
39352
|
-
*
|
|
39353
|
-
*
|
|
39354
|
-
*
|
|
39355
|
-
*
|
|
39356
|
-
* 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);
|
|
39357
39985
|
* var formulaOfTheTopLeftCell = cell.value1();
|
|
39358
39986
|
* var formulaOfA5 = cell.value1(4, 0);
|
|
39359
39987
|
* var formulaOfA10 = cell.value1(9, 0);
|
|
@@ -39689,6 +40317,142 @@ declare module GC{
|
|
|
39689
40317
|
value: Object;
|
|
39690
40318
|
}
|
|
39691
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
|
+
|
|
39692
40456
|
export class StateRule extends GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase{
|
|
39693
40457
|
/**
|
|
39694
40458
|
* Represents a state rule.
|
|
@@ -39767,7 +40531,7 @@ declare module GC{
|
|
|
39767
40531
|
}
|
|
39768
40532
|
}
|
|
39769
40533
|
|
|
39770
|
-
|
|
40534
|
+
namespace ContextMenu{
|
|
39771
40535
|
|
|
39772
40536
|
export interface IMenuItemData{
|
|
39773
40537
|
/**
|
|
@@ -40170,7 +40934,7 @@ declare module GC{
|
|
|
40170
40934
|
}
|
|
40171
40935
|
}
|
|
40172
40936
|
|
|
40173
|
-
|
|
40937
|
+
namespace DataCharts{
|
|
40174
40938
|
|
|
40175
40939
|
export interface IAnimationOption{
|
|
40176
40940
|
duration?: number;
|
|
@@ -40240,6 +41004,7 @@ declare module GC{
|
|
|
40240
41004
|
|
|
40241
41005
|
export interface ICategoryEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
|
|
40242
41006
|
sort?: GC.Spread.Sheets.DataCharts.ISortEncodingOption;
|
|
41007
|
+
child?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
|
|
40243
41008
|
}
|
|
40244
41009
|
|
|
40245
41010
|
|
|
@@ -40405,6 +41170,7 @@ declare module GC{
|
|
|
40405
41170
|
updateAnimation?: GC.Spread.Sheets.DataCharts.IAnimationOption;
|
|
40406
41171
|
funnel?: GC.Spread.Sheets.DataCharts.IFunnelOption;
|
|
40407
41172
|
waterfall?: GC.Spread.Sheets.DataCharts.IWaterfallOption;
|
|
41173
|
+
treemap?: GC.Spread.Sheets.DataCharts.ITreemapOption;
|
|
40408
41174
|
}
|
|
40409
41175
|
|
|
40410
41176
|
|
|
@@ -40428,7 +41194,7 @@ declare module GC{
|
|
|
40428
41194
|
|
|
40429
41195
|
|
|
40430
41196
|
export interface IPlotEncodingsOption{
|
|
40431
|
-
values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[];
|
|
41197
|
+
values?: GC.Spread.Sheets.DataCharts.IValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IRangeValueEncodingOption[] | GC.Spread.Sheets.DataCharts.IStockValueEncodingOption[];
|
|
40432
41198
|
category?: GC.Spread.Sheets.DataCharts.ICategoryEncodingOption;
|
|
40433
41199
|
details?: GC.Spread.Sheets.DataCharts.IFieldBasicOption[];
|
|
40434
41200
|
color?: GC.Spread.Sheets.DataCharts.IFieldBasicOption;
|
|
@@ -40454,6 +41220,18 @@ declare module GC{
|
|
|
40454
41220
|
}
|
|
40455
41221
|
|
|
40456
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
|
+
|
|
40457
41235
|
export interface ISortEncodingOption{
|
|
40458
41236
|
field: string;
|
|
40459
41237
|
aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
|
|
@@ -40461,6 +41239,19 @@ declare module GC{
|
|
|
40461
41239
|
}
|
|
40462
41240
|
|
|
40463
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
|
+
|
|
40464
41255
|
export interface IStyleOption{
|
|
40465
41256
|
fill?: GC.Spread.Sheets.DataCharts.ColorOptions;
|
|
40466
41257
|
fillOpacity?: number;
|
|
@@ -40527,6 +41318,17 @@ declare module GC{
|
|
|
40527
41318
|
}
|
|
40528
41319
|
|
|
40529
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
|
+
|
|
40530
41332
|
export interface IValueEncodingOption extends GC.Spread.Sheets.DataCharts.IFieldBasicOption{
|
|
40531
41333
|
aggregate?: GC.Spread.Sheets.DataCharts.Aggregate;
|
|
40532
41334
|
}
|
|
@@ -41153,10 +41955,22 @@ declare module GC{
|
|
|
41153
41955
|
* spline
|
|
41154
41956
|
*/
|
|
41155
41957
|
spline= "Spline",
|
|
41958
|
+
/**
|
|
41959
|
+
* stepLeft
|
|
41960
|
+
*/
|
|
41961
|
+
stepLeft= "StepLeft",
|
|
41962
|
+
/**
|
|
41963
|
+
* stepRight
|
|
41964
|
+
*/
|
|
41965
|
+
stepRight= "StepRight",
|
|
41156
41966
|
/**
|
|
41157
41967
|
* stepCenter
|
|
41158
41968
|
*/
|
|
41159
|
-
stepCenter= "StepCenter"
|
|
41969
|
+
stepCenter= "StepCenter",
|
|
41970
|
+
/**
|
|
41971
|
+
* bezierCurve
|
|
41972
|
+
*/
|
|
41973
|
+
bezierCurve= "BezierCurve"
|
|
41160
41974
|
}
|
|
41161
41975
|
|
|
41162
41976
|
/**
|
|
@@ -41696,7 +42510,7 @@ declare module GC{
|
|
|
41696
42510
|
}
|
|
41697
42511
|
}
|
|
41698
42512
|
|
|
41699
|
-
|
|
42513
|
+
namespace DataRange{
|
|
41700
42514
|
|
|
41701
42515
|
export interface IDataProvider{
|
|
41702
42516
|
/**
|
|
@@ -41861,7 +42675,7 @@ declare module GC{
|
|
|
41861
42675
|
}
|
|
41862
42676
|
}
|
|
41863
42677
|
|
|
41864
|
-
|
|
42678
|
+
namespace DataValidation{
|
|
41865
42679
|
/**
|
|
41866
42680
|
* Creates a validator based on the data.
|
|
41867
42681
|
* @static
|
|
@@ -42630,7 +43444,7 @@ declare module GC{
|
|
|
42630
43444
|
}
|
|
42631
43445
|
}
|
|
42632
43446
|
|
|
42633
|
-
|
|
43447
|
+
namespace Fill{
|
|
42634
43448
|
|
|
42635
43449
|
export interface IFillOptions{
|
|
42636
43450
|
fillType: GC.Spread.Sheets.Fill.FillType;
|
|
@@ -42829,7 +43643,7 @@ declare module GC{
|
|
|
42829
43643
|
|
|
42830
43644
|
}
|
|
42831
43645
|
|
|
42832
|
-
|
|
43646
|
+
namespace Filter{
|
|
42833
43647
|
|
|
42834
43648
|
export interface IFilterDialogVisibleInfo{
|
|
42835
43649
|
/**
|
|
@@ -43294,7 +44108,7 @@ declare module GC{
|
|
|
43294
44108
|
}
|
|
43295
44109
|
}
|
|
43296
44110
|
|
|
43297
|
-
|
|
44111
|
+
namespace FloatingObjects{
|
|
43298
44112
|
|
|
43299
44113
|
export class FloatingObject{
|
|
43300
44114
|
/**
|
|
@@ -44151,7 +44965,7 @@ declare module GC{
|
|
|
44151
44965
|
}
|
|
44152
44966
|
}
|
|
44153
44967
|
|
|
44154
|
-
|
|
44968
|
+
namespace FormulaPanel{
|
|
44155
44969
|
/**
|
|
44156
44970
|
* Gets the FormulaEditor instance by the host element.
|
|
44157
44971
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -44242,7 +45056,7 @@ declare module GC{
|
|
|
44242
45056
|
*/
|
|
44243
45057
|
text(value?: string): string;
|
|
44244
45058
|
}
|
|
44245
|
-
|
|
45059
|
+
namespace Commands{
|
|
44246
45060
|
/**
|
|
44247
45061
|
* Represents the command used to close hints.
|
|
44248
45062
|
* @property {function} execute - performs an execute operation.
|
|
@@ -44307,7 +45121,7 @@ declare module GC{
|
|
|
44307
45121
|
|
|
44308
45122
|
}
|
|
44309
45123
|
|
|
44310
|
-
|
|
45124
|
+
namespace FormulaTextBox{
|
|
44311
45125
|
/**
|
|
44312
45126
|
* Gets the FormulaTextBox instance by the host element.
|
|
44313
45127
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -44521,7 +45335,7 @@ declare module GC{
|
|
|
44521
45335
|
}
|
|
44522
45336
|
}
|
|
44523
45337
|
|
|
44524
|
-
|
|
45338
|
+
namespace GanttSheet{
|
|
44525
45339
|
|
|
44526
45340
|
/**
|
|
44527
45341
|
* Represents a duration in scheduling. To create a valid duration, please call project.parseDuration method.
|
|
@@ -44597,6 +45411,7 @@ declare module GC{
|
|
|
44597
45411
|
* @property {boolean} [enableGanttColumn] Whether to show the gantt column. Default is true.
|
|
44598
45412
|
* @property {boolean} [allowAddNew] - Whether to allow to add new empty row.
|
|
44599
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.
|
|
44600
45415
|
*/
|
|
44601
45416
|
export type IGanttSheetOptions =
|
|
44602
45417
|
{
|
|
@@ -44612,6 +45427,10 @@ declare module GC{
|
|
|
44612
45427
|
* A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
|
|
44613
45428
|
*/
|
|
44614
45429
|
sheetTabColor?: string;
|
|
45430
|
+
/**
|
|
45431
|
+
* the default task mode
|
|
45432
|
+
*/
|
|
45433
|
+
defaultMode?: GC.Spread.Sheets.GanttSheet.TaskScheduleMode;
|
|
44615
45434
|
}
|
|
44616
45435
|
|
|
44617
45436
|
|
|
@@ -44818,6 +45637,15 @@ declare module GC{
|
|
|
44818
45637
|
{ hour: number, minute: number };
|
|
44819
45638
|
|
|
44820
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
|
+
|
|
44821
45649
|
/**
|
|
44822
45650
|
* This callback is used to format timescale labels.
|
|
44823
45651
|
* @callback GC.Spread.Sheets.GanttSheet.TimescaleLabelFormatter
|
|
@@ -45880,6 +46708,11 @@ declare module GC{
|
|
|
45880
46708
|
* @classdesc Represents the timescale of GanttChart.
|
|
45881
46709
|
*/
|
|
45882
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;
|
|
45883
46716
|
/**
|
|
45884
46717
|
* Gets the bottom tier of the timescale.
|
|
45885
46718
|
* @type {GC.Spread.Sheets.GanttSheet.TimescaleTier}
|
|
@@ -45892,6 +46725,11 @@ declare module GC{
|
|
|
45892
46725
|
* @readonly
|
|
45893
46726
|
*/
|
|
45894
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;
|
|
45895
46733
|
/**
|
|
45896
46734
|
* Gets or sets the maximum date of the scrollable area of the timescale. The default value is 2030-1-1.
|
|
45897
46735
|
* @type {Date}
|
|
@@ -46085,7 +46923,7 @@ declare module GC{
|
|
|
46085
46923
|
}
|
|
46086
46924
|
}
|
|
46087
46925
|
|
|
46088
|
-
|
|
46926
|
+
namespace Hyperlink{
|
|
46089
46927
|
/**
|
|
46090
46928
|
* Present the way that user open the hyperlinked document. Default is blank.
|
|
46091
46929
|
* @enum {number}
|
|
@@ -46120,7 +46958,7 @@ declare module GC{
|
|
|
46120
46958
|
|
|
46121
46959
|
}
|
|
46122
46960
|
|
|
46123
|
-
|
|
46961
|
+
namespace InputMask{
|
|
46124
46962
|
/**
|
|
46125
46963
|
* Get all named patterns.
|
|
46126
46964
|
* @static
|
|
@@ -46160,7 +46998,7 @@ declare module GC{
|
|
|
46160
46998
|
|
|
46161
46999
|
}
|
|
46162
47000
|
|
|
46163
|
-
|
|
47001
|
+
namespace IO{
|
|
46164
47002
|
/**
|
|
46165
47003
|
* Gets the the values of specific reference path list from file directly.
|
|
46166
47004
|
* @static
|
|
@@ -46250,7 +47088,7 @@ declare module GC{
|
|
|
46250
47088
|
|
|
46251
47089
|
}
|
|
46252
47090
|
|
|
46253
|
-
|
|
47091
|
+
namespace NameBox{
|
|
46254
47092
|
/**
|
|
46255
47093
|
* Gets the NameBox instance by the host element.
|
|
46256
47094
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -46343,7 +47181,199 @@ declare module GC{
|
|
|
46343
47181
|
}
|
|
46344
47182
|
}
|
|
46345
47183
|
|
|
46346
|
-
|
|
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{
|
|
46347
47377
|
|
|
46348
47378
|
export interface IOutlineColumnOptions{
|
|
46349
47379
|
/**
|
|
@@ -46682,7 +47712,7 @@ declare module GC{
|
|
|
46682
47712
|
}
|
|
46683
47713
|
}
|
|
46684
47714
|
|
|
46685
|
-
|
|
47715
|
+
namespace Outlines{
|
|
46686
47716
|
/**
|
|
46687
47717
|
* Specifies the status of an outline (range group) summary row or column position.
|
|
46688
47718
|
* @enum {number}
|
|
@@ -47116,7 +48146,7 @@ declare module GC{
|
|
|
47116
48146
|
}
|
|
47117
48147
|
}
|
|
47118
48148
|
|
|
47119
|
-
|
|
48149
|
+
namespace PDF{
|
|
47120
48150
|
|
|
47121
48151
|
export class PDFFontsManager{
|
|
47122
48152
|
/**
|
|
@@ -47165,7 +48195,7 @@ declare module GC{
|
|
|
47165
48195
|
}
|
|
47166
48196
|
}
|
|
47167
48197
|
|
|
47168
|
-
|
|
48198
|
+
namespace Print{
|
|
47169
48199
|
|
|
47170
48200
|
export interface IPageCustomHeaderFooterOptions{
|
|
47171
48201
|
normal?: GC.Spread.Sheets.Print.IPageHeaderFooterOptions;
|
|
@@ -48490,7 +49520,7 @@ declare module GC{
|
|
|
48490
49520
|
}
|
|
48491
49521
|
}
|
|
48492
49522
|
|
|
48493
|
-
|
|
49523
|
+
namespace Search{
|
|
48494
49524
|
/**
|
|
48495
49525
|
* Specifies the type of search flags.
|
|
48496
49526
|
* @enum {number}
|
|
@@ -48990,7 +50020,7 @@ declare module GC{
|
|
|
48990
50020
|
}
|
|
48991
50021
|
}
|
|
48992
50022
|
|
|
48993
|
-
|
|
50023
|
+
namespace Shapes{
|
|
48994
50024
|
|
|
48995
50025
|
export interface IBoundingRect{
|
|
48996
50026
|
left: number;
|
|
@@ -50288,7 +51318,11 @@ declare module GC{
|
|
|
50288
51318
|
/**
|
|
50289
51319
|
* Specifies an elbow connector.
|
|
50290
51320
|
*/
|
|
50291
|
-
elbow= 1
|
|
51321
|
+
elbow= 1,
|
|
51322
|
+
/**
|
|
51323
|
+
* Specifies a curve connector.
|
|
51324
|
+
*/
|
|
51325
|
+
curve= 2
|
|
50292
51326
|
}
|
|
50293
51327
|
|
|
50294
51328
|
/**
|
|
@@ -52174,7 +53208,7 @@ declare module GC{
|
|
|
52174
53208
|
}
|
|
52175
53209
|
}
|
|
52176
53210
|
|
|
52177
|
-
|
|
53211
|
+
namespace Slicers{
|
|
52178
53212
|
|
|
52179
53213
|
export interface ISlicer{
|
|
52180
53214
|
style: (style?: string | SlicerStyle, shouldCallback?: boolean) => SlicerStyle | ISlicer;
|
|
@@ -57040,7 +58074,235 @@ declare module GC{
|
|
|
57040
58074
|
}
|
|
57041
58075
|
}
|
|
57042
58076
|
|
|
57043
|
-
|
|
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
|
+
|
|
57044
58306
|
|
|
57045
58307
|
export interface ISparklineSetting{
|
|
57046
58308
|
/**
|
|
@@ -57145,6 +58407,100 @@ declare module GC{
|
|
|
57145
58407
|
lineWeight?: number;
|
|
57146
58408
|
}
|
|
57147
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
|
+
|
|
57148
58504
|
/**
|
|
57149
58505
|
* Represents the orientation of the range.
|
|
57150
58506
|
* @enum {number}
|
|
@@ -57438,6 +58794,15 @@ declare module GC{
|
|
|
57438
58794
|
constructor();
|
|
57439
58795
|
}
|
|
57440
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
|
+
|
|
57441
58806
|
export class RangeBlockSparkline extends SparklineEx{
|
|
57442
58807
|
/**
|
|
57443
58808
|
* Represents the class for the range block sparkline.
|
|
@@ -58146,7 +59511,7 @@ declare module GC{
|
|
|
58146
59511
|
}
|
|
58147
59512
|
}
|
|
58148
59513
|
|
|
58149
|
-
|
|
59514
|
+
namespace StatusBar{
|
|
58150
59515
|
/**
|
|
58151
59516
|
* Gets the StatusBar instance by the host element.
|
|
58152
59517
|
* @param {HTMLElement|string} host The host element or the host element id.
|
|
@@ -58393,7 +59758,7 @@ declare module GC{
|
|
|
58393
59758
|
*/
|
|
58394
59759
|
onUpdate(content?: string): void;
|
|
58395
59760
|
}
|
|
58396
|
-
|
|
59761
|
+
namespace StatusItem{
|
|
58397
59762
|
|
|
58398
59763
|
export interface IStatusItemOptions{
|
|
58399
59764
|
/**
|
|
@@ -58435,7 +59800,7 @@ declare module GC{
|
|
|
58435
59800
|
|
|
58436
59801
|
}
|
|
58437
59802
|
|
|
58438
|
-
|
|
59803
|
+
namespace Tables{
|
|
58439
59804
|
|
|
58440
59805
|
export interface IRowState{
|
|
58441
59806
|
row: number;
|
|
@@ -61088,7 +62453,7 @@ declare module GC{
|
|
|
61088
62453
|
}
|
|
61089
62454
|
}
|
|
61090
62455
|
|
|
61091
|
-
|
|
62456
|
+
namespace TableSheet{
|
|
61092
62457
|
|
|
61093
62458
|
export interface IAlternatingRowOptions{
|
|
61094
62459
|
/**
|
|
@@ -61165,7 +62530,7 @@ declare module GC{
|
|
|
61165
62530
|
* the column header style
|
|
61166
62531
|
*/
|
|
61167
62532
|
headerStyle?: GC.Data.HeaderStyleOptions;
|
|
61168
|
-
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)[];
|
|
61169
62534
|
validator?: GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions;
|
|
61170
62535
|
/**
|
|
61171
62536
|
* the header fit mode, default is normal
|
|
@@ -61183,6 +62548,14 @@ declare module GC{
|
|
|
61183
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.
|
|
61184
62549
|
*/
|
|
61185
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;
|
|
61186
62559
|
}
|
|
61187
62560
|
|
|
61188
62561
|
|
|
@@ -61287,6 +62660,7 @@ declare module GC{
|
|
|
61287
62660
|
name?: string;
|
|
61288
62661
|
icons?: (string | GC.Spread.Sheets.ButtonImageType)[];
|
|
61289
62662
|
iconSelector?: (item: any, index: number, context: any) => number | boolean;
|
|
62663
|
+
iconSize?: number | GC.Spread.Sheets.IImageSize;
|
|
61290
62664
|
tooltip?: string;
|
|
61291
62665
|
shortcutKey?: GC.Spread.Sheets.TableSheet.IShortcutKey;
|
|
61292
62666
|
command?: string;
|
|
@@ -61307,6 +62681,10 @@ declare module GC{
|
|
|
61307
62681
|
* Whether to allow to add new empty row.
|
|
61308
62682
|
*/
|
|
61309
62683
|
allowAddNew?: boolean;
|
|
62684
|
+
/**
|
|
62685
|
+
* Whether to allow to sort multiple columns.
|
|
62686
|
+
*/
|
|
62687
|
+
allowSorts?: boolean;
|
|
61310
62688
|
/**
|
|
61311
62689
|
* Defines the alternating row style options.
|
|
61312
62690
|
*/
|
|
@@ -61557,6 +62935,7 @@ declare module GC{
|
|
|
61557
62935
|
* @param {GC.Data.View} [dataView] - The table sheet data view.
|
|
61558
62936
|
* @param {Object} [options] - The initialization options.
|
|
61559
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.
|
|
61560
62939
|
* @param {boolean} [options.showRowNumber] - Whether to show the row number header.
|
|
61561
62940
|
* @param {boolean} [options.enableDefineColumn] - Whether to enable defining column.
|
|
61562
62941
|
* @param {string} [options.defineColumnCommand] - Specify the command for defining column options.
|
|
@@ -61614,6 +62993,7 @@ declare module GC{
|
|
|
61614
62993
|
* Represents the options of the table sheet.
|
|
61615
62994
|
* @type {Object}
|
|
61616
62995
|
* @property {boolean} [allowAddNew] - Whether to allow to add new empty row.
|
|
62996
|
+
* @property {boolean} [allowSorts] - Whether to allow to sort multiple columns.
|
|
61617
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.
|
|
61618
62998
|
* @property {GC.Spread.Sheets.TableSheet.IAlternatingRowOptions} [alternatingRowOptions] - Defines the alternating row style options.
|
|
61619
62999
|
* @property {number} [defaultStackRowHeight] - Tablesheet default stack row height, will calculate the average height by default.
|
|
@@ -61696,6 +63076,19 @@ declare module GC{
|
|
|
61696
63076
|
* @param {Object} sheetJson - a Worksheet JSON, which can be gotten easily by Worksheet's toJSON method.
|
|
61697
63077
|
*/
|
|
61698
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;
|
|
61699
63092
|
/**
|
|
61700
63093
|
* Applies a table theme to current TableSheet.
|
|
61701
63094
|
* @param {GC.Spread.Sheets.Tables.TableTheme} tableTheme - A table theme instance.
|
|
@@ -61720,6 +63113,17 @@ declare module GC{
|
|
|
61720
63113
|
* ```
|
|
61721
63114
|
*/
|
|
61722
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;
|
|
61723
63127
|
/**
|
|
61724
63128
|
* Demote the hierarchy data level of the specified row.
|
|
61725
63129
|
* @param {number} row - The row index.
|
|
@@ -61814,6 +63218,10 @@ declare module GC{
|
|
|
61814
63218
|
* ```
|
|
61815
63219
|
*/
|
|
61816
63220
|
getDataView(): GC.Data.View;
|
|
63221
|
+
/**
|
|
63222
|
+
* get the current table theme of the TableSheet.
|
|
63223
|
+
*/
|
|
63224
|
+
getTableTheme(): GC.Spread.Sheets.Tables.TableTheme;
|
|
61817
63225
|
/**
|
|
61818
63226
|
* group the table sheet by options
|
|
61819
63227
|
* @param {GC.Spread.Sheets.TableSheet.IGroupByOptions[]} options - The options of the groupBy
|
|
@@ -62093,7 +63501,7 @@ declare module GC{
|
|
|
62093
63501
|
}
|
|
62094
63502
|
}
|
|
62095
63503
|
|
|
62096
|
-
|
|
63504
|
+
namespace ThreadedComments{
|
|
62097
63505
|
|
|
62098
63506
|
export interface ILinkBlock{
|
|
62099
63507
|
type: GC.Spread.Sheets.ThreadedComments.ContentType;
|
|
@@ -62414,7 +63822,7 @@ declare module GC{
|
|
|
62414
63822
|
}
|
|
62415
63823
|
}
|
|
62416
63824
|
|
|
62417
|
-
|
|
63825
|
+
namespace Touch{
|
|
62418
63826
|
|
|
62419
63827
|
export class TouchToolStrip{
|
|
62420
63828
|
/**
|
|
@@ -62702,7 +64110,7 @@ declare module GC{
|
|
|
62702
64110
|
|
|
62703
64111
|
}
|
|
62704
64112
|
|
|
62705
|
-
|
|
64113
|
+
namespace Slicers{
|
|
62706
64114
|
|
|
62707
64115
|
export interface ISlicerConditional{
|
|
62708
64116
|
/**
|