@mescius/spread-sheets 17.0.3 → 17.0.4
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 +570 -448
- package/package.json +1 -1
@@ -15074,6 +15074,7 @@ declare module GC{
|
|
15074
15074
|
/**
|
15075
15075
|
* Defines the IME mode to control the state of the Input Method Editor (IME).
|
15076
15076
|
* @enum {number}
|
15077
|
+
* @deprecated This enum currently only works in Internet Explorer.
|
15077
15078
|
* @example
|
15078
15079
|
* ```
|
15079
15080
|
* //This example uses the imeMode method.
|
@@ -16740,6 +16741,7 @@ declare module GC{
|
|
16740
16741
|
/**
|
16741
16742
|
* Gets or sets the imeMode of the cell.
|
16742
16743
|
* @param {GC.Spread.Sheets.ImeMode} [value] The cell imeMode.
|
16744
|
+
* @deprecated This property currently only works in Internet Explorer.
|
16743
16745
|
* @returns {GC.Spread.Sheets.ImeMode|GC.Spread.Sheets.CellRange} If no value is set, returns the cell imeMode; otherwise, returns the cell.
|
16744
16746
|
* @example
|
16745
16747
|
* ```
|
@@ -20551,6 +20553,7 @@ declare module GC{
|
|
20551
20553
|
/**
|
20552
20554
|
* Indicates the Input Method Editor (IME) mode.
|
20553
20555
|
* @type {GC.Spread.Sheets.ImeMode}
|
20556
|
+
* @deprecated This property currently only works in Internet Explorer.
|
20554
20557
|
* @example
|
20555
20558
|
* ```
|
20556
20559
|
* //This example sets the IME mode.
|
@@ -27296,56 +27299,189 @@ declare module GC{
|
|
27296
27299
|
module Charts{
|
27297
27300
|
|
27298
27301
|
export interface ErrorBarItem{
|
27302
|
+
/**
|
27303
|
+
* The error bar type
|
27304
|
+
*/
|
27299
27305
|
type?: number;
|
27306
|
+
/**
|
27307
|
+
* The error bar value type.
|
27308
|
+
*/
|
27300
27309
|
valueType?: number;
|
27310
|
+
/**
|
27311
|
+
* The error bar has end cap or not.
|
27312
|
+
*/
|
27301
27313
|
noEndCap?: boolean;
|
27314
|
+
/**
|
27315
|
+
* The error bar value, just take effect on the FixedValue(1) / Percentage(2) / StandardDeviation(3) value type.
|
27316
|
+
*/
|
27302
27317
|
value?: number;
|
27303
|
-
|
27318
|
+
/**
|
27319
|
+
* The error bar custom formulas, it contains positive formula and negative formula, just take effect on the Custom(0) value type.
|
27320
|
+
*/
|
27321
|
+
custom?: GC.Spread.Sheets.Charts.ErrorBarItemCustom;
|
27322
|
+
/**
|
27323
|
+
* The error bar styles.
|
27324
|
+
*/
|
27325
|
+
style?: GC.Spread.Sheets.Charts.ErrorBarItemStyle;
|
27326
|
+
}
|
27327
|
+
|
27328
|
+
|
27329
|
+
export interface ErrorBarItemCustom{
|
27330
|
+
/**
|
27331
|
+
* The error bar custom positive formula.
|
27332
|
+
*/
|
27304
27333
|
positive: string;
|
27334
|
+
/**
|
27335
|
+
* The error bar custom negative formula.
|
27336
|
+
*/
|
27305
27337
|
negative: string;
|
27306
|
-
};
|
27307
|
-
style?: {
|
27308
|
-
color?: string;
|
27309
|
-
width?: number;
|
27310
|
-
transparency?: number;
|
27311
|
-
dashStyle?: GC.Spread.Sheets.Charts.ILineStyle;
|
27312
|
-
visible?: boolean;
|
27313
|
-
}
|
27314
27338
|
}
|
27315
27339
|
|
27316
27340
|
|
27317
27341
|
export interface ErrorBarItems{
|
27342
|
+
/**
|
27343
|
+
* The vertical error bar of the series, each series may has different direction error bar(s) based on chart type.
|
27344
|
+
*/
|
27318
27345
|
vertical?: GC.Spread.Sheets.Charts.ErrorBarItem;
|
27346
|
+
/**
|
27347
|
+
* The horizontal error bar of the series, each series may has different direction error bar(s) based on chart type.
|
27348
|
+
*/
|
27319
27349
|
horizontal?: GC.Spread.Sheets.Charts.ErrorBarItem;
|
27320
27350
|
}
|
27321
27351
|
|
27322
27352
|
|
27353
|
+
export interface ErrorBarItemStyle{
|
27354
|
+
/**
|
27355
|
+
* The error bar color.
|
27356
|
+
*/
|
27357
|
+
color?: string;
|
27358
|
+
/**
|
27359
|
+
* The error bar width.
|
27360
|
+
*/
|
27361
|
+
width?: number;
|
27362
|
+
/**
|
27363
|
+
* The error bar transparency.
|
27364
|
+
*/
|
27365
|
+
transparency?: number;
|
27366
|
+
/**
|
27367
|
+
* The error bar dashStyle.
|
27368
|
+
*/
|
27369
|
+
dashStyle?: GC.Spread.Sheets.Charts.ILineStyle;
|
27370
|
+
/**
|
27371
|
+
* The error bar visible info.
|
27372
|
+
*/
|
27373
|
+
visible?: boolean;
|
27374
|
+
}
|
27375
|
+
|
27376
|
+
|
27323
27377
|
export interface IAxes{
|
27324
|
-
|
27325
|
-
|
27326
|
-
|
27327
|
-
|
27378
|
+
/**
|
27379
|
+
* The primary category axis of the chart.
|
27380
|
+
*/
|
27381
|
+
primaryCategory?: GC.Spread.Sheets.Charts.IAxis;
|
27382
|
+
/**
|
27383
|
+
* The primary value axis of the chart.
|
27384
|
+
*/
|
27385
|
+
primaryValue?: GC.Spread.Sheets.Charts.IAxis;
|
27386
|
+
/**
|
27387
|
+
* The secondary category axis of the chart.
|
27388
|
+
*/
|
27389
|
+
secondaryCategory?: GC.Spread.Sheets.Charts.IAxis;
|
27390
|
+
/**
|
27391
|
+
* The secondary value axis of the chart.
|
27392
|
+
*/
|
27393
|
+
secondaryValue?: GC.Spread.Sheets.Charts.IAxis;
|
27328
27394
|
}
|
27329
27395
|
|
27330
27396
|
|
27331
27397
|
export interface IAxis{
|
27398
|
+
/**
|
27399
|
+
* Indicates if the specified axis should be shown.
|
27400
|
+
*/
|
27332
27401
|
visible?: boolean;
|
27402
|
+
/**
|
27403
|
+
* The axis tick label position.
|
27404
|
+
*/
|
27333
27405
|
tickLabelPosition?: GC.Spread.Sheets.Charts.TickLabelPosition;
|
27406
|
+
/**
|
27407
|
+
* The line style of the axis.
|
27408
|
+
*/
|
27334
27409
|
lineStyle?: GC.Spread.Sheets.Charts.IBorder;
|
27410
|
+
/**
|
27411
|
+
* The style of the axis.
|
27412
|
+
*/
|
27335
27413
|
style?: GC.Spread.Sheets.Charts.IAxisStyle;
|
27414
|
+
/**
|
27415
|
+
* The major tick position of the axis.
|
27416
|
+
*/
|
27336
27417
|
majorTickPosition?: GC.Spread.Sheets.Charts.TickMark;
|
27418
|
+
/**
|
27419
|
+
* The minor tick position of the axis.
|
27420
|
+
*/
|
27337
27421
|
minorTickPosition?: GC.Spread.Sheets.Charts.TickMark;
|
27422
|
+
/**
|
27423
|
+
* The base unit scale of the date category axis.
|
27424
|
+
*/
|
27425
|
+
baseUnit?: GC.Spread.Sheets.Charts.TimeUnit;
|
27426
|
+
/**
|
27427
|
+
* The major unit of the primary category axis.
|
27428
|
+
*/
|
27338
27429
|
majorUnit?: number;
|
27430
|
+
/**
|
27431
|
+
* The major unit scale of the date category axis.
|
27432
|
+
*/
|
27433
|
+
majorUnitScale?: GC.Spread.Sheets.Charts.TimeUnit;
|
27434
|
+
/**
|
27435
|
+
* The minor unit of the primary category axis.
|
27436
|
+
*/
|
27339
27437
|
minorUnit?: number;
|
27438
|
+
/**
|
27439
|
+
* The minor unit scale of the date category axis.
|
27440
|
+
*/
|
27441
|
+
minorUnitScale?: GC.Spread.Sheets.Charts.TimeUnit;
|
27442
|
+
/**
|
27443
|
+
* The minimum value of the related axis. (for value / date axis only)
|
27444
|
+
*/
|
27340
27445
|
min?: number | Date;
|
27446
|
+
/**
|
27447
|
+
* The maximum value of the related axis. (for value / date axis only)
|
27448
|
+
*/
|
27341
27449
|
max?: number | Date;
|
27450
|
+
/**
|
27451
|
+
* The format of the axis.
|
27452
|
+
*/
|
27342
27453
|
format?: string;
|
27454
|
+
/**
|
27455
|
+
* Whether to apply the format of the linked data source.
|
27456
|
+
*/
|
27457
|
+
numberFormatLinked?: boolean;
|
27458
|
+
/**
|
27459
|
+
* The title of the axis.
|
27460
|
+
*/
|
27343
27461
|
title?: GC.Spread.Sheets.Charts.IAxisTitle;
|
27462
|
+
/**
|
27463
|
+
* The major grid line of the axis.
|
27464
|
+
*/
|
27344
27465
|
majorGridLine?: GC.Spread.Sheets.Charts.IGridLine;
|
27466
|
+
/**
|
27467
|
+
* The minor grid line of the axis.
|
27468
|
+
*/
|
27345
27469
|
minorGridLine?: GC.Spread.Sheets.Charts.IGridLine;
|
27470
|
+
/**
|
27471
|
+
* The label angle of the axis.
|
27472
|
+
*/
|
27346
27473
|
labelAngle?: number;
|
27474
|
+
/**
|
27475
|
+
* The scaling informations of the axis.
|
27476
|
+
*/
|
27347
27477
|
scaling?: GC.Spread.Sheets.Charts.IScaling;
|
27478
|
+
/**
|
27479
|
+
* The display unit informations of the axis.
|
27480
|
+
*/
|
27348
27481
|
displayUnit?: GC.Spread.Sheets.Charts.IDisplayUnit;
|
27482
|
+
/**
|
27483
|
+
* Indicates the axis crosses value.
|
27484
|
+
*/
|
27349
27485
|
crossPoint?: number | GC.Spread.Sheets.Charts.AxisCrossPoint
|
27350
27486
|
}
|
27351
27487
|
|
@@ -27376,25 +27512,95 @@ declare module GC{
|
|
27376
27512
|
|
27377
27513
|
|
27378
27514
|
export interface IChartArea{
|
27515
|
+
/**
|
27516
|
+
* The background color of the chart area.
|
27517
|
+
*/
|
27379
27518
|
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27519
|
+
/**
|
27520
|
+
* The transparency of the chart area backColor.
|
27521
|
+
*/
|
27380
27522
|
backColorTransparency?: number;
|
27523
|
+
/**
|
27524
|
+
* The font family of the chart area.
|
27525
|
+
*/
|
27381
27526
|
fontFamily?: string;
|
27527
|
+
/**
|
27528
|
+
* The font size of the chart area, its unit is pixel.
|
27529
|
+
*/
|
27382
27530
|
fontSize?: number;
|
27531
|
+
/**
|
27532
|
+
* The color of the chart area.
|
27533
|
+
*/
|
27383
27534
|
color?: string;
|
27535
|
+
/**
|
27536
|
+
* The transparency of the chart area color.
|
27537
|
+
*/
|
27384
27538
|
transparency?: number;
|
27539
|
+
/**
|
27540
|
+
* The border of the chart area.
|
27541
|
+
*/
|
27385
27542
|
border?: GC.Spread.Sheets.Charts.IBorder;
|
27386
27543
|
}
|
27387
27544
|
|
27388
27545
|
|
27389
27546
|
export interface IChartLegend{
|
27547
|
+
/**
|
27548
|
+
* The position of the chart legend.
|
27549
|
+
*/
|
27390
27550
|
position?: GC.Spread.Sheets.Charts.LegendPosition;
|
27551
|
+
/**
|
27552
|
+
* The visibility of the chart legend.
|
27553
|
+
*/
|
27391
27554
|
visible?: boolean;
|
27555
|
+
/**
|
27556
|
+
* The backgroundColor of the chart legend.
|
27557
|
+
*/
|
27392
27558
|
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27559
|
+
/**
|
27560
|
+
* The transparency of the chart legend color
|
27561
|
+
*/
|
27393
27562
|
backColorTransparency?: number;
|
27563
|
+
/**
|
27564
|
+
* The borderStyle of the chart legend.
|
27565
|
+
*/
|
27394
27566
|
borderStyle?: GC.Spread.Sheets.Charts.IBorder;
|
27567
|
+
/**
|
27568
|
+
* The border color of the chart legend.
|
27569
|
+
*/
|
27395
27570
|
color?: string;
|
27571
|
+
/**
|
27572
|
+
* The font family of the chart legend text.
|
27573
|
+
*/
|
27396
27574
|
fontFamily?: string;
|
27575
|
+
/**
|
27576
|
+
* The font size of the chart legend text.
|
27577
|
+
*/
|
27397
27578
|
fontSize?: number;
|
27579
|
+
/**
|
27580
|
+
* whether the legend display without overlapping chart area.
|
27581
|
+
*/
|
27582
|
+
showLegendWithoutOverlapping?: boolean;
|
27583
|
+
layout?: GC.Spread.Sheets.Charts.IChartLegendLayout
|
27584
|
+
}
|
27585
|
+
|
27586
|
+
|
27587
|
+
export interface IChartLegendLayout{
|
27588
|
+
/**
|
27589
|
+
* The x position of the chart legend, it's percentage, and the base line is chart's left edge.
|
27590
|
+
*/
|
27591
|
+
x?:number;
|
27592
|
+
/**
|
27593
|
+
* The y position of the chart legend, it's percentage, and the base line is chart's top edge.
|
27594
|
+
*/
|
27595
|
+
y?:number;
|
27596
|
+
/**
|
27597
|
+
* The width of the chart legend, it's percentage, and it's based on the chart's width.
|
27598
|
+
*/
|
27599
|
+
width?: number;
|
27600
|
+
/**
|
27601
|
+
* The height of the chart legend, it's percentage, and it's based on the chart's height.
|
27602
|
+
*/
|
27603
|
+
height?: number;
|
27398
27604
|
}
|
27399
27605
|
|
27400
27606
|
|
@@ -27407,48 +27613,171 @@ declare module GC{
|
|
27407
27613
|
|
27408
27614
|
|
27409
27615
|
export interface IChartTitle{
|
27616
|
+
/**
|
27617
|
+
* The text of the chart title.
|
27618
|
+
*/
|
27410
27619
|
text?: string;
|
27620
|
+
/**
|
27621
|
+
* The font family of the chart title.
|
27622
|
+
*/
|
27411
27623
|
fontFamily?: string;
|
27624
|
+
/**
|
27625
|
+
* The font size of the chart title, its unit is pixel.
|
27626
|
+
*/
|
27412
27627
|
fontSize?: number;
|
27628
|
+
/**
|
27629
|
+
* The color of the chart title.
|
27630
|
+
*/
|
27413
27631
|
color?: string;
|
27632
|
+
/**
|
27633
|
+
* The transparency of the chart title color
|
27634
|
+
*/
|
27414
27635
|
transparency?:number;
|
27636
|
+
/**
|
27637
|
+
* The background color of the chart title area.
|
27638
|
+
*/
|
27415
27639
|
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27640
|
+
/**
|
27641
|
+
* The transparency of the chart title area backColor.
|
27642
|
+
*/
|
27416
27643
|
backColorTransparency?: number;
|
27417
27644
|
}
|
27418
27645
|
|
27419
27646
|
|
27420
27647
|
export interface IDataLabels{
|
27648
|
+
/**
|
27649
|
+
* Whether to show category name in data labels.
|
27650
|
+
*/
|
27421
27651
|
showCategoryName?: boolean;
|
27652
|
+
/**
|
27653
|
+
* Whether to show series name in data labels.
|
27654
|
+
*/
|
27422
27655
|
showSeriesName?: boolean;
|
27656
|
+
/**
|
27657
|
+
* Whether to show value in data labels.
|
27658
|
+
*/
|
27423
27659
|
showValue?: boolean;
|
27660
|
+
/**
|
27661
|
+
* Whether to show the percent value in data labels.
|
27662
|
+
*/
|
27424
27663
|
showPercentage?: boolean;
|
27664
|
+
/**
|
27665
|
+
* The position of the chart data labels.
|
27666
|
+
*/
|
27425
27667
|
position?: GC.Spread.Sheets.Charts.DataLabelPosition;
|
27668
|
+
/**
|
27669
|
+
* The format of the chart data labels.
|
27670
|
+
*/
|
27426
27671
|
format?: string;
|
27672
|
+
/**
|
27673
|
+
* Whether to apply the format of the linked data source.
|
27674
|
+
*/
|
27675
|
+
numberFormatLinked?: boolean;
|
27676
|
+
/**
|
27677
|
+
* The color of the chart data labels.
|
27678
|
+
*/
|
27427
27679
|
color?: string;
|
27680
|
+
/**
|
27681
|
+
* The transparency of the chart data labels color.
|
27682
|
+
*/
|
27428
27683
|
transparency?: number;
|
27684
|
+
/**
|
27685
|
+
* the separator of the series data labels.
|
27686
|
+
*/
|
27429
27687
|
separator?: string;
|
27688
|
+
/**
|
27689
|
+
* The background color of the series data labels.
|
27690
|
+
*/
|
27430
27691
|
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27692
|
+
/**
|
27693
|
+
* The background color transparency of the series data labels.
|
27694
|
+
*/
|
27431
27695
|
backColorTransparency?: number;
|
27696
|
+
/**
|
27697
|
+
* The border color of the series data labels.
|
27698
|
+
*/
|
27432
27699
|
borderColor?: string;
|
27700
|
+
/**
|
27701
|
+
* The border width of the series data labels.
|
27702
|
+
*/
|
27433
27703
|
borderWidth?: number;
|
27704
|
+
/**
|
27705
|
+
* The border color transparency of the series data labels.
|
27706
|
+
*/
|
27434
27707
|
borderColorTransparency?: number;
|
27435
27708
|
}
|
27436
27709
|
|
27437
27710
|
|
27438
27711
|
export interface IDataPoint{
|
27439
|
-
|
27712
|
+
/**
|
27713
|
+
* The background color of the data point or symbol point.
|
27714
|
+
*/
|
27715
|
+
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27716
|
+
/**
|
27717
|
+
* The background color transparency of the data point or symbol point.
|
27718
|
+
*/
|
27440
27719
|
backColorTransparency?: number;
|
27720
|
+
/**
|
27721
|
+
* The border style of the data point.
|
27722
|
+
*/
|
27441
27723
|
border?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27724
|
+
/**
|
27725
|
+
* The symbol size of the data point.
|
27726
|
+
*/
|
27442
27727
|
symbolSize?: number;
|
27443
|
-
|
27728
|
+
/**
|
27729
|
+
* The symbol shape of the data point.
|
27730
|
+
*/
|
27731
|
+
symbolShape?: GC.Spread.Sheets.Charts.SymbolShape;
|
27732
|
+
/**
|
27733
|
+
* The symbol border of the data point.
|
27734
|
+
*/
|
27444
27735
|
symbolBorder?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27445
27736
|
}
|
27446
27737
|
|
27447
27738
|
|
27739
|
+
export interface IDataPoints{
|
27740
|
+
[key: number]: GC.Spread.Sheets.Charts.IDataPoint;
|
27741
|
+
}
|
27742
|
+
|
27743
|
+
|
27448
27744
|
export interface IDisplayUnit{
|
27745
|
+
/**
|
27746
|
+
* The built-in display unit string or custom number display unit of the axis.
|
27747
|
+
*/
|
27449
27748
|
unit?: number | GC.Spread.Sheets.Charts.DisplayUnit;
|
27749
|
+
/**
|
27750
|
+
* The display unit label visible of the axis.
|
27751
|
+
*/
|
27450
27752
|
visible?: boolean;
|
27451
|
-
|
27753
|
+
/**
|
27754
|
+
* The display unit label style of the axis.
|
27755
|
+
*/
|
27756
|
+
style?: GC.Spread.Sheets.Charts.IChartTextStyle;
|
27757
|
+
}
|
27758
|
+
|
27759
|
+
|
27760
|
+
export interface IFormatOver{
|
27761
|
+
/**
|
27762
|
+
* The background color of the specific points collection.
|
27763
|
+
*/
|
27764
|
+
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27765
|
+
/**
|
27766
|
+
* The background color transparency of the specific points collection.
|
27767
|
+
*/
|
27768
|
+
backColorTransparency?: number;
|
27769
|
+
/**
|
27770
|
+
* The border style of the specific points collection.
|
27771
|
+
*/
|
27772
|
+
borderStyle?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27773
|
+
}
|
27774
|
+
|
27775
|
+
|
27776
|
+
export interface IFormatOvers{
|
27777
|
+
/**
|
27778
|
+
* The object type that key is number type, For waterfall chart, 0 represents increase,1 represents decrease, 2 represents totals, the key value is IFormatOver type.
|
27779
|
+
*/
|
27780
|
+
[key: number]: GC.Spread.Sheets.Charts.IFormatOver;
|
27452
27781
|
}
|
27453
27782
|
|
27454
27783
|
|
@@ -27461,9 +27790,21 @@ declare module GC{
|
|
27461
27790
|
|
27462
27791
|
|
27463
27792
|
export interface IHoverStyle{
|
27793
|
+
/**
|
27794
|
+
* The color of the dataPoint been hovered.
|
27795
|
+
*/
|
27464
27796
|
color?:string;
|
27797
|
+
/**
|
27798
|
+
* The color transparency of the dataPoint been hovered.
|
27799
|
+
*/
|
27465
27800
|
transparency?:number;
|
27801
|
+
/**
|
27802
|
+
* The border of the dataPoint been hovered.
|
27803
|
+
*/
|
27466
27804
|
borderStyle?: GC.Spread.Sheets.Charts.IBorder;
|
27805
|
+
/**
|
27806
|
+
* The symbol style of the dataPoint been hovered.
|
27807
|
+
*/
|
27467
27808
|
symbolStyle?: GC.Spread.Sheets.Charts.IHoverSymbolStyle;
|
27468
27809
|
}
|
27469
27810
|
|
@@ -27501,42 +27842,111 @@ declare module GC{
|
|
27501
27842
|
|
27502
27843
|
|
27503
27844
|
export interface IScaling{
|
27845
|
+
/**
|
27846
|
+
* Indicates the specified axis order.
|
27847
|
+
*/
|
27504
27848
|
orientation?: number | GC.Spread.Sheets.Charts.AxisOrientation;
|
27849
|
+
/**
|
27850
|
+
* The logarithmic scaling base value of the primary category axis.
|
27851
|
+
*/
|
27505
27852
|
logBase?: number;
|
27506
27853
|
}
|
27507
27854
|
|
27508
27855
|
|
27509
|
-
export interface ISeries
|
27856
|
+
export interface ISeries{
|
27857
|
+
/**
|
27858
|
+
* The chart type of the series.
|
27859
|
+
*/
|
27510
27860
|
chartType?: GC.Spread.Sheets.Charts.ChartType;
|
27861
|
+
/**
|
27862
|
+
* The axis group of the series.
|
27863
|
+
*/
|
27511
27864
|
axisGroup?: GC.Spread.Sheets.Charts.AxisGroup;
|
27865
|
+
/**
|
27866
|
+
* The name formula of the series.
|
27867
|
+
*/
|
27512
27868
|
name?: string;
|
27869
|
+
/**
|
27870
|
+
* The x values formula of the series.
|
27871
|
+
*/
|
27513
27872
|
xValues?: string;
|
27873
|
+
/**
|
27874
|
+
* The y values formula of the series.
|
27875
|
+
*/
|
27514
27876
|
yValues?: string;
|
27515
|
-
|
27516
|
-
|
27517
|
-
|
27518
|
-
export interface ISeriesItemBase{
|
27877
|
+
/**
|
27878
|
+
* The background color of the series.
|
27879
|
+
*/
|
27519
27880
|
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27881
|
+
/**
|
27882
|
+
* The series point value is negative color when seriesItem type is column or bar chart and invertIfNegative is true.
|
27883
|
+
*/
|
27520
27884
|
invertIfNegative?: boolean;
|
27885
|
+
/**
|
27886
|
+
* Whether the series show connector lines. This is used for waterfall chart, The default value is false.
|
27887
|
+
*/
|
27521
27888
|
showConnectorLines?: boolean;
|
27889
|
+
/**
|
27890
|
+
* The waterfall chart set as total points index array(0 base). This is used for waterfall chart, The default value is empty array.
|
27891
|
+
*/
|
27522
27892
|
subtotals?: number[];
|
27893
|
+
/**
|
27894
|
+
* The series point value is negative color when seriesItem type is column or bar chart and invertIfNegative is true.
|
27895
|
+
*/
|
27523
27896
|
invertColor?: string;
|
27897
|
+
/**
|
27898
|
+
* The transparency of the series background color.
|
27899
|
+
*/
|
27524
27900
|
backColorTransparency?: number;
|
27901
|
+
/**
|
27902
|
+
* The border of the series.
|
27903
|
+
*/
|
27525
27904
|
border?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27905
|
+
/**
|
27906
|
+
* The first slice angle of the chart whose chart type is pie. The default value is 0, which represents the 12 o'clock position.
|
27907
|
+
*/
|
27526
27908
|
startAngle?: number;
|
27909
|
+
/**
|
27910
|
+
* The bubble sizes formula of the series. This is used for bubble chart.
|
27911
|
+
*/
|
27527
27912
|
bubbleSizes?: string;
|
27913
|
+
/**
|
27914
|
+
* The data labels of the series.
|
27915
|
+
*/
|
27528
27916
|
dataLabels?: GC.Spread.Sheets.Charts.IDataLabels;
|
27917
|
+
/**
|
27918
|
+
* The symbol of the series.
|
27919
|
+
*/
|
27529
27920
|
symbol?: GC.Spread.Sheets.Charts.ISymbol;
|
27921
|
+
/**
|
27922
|
+
* The error bars of the series.
|
27923
|
+
*/
|
27530
27924
|
errorBars?: GC.Spread.Sheets.Charts.ErrorBarItems;
|
27925
|
+
/**
|
27926
|
+
* The trendlines of the series.
|
27927
|
+
*/
|
27531
27928
|
trendlines?: GC.Spread.Sheets.Charts.TrendlineItem[];
|
27532
27929
|
plotVisibleOnly?: boolean;
|
27930
|
+
/**
|
27931
|
+
* The hole size of the doughnut chart. This is used for doughnut chart, The maximum value is 0.9, the minimum value is 0.
|
27932
|
+
*/
|
27533
27933
|
doughnutHoleSize?: number;
|
27934
|
+
/**
|
27935
|
+
* Whether to display smooth lines. This is used for line chart and scatter chart.
|
27936
|
+
*/
|
27534
27937
|
smooth?: boolean;
|
27938
|
+
/**
|
27939
|
+
* The gap width of the bar and column chart group. The maximum value is 5, the minimum value is 0.
|
27940
|
+
*/
|
27535
27941
|
gapWidth?: number;
|
27942
|
+
/**
|
27943
|
+
* The overlap of the bar and column chart group. The maximum value is 1, the minimum value is -1.
|
27944
|
+
*/
|
27536
27945
|
overlap?: number;
|
27537
|
-
|
27538
|
-
|
27539
|
-
|
27946
|
+
/**
|
27947
|
+
* The data points of the series.
|
27948
|
+
*/
|
27949
|
+
dataPoints?: GC.Spread.Sheets.Charts.IDataPoints;
|
27540
27950
|
}
|
27541
27951
|
|
27542
27952
|
|
@@ -27550,112 +27960,108 @@ declare module GC{
|
|
27550
27960
|
|
27551
27961
|
|
27552
27962
|
export interface ISeriesSymbolBorder{
|
27963
|
+
/**
|
27964
|
+
* The symbol border color of the series.
|
27965
|
+
*/
|
27553
27966
|
color?: string;
|
27967
|
+
/**
|
27968
|
+
* The transparency of the symbol border color.
|
27969
|
+
*/
|
27554
27970
|
colorTransparency?: number;
|
27971
|
+
/**
|
27972
|
+
* The transparency of the symbol border color.
|
27973
|
+
*/
|
27555
27974
|
transparency?: number;
|
27975
|
+
/**
|
27976
|
+
* The symbol border width of the series.
|
27977
|
+
*/
|
27556
27978
|
width?: number;
|
27979
|
+
/**
|
27980
|
+
* The symbol border line Type of the series.
|
27981
|
+
*/
|
27557
27982
|
lineType?: number;
|
27558
27983
|
}
|
27559
27984
|
|
27560
27985
|
|
27561
27986
|
export interface ISymbol{
|
27987
|
+
/**
|
27988
|
+
* The symbol fill color of the series.
|
27989
|
+
*/
|
27562
27990
|
fill: string;
|
27991
|
+
/**
|
27992
|
+
* The transparency of the symbol fill color.
|
27993
|
+
*/
|
27563
27994
|
fillColorTransparency: number;
|
27995
|
+
/**
|
27996
|
+
* The symbol size of the series.
|
27997
|
+
*/
|
27564
27998
|
size: number;
|
27999
|
+
/**
|
28000
|
+
* The symbol shape of the series.
|
28001
|
+
*/
|
27565
28002
|
shape: GC.Spread.Sheets.Charts.SymbolShape;
|
28003
|
+
/**
|
28004
|
+
* The symbol border of the series.
|
28005
|
+
*/
|
27566
28006
|
border: GC.Spread.Sheets.Charts.ISeriesSymbolBorder;
|
27567
28007
|
}
|
27568
28008
|
|
27569
28009
|
|
27570
|
-
export interface ITrendline{
|
27571
|
-
type?: GC.Spread.Sheets.Charts.TrendlineType;
|
27572
|
-
order?: number;
|
27573
|
-
period?: number;
|
27574
|
-
intercept?: number;
|
27575
|
-
forward?: number;
|
27576
|
-
backward?: number;
|
27577
|
-
displayEquation?: boolean;
|
27578
|
-
displayRSquared?: boolean;
|
27579
|
-
fontFamily?: string;
|
27580
|
-
fontSize?: number;
|
27581
|
-
fontColor?: string;
|
27582
|
-
name?: string;
|
27583
|
-
style?: GC.Spread.Sheets.Charts.ILineStyle;
|
27584
|
-
}
|
27585
|
-
|
27586
|
-
|
27587
28010
|
export interface TrendlineItem{
|
28011
|
+
/**
|
28012
|
+
* The type of the trendline.
|
28013
|
+
*/
|
27588
28014
|
type?: GC.Spread.Sheets.Charts.TrendlineType;
|
27589
|
-
|
28015
|
+
/**
|
28016
|
+
* The order of the polynomial trendline.
|
28017
|
+
*/
|
27590
28018
|
order?: number;
|
28019
|
+
/**
|
28020
|
+
* The period of the movingAverage trendline.
|
28021
|
+
*/
|
27591
28022
|
period?: number;
|
27592
|
-
|
28023
|
+
/**
|
28024
|
+
* The line style of the trendline.
|
28025
|
+
*/
|
27593
28026
|
style?: GC.Spread.Sheets.Charts.ILineStyle;
|
28027
|
+
/**
|
28028
|
+
* The intercept of the trendline.
|
28029
|
+
*/
|
27594
28030
|
intercept?: number;
|
28031
|
+
/**
|
28032
|
+
* The forward of the trendline.
|
28033
|
+
*/
|
27595
28034
|
forward?: number;
|
28035
|
+
/**
|
28036
|
+
* The backward of the trendline.
|
28037
|
+
*/
|
27596
28038
|
backward?: number;
|
28039
|
+
/**
|
28040
|
+
* Whether display the equation of the trendline.
|
28041
|
+
*/
|
27597
28042
|
displayEquation?: boolean;
|
28043
|
+
/**
|
28044
|
+
* Whether display the R squared of the trendline.
|
28045
|
+
*/
|
27598
28046
|
displayRSquared?: boolean;
|
28047
|
+
/**
|
28048
|
+
* The name of the trendline.
|
28049
|
+
*/
|
27599
28050
|
name?: string;
|
28051
|
+
/**
|
28052
|
+
* The fontFamily of the trendline.
|
28053
|
+
*/
|
27600
28054
|
fontFamily?: string;
|
28055
|
+
/**
|
28056
|
+
* The fontSize of the trendline.
|
28057
|
+
*/
|
27601
28058
|
fontSize?: number;
|
28059
|
+
/**
|
28060
|
+
* The fontColor of the trendline.
|
28061
|
+
*/
|
27602
28062
|
fontColor?: string;
|
27603
28063
|
}
|
27604
28064
|
|
27605
|
-
|
27606
|
-
/**
|
27607
|
-
* @typedef {object} GC.Spread.Sheets.Charts.IDataPointStyle
|
27608
|
-
* @property {string | GC.Spread.Sheets.Charts.IPatternFillBackColor} backColor The background color of the data point or symbol point.
|
27609
|
-
* @property {number} backColorTransparency The background color transparency of the data point or symbol point.
|
27610
|
-
* @property {GC.Spread.Sheets.Charts.ISeriesItemBorder} border The border style of the data point.
|
27611
|
-
* @property {Object} border.color The border color of the data point.
|
27612
|
-
* @property {number} border.transparency The border color transparency of the data point.
|
27613
|
-
* @property {number} border.width The border width of the data point.
|
27614
|
-
* @property {GC.Spread.Sheets.Charts.LineType} border.lineType The border line type of the data point.
|
27615
|
-
* @property {number} symbolSize The symbol size of the data point.
|
27616
|
-
* @property {GC.Spread.Sheets.Charts.SymbolShape} symbolShape The symbol shape of the data point.
|
27617
|
-
* @property {GC.Spread.Sheets.Charts.ISeriesItemBorder} symbolBorder The symbol border of the data point.
|
27618
|
-
* @property {string} symbolBorder.color The symbol border color of the data point.
|
27619
|
-
* @property {number} symbolBorder.colorTransparency The transparency of the data point symbol border color.
|
27620
|
-
* @property {number} symbolBorder.width The symbol border width of the data point.
|
27621
|
-
* @property {GC.Spread.Sheets.Charts.LineType} symbolBorder.lineType The symbol border line Type of the data point.
|
27622
|
-
*/
|
27623
|
-
export type IDataPointStyle =
|
27624
|
-
{
|
27625
|
-
backColor: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27626
|
-
backColorTransparency?: number;
|
27627
|
-
border?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27628
|
-
}
|
27629
|
-
|
27630
|
-
|
27631
|
-
/**
|
27632
|
-
* @typedef {object} GC.Spread.Sheets.Charts.IFormatOver
|
27633
|
-
* @property {string | GC.Spread.Sheets.Charts.IPatternFillBackColor} backColor The background color of the specific points collection.
|
27634
|
-
* @property {number} backColorTransparency The background color transparency of the specific points collection.
|
27635
|
-
* @property {GC.Spread.Sheets.Charts.ISeriesItemBorder} borderStyle The border style of the specific points collection.
|
27636
|
-
* @property {Object} borderStyle.color The border color of the specific points collection.
|
27637
|
-
* @property {number} borderStyle.transparency The border color transparency of the specific points collection.
|
27638
|
-
* @property {number} borderStyle.width The border width of the specific points collection.
|
27639
|
-
* @property {GC.Spread.Sheets.Charts.LineType} borderStyle.lineType The border line type of the specific points collection.
|
27640
|
-
*/
|
27641
|
-
export type IFormatOver =
|
27642
|
-
{
|
27643
|
-
backColor?: string | GC.Spread.Sheets.Charts.IPatternFillBackColor;
|
27644
|
-
backColorTransparency?: number;
|
27645
|
-
borderStyle?: GC.Spread.Sheets.Charts.ISeriesItemBorder;
|
27646
|
-
}
|
27647
|
-
|
27648
|
-
|
27649
|
-
/**
|
27650
|
-
* @typedef GC.Spread.Sheets.Charts.IFormatOvers
|
27651
|
-
* @property {Object.<number, GC.Spread.Sheets.Charts.IFormatOver>} -The object type that key is number type
|
27652
|
-
* For waterfall chart, 0 represents increase,1 represents decrease, 2 represents totals, the key value is IFormatOver type
|
27653
|
-
*/
|
27654
|
-
export type IFormatOvers =
|
27655
|
-
{
|
27656
|
-
[key: number]: GC.Spread.Sheets.Charts.IFormatOver;
|
27657
|
-
}
|
27658
|
-
|
27659
28065
|
/**
|
27660
28066
|
* Specifies the point on the specified axis where the other axis crosses.
|
27661
28067
|
* @enum {string}
|
@@ -27868,6 +28274,33 @@ declare module GC{
|
|
27868
28274
|
clusteredColumn= 60
|
27869
28275
|
}
|
27870
28276
|
|
28277
|
+
/**
|
28278
|
+
* Specifies the color rule of the color style
|
28279
|
+
* @enum {number}
|
28280
|
+
*/
|
28281
|
+
export enum ColorRule{
|
28282
|
+
/**
|
28283
|
+
* Specifies the color picked from the color list is the index modulus the color list length.
|
28284
|
+
*/
|
28285
|
+
cycle= 0,
|
28286
|
+
/**
|
28287
|
+
* Specifies the color picked from the color list is the first color with a brightness that varies from darker to lighter based on how close the index is from 0 and the count of the chart series being colored respectively.
|
28288
|
+
*/
|
28289
|
+
withinLinear= 1,
|
28290
|
+
/**
|
28291
|
+
* Specifies the color picked from the color list is the index modulus the color list length. The color has a brightness that varies from darker to lighter based on how close the index is from 0 and the count of the chart series being colored respectively.
|
28292
|
+
*/
|
28293
|
+
acrossLinear= 2,
|
28294
|
+
/**
|
28295
|
+
* Specifies the color picked from the color list is the first color with a brightness that varies from lighter to darker based on how close the index is from 0 and the count of the chart series being colored respectively.
|
28296
|
+
*/
|
28297
|
+
withinLinearReversed= 3,
|
28298
|
+
/**
|
28299
|
+
* Specifies the color picked from the color list is the index modulus the color list length. The color has a brightness that varies from lighter to darker based on how close the index is from 0 and the count of the chart series being colored respectively.
|
28300
|
+
*/
|
28301
|
+
acrossLinearReversed= 4
|
28302
|
+
}
|
28303
|
+
|
27871
28304
|
/**
|
27872
28305
|
* Specifies where the data label is positioned.
|
27873
28306
|
* @enum {number}
|
@@ -28412,6 +28845,25 @@ declare module GC{
|
|
28412
28845
|
outside= 3
|
28413
28846
|
}
|
28414
28847
|
|
28848
|
+
/**
|
28849
|
+
* Specifies unit of time for chart axis and data series.
|
28850
|
+
* @enum {number}
|
28851
|
+
*/
|
28852
|
+
export enum TimeUnit{
|
28853
|
+
/**
|
28854
|
+
* Days.
|
28855
|
+
*/
|
28856
|
+
days= 0,
|
28857
|
+
/**
|
28858
|
+
* Months.
|
28859
|
+
*/
|
28860
|
+
months= 1,
|
28861
|
+
/**
|
28862
|
+
* Years.
|
28863
|
+
*/
|
28864
|
+
years= 2
|
28865
|
+
}
|
28866
|
+
|
28415
28867
|
/**
|
28416
28868
|
* Specifies how the trendline that smoothes out fluctuations in the data is calculated.
|
28417
28869
|
* @enum {number}
|
@@ -28485,64 +28937,8 @@ declare module GC{
|
|
28485
28937
|
alt(value?: string): any;
|
28486
28938
|
/**
|
28487
28939
|
* Gets or sets the chart axes of the chart.
|
28488
|
-
* @param {
|
28489
|
-
* @
|
28490
|
-
* @param {Object} value.primaryValue The primary value axis of the chart.
|
28491
|
-
* @param {Object} value.secondaryCategory The secondary category axis of the chart.
|
28492
|
-
* @param {Object} value.secondaryValue The secondary value axis of the chart.
|
28493
|
-
*
|
28494
|
-
* The primaryCategory, primaryValue, secondaryCategory and secondaryValue have same type.
|
28495
|
-
* @param {boolean} value.primaryCategory.visible Indicates if the specified axis should be shown.
|
28496
|
-
* @param {GC.Spread.Sheets.Charts.TickLabelPosition} value.primaryCategory.tickLabelPosition The tick label position.
|
28497
|
-
* @param {number | GC.Spread.Sheets.Charts.AxisCrossPoint} value.primaryCategory.crossPoint Indicates the axis crosses value.
|
28498
|
-
* @param {Object} value.primaryCategory.lineStyle The line style of the primary category axis.
|
28499
|
-
* @param {string} value.primaryCategory.lineStyle.color The line color of the primary category axis.
|
28500
|
-
* @param {number} value.primaryCategory.lineStyle.transparency The transparency of the chart primary category axis line color.
|
28501
|
-
* @param {number} value.primaryCategory.lineStyle.width The line width of the primary category axis.
|
28502
|
-
* @param {Object} value.primaryCategory.style The style of the primary category axis.
|
28503
|
-
* @param {string} value.primaryCategory.style.color The color of the primary category axis.
|
28504
|
-
* @param {number} value.primaryCategory.style.transparency The transparency of the chart primary category axis color.
|
28505
|
-
* @param {string} value.primaryCategory.style.fontFamily The font family of the primary category axis.
|
28506
|
-
* @param {number} value.primaryCategory.style.fontSize The font size of the primary category axis, its unit is pixel.
|
28507
|
-
* @param {GC.Spread.Sheets.Charts.TickMark} value.primaryCategory.majorTickPosition The major tick position of the primary category axis.
|
28508
|
-
* @param {GC.Spread.Sheets.Charts.TickMark} value.primaryCategory.minorTickPosition The minor tick position of the primary category axis.
|
28509
|
-
* @param {GC.Spread.Sheets.Charts.TimeUnit} value.primaryCategory.baseUnit The base unit scale of the date primary category axis.
|
28510
|
-
* @param {number} value.primaryCategory.majorUnit The major unit of the primary category axis.
|
28511
|
-
* @param {GC.Spread.Sheets.Charts.TimeUnit} value.primaryCategory.majorUnitScale The major unit scale of the date primary category axis.
|
28512
|
-
* @param {number} value.primaryCategory.minorUnit The minor unit of the primary category axis.
|
28513
|
-
* @param {GC.Spread.Sheets.Charts.TimeUnit} value.primaryCategory.minorUnitScale The minor unit scale of the date primary category axis.
|
28514
|
-
* @param {number | Date} value.primaryCategory.min The minimum value of the related axis. (for value / date axis only)
|
28515
|
-
* @param {number | Date} value.primaryCategory.max The maximum value of the related axis. (for value / date axis only)
|
28516
|
-
* @param {string} value.primaryCategory.format The format of the primary category axis.
|
28517
|
-
* @param {Object} value.primaryCategory.title The title of the primary category axis.
|
28518
|
-
* @param {string} value.primaryCategory.title.text The title text of the primary category axis.
|
28519
|
-
* @param {string} value.primaryCategory.title.color The title color of the primary category axis.
|
28520
|
-
* @param {number} value.primaryCategory.title.transparency The transparency of the primary category axis color.
|
28521
|
-
* @param {string} value.primaryCategory.title.fontFamily The title font family of the primary category axis.
|
28522
|
-
* @param {number} value.primaryCategory.title.fontSize The title font size of the primary category axis, its unit is pixel.
|
28523
|
-
* @param {Object} value.primaryCategory.majorGridLine The major grid line of the primary category axis.
|
28524
|
-
* @param {Object} value.primaryCategory.minorGridLine The minor grid line of the primary category axis.
|
28525
|
-
* @param {number} value.primaryCategory.labelAngle The label angle of the primary category axis.
|
28526
|
-
* @param {Object} value.primaryCategory.scaling The scaling informations of the primary category axis.
|
28527
|
-
* @param {number} value.primaryCategory.scaling.logBase The logarithmic scaling base value of the primary category axis.
|
28528
|
-
* @param {number | GC.Spread.Sheets.Charts.AxisOrientation} value.primaryCategory.scaling.orientation Indicates the specified axis order.
|
28529
|
-
* @param {Object} value.primaryCategory.displayUnit The display unit informations of the primary category axis.
|
28530
|
-
* @param {number | GC.Spread.Sheets.Charts.DisplayUnit} value.primaryCategory.displayUnit.unit The built-in display unit string or custom number display unit of the primary category axis.
|
28531
|
-
* @param {boolean} value.primaryCategory.displayUnit.visible The display unit label visible of the primary category axis.
|
28532
|
-
* @param {Object} value.primaryCategory.displayUnit.style The display unit label style of the primary category axis.
|
28533
|
-
* @param {string} value.primaryCategory.displayUnit.style.color The display unit label text color of the primary category axis.
|
28534
|
-
* @param {number} value.primaryCategory.displayUnit.style.transparency The display unit label text transparency of the primary category axis color.
|
28535
|
-
* @param {string} value.primaryCategory.displayUnit.style.fontFamily The display unit label text font family of the primary category axis.
|
28536
|
-
* @param {number} value.primaryCategory.displayUnit.style.fontSize The display unit label text font size of the primary category axis, its unit is pixel.
|
28537
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart axes of the chart; otherwise, returns the chart.
|
28538
|
-
*
|
28539
|
-
* The majorGridLine and minorGridLine have same type.
|
28540
|
-
* @param {string} value.primaryCategory.majorGridLine.color The color of the major grid line.
|
28541
|
-
* @param {boolean} value.primaryCategory.majorGridLine.visible The visibility of the major grid line.
|
28542
|
-
* @param {number} value.primaryCategory.majorGridLine.width The width of the major grid line.
|
28543
|
-
* @param {number} value.primaryCategory.majorGridLine.transparency The transparency of the major grid line color.
|
28544
|
-
*
|
28545
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart axes of the chart; otherwise, returns the chart.
|
28940
|
+
* @param {GC.Spread.Sheets.Charts.IAxes} [value] The chart axes of the chart.
|
28941
|
+
* @returns {GC.Spread.Sheets.Charts.IAxes | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart axes of the chart; otherwise, returns the chart.
|
28546
28942
|
*/
|
28547
28943
|
axes(value?: GC.Spread.Sheets.Charts.IAxes): any;
|
28548
28944
|
/**
|
@@ -28553,27 +28949,13 @@ declare module GC{
|
|
28553
28949
|
canPrint(value?: boolean): any;
|
28554
28950
|
/**
|
28555
28951
|
* Gets or sets the chart area style of the chart.
|
28556
|
-
* @param {
|
28557
|
-
* @
|
28558
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} value.backColor.type The pattern fill background color type of the chart chartArea.
|
28559
|
-
* @param {string} value.backColor.foregroundColor The pattern fill foreground color of the chart chartArea.
|
28560
|
-
* @param {string} value.backColor.backgroundColor The pattern fill background color of the chart chartArea.
|
28561
|
-
* @param {number} value.backColorTransparency The transparency of the chart area backColor.
|
28562
|
-
* @param {string} value.fontFamily The font family of the chart area.
|
28563
|
-
* @param {number} value.fontSize The font size of the chart area, its unit is pixel.
|
28564
|
-
* @param {string} value.color The color of the chart area.
|
28565
|
-
* @param {number} value.transparency The transparency of the chart area color.
|
28566
|
-
* @param {Object} value.border The border of the chart area.
|
28567
|
-
* @param {string} value.border.color The border color of the chart area.
|
28568
|
-
* @param {number} value.border.transparency The border transparency of the chart area.
|
28569
|
-
* @param {number} value.border.width The border width of the chart area.
|
28570
|
-
* @param {GC.Spread.Sheets.Charts.LineType} value.border.dashStyle The border dash style of the chart area.
|
28571
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart area style of the chart; otherwise, returns the chart.
|
28952
|
+
* @param {GC.Spread.Sheets.Charts.IChartArea} [value] The chart area style of the chart.
|
28953
|
+
* @returns {GC.Spread.Sheets.Charts.IChartArea | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart area style of the chart; otherwise, returns the chart.
|
28572
28954
|
*/
|
28573
28955
|
chartArea(value?: GC.Spread.Sheets.Charts.IChartArea): any;
|
28574
28956
|
/**
|
28575
28957
|
* Gets or sets the type of the chart.
|
28576
|
-
* @param {GC.Spread.Sheets.Charts.ChartType} value The type of the chart.
|
28958
|
+
* @param {GC.Spread.Sheets.Charts.ChartType} [value] The type of the chart.
|
28577
28959
|
* @returns {GC.Spread.Sheets.Charts.ChartType | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the type of the chart; otherwise, returns the chart.
|
28578
28960
|
*/
|
28579
28961
|
chartType(value?: GC.Spread.Sheets.Charts.ChartType): any;
|
@@ -28592,36 +28974,19 @@ declare module GC{
|
|
28592
28974
|
content(value?: HTMLElement): any;
|
28593
28975
|
/**
|
28594
28976
|
* Gets or sets the chart data labels style of the chart.
|
28595
|
-
* @param {
|
28596
|
-
* @
|
28597
|
-
* @param {boolean} value.showSeriesName Whether to show series name in data labels.
|
28598
|
-
* @param {boolean} value.showCategoryName Whether to show category name in data labels.
|
28599
|
-
* @param {boolean} value.showPercentage Whether to show the percent value in data labels.
|
28600
|
-
* @param {GC.Spread.Sheets.Charts.DataLabelPosition} value.position The position of the chart data labels.
|
28601
|
-
* @param {string} value.format The format of the chart data labels.
|
28602
|
-
* @param {string} value.color The color of the chart data labels.
|
28603
|
-
* @param {number} value.transparency The transparency of the chart data labels color.
|
28604
|
-
* @param {string} value.separator the separator of the series data labels.
|
28605
|
-
* @param {string | Object} value.backColor The background color of the series data labels.
|
28606
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} value.backColor.type The pattern fill backgroundColor type of the chart series data labels.
|
28607
|
-
* @param {string} value.backColor.foregroundColor The pattern fill foreground color of the chart series data labels.
|
28608
|
-
* @param {string} value.backColor.backgroundColor The pattern fill background color of the chart series data labels.
|
28609
|
-
* @param {number} value.backColorTransparency The background color transparency of the series data labels.
|
28610
|
-
* @param {string} value.borderColor The border color of the series data labels.
|
28611
|
-
* @param {number} value.borderWidth The border width of the series data labels.
|
28612
|
-
* @param {number} value.borderColorTransparency The border color transparency of the series data labels.
|
28613
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart data labels style of the chart; otherwise, returns the chart.
|
28977
|
+
* @param {GC.Spread.Sheets.Charts.IDataLabels} [value] The chart data labels style of the chart.
|
28978
|
+
* @returns {GC.Spread.Sheets.Charts.IDataLabels | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the chart data labels style of the chart; otherwise, returns the chart.
|
28614
28979
|
*/
|
28615
28980
|
dataLabels(value?: GC.Spread.Sheets.Charts.IDataLabels): any;
|
28616
28981
|
/**
|
28617
28982
|
* Gets or sets the whole data range of the chart as formula string.
|
28618
|
-
* @param {string} value The formula string of the data range for the chart.
|
28983
|
+
* @param {string} [value] The formula string of the data range for the chart.
|
28619
28984
|
* @returns {string | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the formula string of the whole data range for the chart; otherwise, returns the chart.
|
28620
28985
|
*/
|
28621
28986
|
dataRange(value?: string): any;
|
28622
28987
|
/**
|
28623
28988
|
* Gets or sets the way that the chart display blank data.
|
28624
|
-
* @param {GC.Spread.Sheets.Charts.DisplayBlanksAs} value the way that the chart display blank data.
|
28989
|
+
* @param {GC.Spread.Sheets.Charts.DisplayBlanksAs} [value] the way that the chart display blank data.
|
28625
28990
|
* @returns {GC.Spread.Sheets.Charts.DisplayBlanksAs | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the way that the chart display blank data, otherwise, returns the chart.
|
28626
28991
|
*/
|
28627
28992
|
displayBlanksAs(value?: GC.Spread.Sheets.Charts.DisplayBlanksAs): any;
|
@@ -28677,7 +29042,7 @@ declare module GC{
|
|
28677
29042
|
/**
|
28678
29043
|
* Gets or sets waterfall chart different points collection style.
|
28679
29044
|
* @param {Object.<number, GC.Spread.Sheets.Charts.IFormatOver>} value The specific data points collection style of the waterfall chart.
|
28680
|
-
* @returns {
|
29045
|
+
* @returns { GC.Spread.Sheets.Charts.IFormatOvers | GC.Spread.Sheets.Charts.Chart} If no value is set, return waterfall chart different points collection styles
|
28681
29046
|
*/
|
28682
29047
|
formatOvers(value?: GC.Spread.Sheets.Charts.IFormatOvers): GC.Spread.Sheets.Charts.IFormatOvers | GC.Spread.Sheets.Charts.Chart;
|
28683
29048
|
/**
|
@@ -28700,23 +29065,8 @@ declare module GC{
|
|
28700
29065
|
height(value?: number): any;
|
28701
29066
|
/**
|
28702
29067
|
* Gets or sets the style when user hover over the dataPoint.
|
28703
|
-
* @param {
|
28704
|
-
* @
|
28705
|
-
* @param {number} value.transparency The color transparency of the dataPoint been hovered.
|
28706
|
-
* @param {Object} value.borderStyle The border of the dataPoint been hovered.
|
28707
|
-
* @param {string} value.borderStyle.color The border color of the dataPoint been hovered.
|
28708
|
-
* @param {number} value.borderStyle.width The border width of the dataPoint been hovered.
|
28709
|
-
* @param {number} value.borderStyle.transparency The border color transparency of the dataPoint been hovered.
|
28710
|
-
* @param {GC.Spread.Sheets.Charts.LineType} value.borderStyle.dashStyle The border dash style of the dataPoint been hovered.
|
28711
|
-
* @param {Object} value.symbolStyle The symbol style of the dataPoint been hovered.
|
28712
|
-
* @param {string} value.symbolStyle.color The symbol's color of the dataPoint been hovered.
|
28713
|
-
* @param {number} value.symbolStyle.transparency The symbol's transparency of the dataPoint been hovered.
|
28714
|
-
* @param {Object} value.symbolStyle.borderStyle The symbol's border style of the dataPoint been hovered.
|
28715
|
-
* @param {number} value.symbolStyle.borderStyle.color The symbol's border color of the dataPoint been hovered.
|
28716
|
-
* @param {number} value.symbolStyle.borderStyle.width The symbol's border width of the dataPoint been hovered.
|
28717
|
-
* @param {number} value.symbolStyle.borderStyle.transparency The symbol's border transparency of the dataPoint been hovered.
|
28718
|
-
* @param {GC.Spread.Sheets.Charts.LineType} value.symbolStyle.borderStyle.dashStyle The symbol's border dash style of the dataPoint been hovered.
|
28719
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the current hover style of the chart; otherwise, returns the chart.
|
29068
|
+
* @param {GC.Spread.Sheets.Charts.IHoverStyle} [value] The hover style of the dataPoint been hovered.
|
29069
|
+
* @returns {GC.Spread.Sheets.Charts.IHoverStyle | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the current hover style of the chart; otherwise, returns the chart.
|
28720
29070
|
*/
|
28721
29071
|
hoverStyle(value?: GC.Spread.Sheets.Charts.IHoverStyle): any;
|
28722
29072
|
/**
|
@@ -28745,28 +29095,8 @@ declare module GC{
|
|
28745
29095
|
isVisible(value?: boolean): any;
|
28746
29096
|
/**
|
28747
29097
|
* Gets or sets the legend of the chart.
|
28748
|
-
* @param {
|
28749
|
-
* @
|
28750
|
-
* @param {boolean} value.visible The visibility of the chart legend.
|
28751
|
-
* @param {string | Object} value.backColor The backgroundColor of the chart legend.
|
28752
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} value.backColor.type The pattern fill backgroundColor type of the chart legend.
|
28753
|
-
* @param {string} value.backColor.foregroundColor The pattern fill foreground color of the chart legend.
|
28754
|
-
* @param {string} value.backColor.backgroundColor The pattern fill background color of the chart legend.
|
28755
|
-
* @param {number} value.backColorTransparency The transparency of the chart legend color
|
28756
|
-
* @param {Object} value.borderStyle The borderStyle of the chart legend.
|
28757
|
-
* @param {string} value.borderStyle.color The border color of the chart legend.
|
28758
|
-
* @param {number} value.borderStyle.width The border width of the chart legend.
|
28759
|
-
* @param {number} value.borderStyle.transparency The transparency of the chart legend border color
|
28760
|
-
* @param {string} value.color The color of the chart legend text.
|
28761
|
-
* @param {string} value.fontFamily The font family of the chart legend text.
|
28762
|
-
* @param {number} value.fontSize The font size of the chart legend text.
|
28763
|
-
* @param {boolean} value.showLegendWithoutOverlapping whether the legend display without overlapping chart area
|
28764
|
-
* @param {Object} value.layout The layout of the chart legend.
|
28765
|
-
* @param {number} value.layout.x The x position of the chart legend, it's percentage, and the base line is chart's left edge.
|
28766
|
-
* @param {number} value.layout.y The y position of the chart legend, it's percentage, and the base line is chart's top edge.
|
28767
|
-
* @param {number} value.layout.width The width of the chart legend, it's percentage, and it's based on the chart's width.
|
28768
|
-
* @param {number} value.layout.height The height of the chart legend, it's percentage, and it's based on the chart's height.
|
28769
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the legend of the chart; otherwise, returns the chart.
|
29098
|
+
* @param {GC.Spread.Sheets.Charts.IChartLegend} [value] The legend of the chart.
|
29099
|
+
* @returns {GC.Spread.Sheets.Charts.IChartLegend | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the legend of the chart; otherwise, returns the chart.
|
28770
29100
|
*/
|
28771
29101
|
legend(value?: GC.Spread.Sheets.Charts.IChartLegend): any;
|
28772
29102
|
/**
|
@@ -28821,23 +29151,13 @@ declare module GC{
|
|
28821
29151
|
switchDataOrientation(): boolean;
|
28822
29152
|
/**
|
28823
29153
|
* Gets or sets the title of the chart.
|
28824
|
-
* @param {
|
28825
|
-
* @
|
28826
|
-
* @param {string} value.fontFamily The font family of the chart title.
|
28827
|
-
* @param {number} value.fontSize The font size of the chart title, its unit is pixel.
|
28828
|
-
* @param {string} value.color The color of the chart title.
|
28829
|
-
* @param {number} value.transparency The transparency of the chart title color
|
28830
|
-
* @param {string | Object} value.backColor The background color of the chart title area.
|
28831
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} value.backColor.type The pattern fill background color type of the chart title area.
|
28832
|
-
* @param {string} value.backColor.foregroundColor The pattern fill foreground color of the chart title area.
|
28833
|
-
* @param {string} value.backColor.backgroundColor The pattern fill background color of the chart title area.
|
28834
|
-
* @param {number} value.backColorTransparency The transparency of the chart title area backColor.
|
28835
|
-
* @returns {Object | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the title of the chart; otherwise, returns the chart.
|
29154
|
+
* @param {GC.Spread.Sheets.Charts.IChartTitle} [value] The title of the chart.
|
29155
|
+
* @returns {GC.Spread.Sheets.Charts.IChartTitle | GC.Spread.Sheets.Charts.Chart} If no value is set, returns the title of the chart; otherwise, returns the chart.
|
28836
29156
|
*/
|
28837
29157
|
title(value?: GC.Spread.Sheets.Charts.IChartTitle): any;
|
28838
29158
|
/**
|
28839
29159
|
* Gets or sets whether apply animation to the chart.
|
28840
|
-
* @param {boolean} value whether apply animation to the chart.
|
29160
|
+
* @param {boolean} [value] whether apply animation to the chart.
|
28841
29161
|
* @returns {boolean | GC.Spread.Sheets.Charts.Chart} If no value is set, returns whether apply animation to the chart; otherwise, returns the chart.
|
28842
29162
|
*/
|
28843
29163
|
useAnimation(value?: boolean): any;
|
@@ -28988,106 +29308,7 @@ declare module GC{
|
|
28988
29308
|
constructor();
|
28989
29309
|
/**
|
28990
29310
|
* Adds a new series to series collection.
|
28991
|
-
* @param {
|
28992
|
-
* @param {Object} seriesItem.symbol, seriesItem The symbol of the series.
|
28993
|
-
* @param {string} seriesItem.symbol.fill The symbol fill color of the series.
|
28994
|
-
* @param {number} seriesItem.symbol.fillColorTransparency The transparency of the symbol fill color.
|
28995
|
-
* @param {number} seriesItem.symbol.size The symbol size of the series.
|
28996
|
-
* @param {GC.Spread.Sheets.Charts.SymbolShape} seriesItem.symbol.shape The symbol shape of the series.
|
28997
|
-
* @param {Object} seriesItem.symbol.border The symbol border of the series.
|
28998
|
-
* @param {string} seriesItem.symbol.border.color The symbol border color of the series.
|
28999
|
-
* @param {number} seriesItem.symbol.border.colorTransparency The transparency of the symbol border color.
|
29000
|
-
* @param {number} seriesItem.symbol.border.width The symbol border width of the series.
|
29001
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.symbol.border.lineType The symbol border line Type of the series.
|
29002
|
-
* @param {Object} seriesItem.errorbars The error bars of the series.
|
29003
|
-
* @param {Object} seriesItem.errorbars.vertical The vertical error bar of the series, each series may has different direction error bar(s) based on chart type.
|
29004
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarType} seriesItem.errorbars.vertical.type The error bar type.
|
29005
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarValueType} seriesItem.errorbars.vertical.valuetype The error bar value type.
|
29006
|
-
* @param {boolean} seriesItem.errorbars.vertical.noEndCap The error bar has end cap or not.
|
29007
|
-
* @param {number} seriesItem.errorbars.vertical.value The error bar value, just take effect on the FixedValue(1) / Percentage(2) / StandardDeviation(3) value type.
|
29008
|
-
* @param {Object} seriesItem.errorbars.vertical.custom The error bar custom formulas, it contains positive formula and negative formula, just take effect on the Custom(0) value type.
|
29009
|
-
* @param {string} seriesItem.errorbars.vertical.custom.positive The error bar custom positive formula.
|
29010
|
-
* @param {string} seriesItem.errorbars.vertical.custom.negative The error bar custom negative formula.
|
29011
|
-
* @param {Object} seriesItem.errorbars.vertical.style The error bar styles.
|
29012
|
-
* @param {string} seriesItem.errorbars.vertical.style.color The error bar color.
|
29013
|
-
* @param {number} seriesItem.errorbars.vertical.style.transparency The error bar transparency.
|
29014
|
-
* @param {number} seriesItem.errorbars.vertical.style.width The error bar width.
|
29015
|
-
* @param {Object} seriesItem.errorbars.horizontal The horizontal error bar of the series, each series may has different direction error bar(s) based on chart type.
|
29016
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarType} seriesItem.errorbars.horizontal.type The error bar type.
|
29017
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarValueType} seriesItem.errorbars.horizontal.valuetype The error bar value type.
|
29018
|
-
* @param {boolean} seriesItem.errorbars.horizontal.noEndCap The error bar has end cap or not.
|
29019
|
-
* @param {number} seriesItem.errorbars.horizontal.value The error bar value, just take effect on the FixedValue(1) / Percentage(2) / StandardDeviation(3) value type.
|
29020
|
-
* @param {Object} seriesItem.errorbars.horizontal.custom The error bar custom formulas, it contains positive formula and negative formula, just take effect on the Custom(0) value type.
|
29021
|
-
* @param {string} seriesItem.errorbars.horizontal.custom.positive The error bar custom positive formula.
|
29022
|
-
* @param {string} seriesItem.errorbars.horizontal.custom.negative The error bar custom negative formula.
|
29023
|
-
* @param {Object} seriesItem.errorbars.horizontal.style The error bar styles.
|
29024
|
-
* @param {string} seriesItem.errorbars.horizontal.style.color The error bar color.
|
29025
|
-
* @param {number} seriesItem.errorbars.horizontal.style.transparency The error bar transparency.
|
29026
|
-
* @param {number} seriesItem.errorbars.horizontal.style.width The error bar width.
|
29027
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.errorbars.horizontal.style.dashStyle The error bar dash style.
|
29028
|
-
* @param {Object[]} seriesItem.trendlines The trendlines of the series.
|
29029
|
-
* @param {GC.Spread.Sheets.Charts.TrendlineType} seriesItem.trendlines[0].type The type of the trendline.
|
29030
|
-
* @param {number} seriesItem.trendlines[0].order The order of the polynomial trendline.
|
29031
|
-
* @param {number} seriesItem.trendlines[0].period The period of the movingAverage trendline.
|
29032
|
-
* @param {number} seriesItem.trendlines[0].intercept The intercept of the trendline.
|
29033
|
-
* @param {number} seriesItem.trendlines[0].forward The forward of the trendline.
|
29034
|
-
* @param {number} seriesItem.trendlines[0].backward The backward of the trendline.
|
29035
|
-
* @param {boolean} seriesItem.trendlines[0].displayEquation Whether display the equation of the trendline.
|
29036
|
-
* @param {boolean} seriesItem.trendlines[0].displayRSquared Whether display the R squared of the trendline.
|
29037
|
-
* @param {string} seriesItem.trendlines[0].fontFamily The fontFamily of the trendline.
|
29038
|
-
* @param {number} seriesItem.trendlines[0].fontSize The fontSize of the trendline.
|
29039
|
-
* @param {string} seriesItem.trendlines[0].fontColor The fontColor of the trendline.
|
29040
|
-
* @param {string} seriesItem.trendlines[0].name The name of the trendline.
|
29041
|
-
* @param {Object} seriesItem.trendlines[0].style The line style of the trendline.
|
29042
|
-
* @param {string} seriesItem.trendlines[0].style.color The color of the trendline.
|
29043
|
-
* @param {number} seriesItem.trendlines[0].style.transparency The transparency of the trendline.
|
29044
|
-
* @param {number} seriesItem.trendlines[0].style.width The width of the trendline.
|
29045
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.trendlines[0].style.dashStyle The dash style of the trendline.
|
29046
|
-
* @param {GC.Spread.Sheets.Charts.ChartType} seriesItem.chartType The chart type of the series.
|
29047
|
-
* @param {GC.Spread.Sheets.Charts.AxisGroup} seriesItem.axisGroup The axis group of the series.
|
29048
|
-
* @param {string | Object} seriesItem.backColor The background color of the series.
|
29049
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} seriesItem.backColor.type The pattern fill background color type of the chart series.
|
29050
|
-
* @param {string} seriesItem.backColor.foregroundColor The pattern fill foreground color of the chart series.
|
29051
|
-
* @param {string} seriesItem.backColor.backgroundColor The pattern fill background color of the chart series.
|
29052
|
-
* @param {number} seriesItem.backColorTransparency The transparency of the series background color.
|
29053
|
-
* @param {Object} seriesItem.border The border of the series.
|
29054
|
-
* @param {string} seriesItem.border.color The border color of the series.
|
29055
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.border.lineType The border line type of the series.
|
29056
|
-
* @param {number} seriesItem.border.transparency The transparency of the series border color.
|
29057
|
-
* @param {number} seriesItem.border.width The border width of the series.
|
29058
|
-
* @param {number} seriesItem.startAngle The first slice angle of the chart whose chart type is pie. The default value is 0, which represents the 12 o'clock position.
|
29059
|
-
* @param {string} seriesItem.name The name formula of the series.
|
29060
|
-
* @param {string} seriesItem.xValues The x values formula of the series.
|
29061
|
-
* @param {string} seriesItem.yValues The y values formula of the series.
|
29062
|
-
* @param {boolean} seriesItem.smooth Whether to display smooth lines. This is used for line chart and scatter chart.
|
29063
|
-
* @param {string} seriesItem.bubbleSizes The bubble sizes formula of the series. This is used for bubble chart.
|
29064
|
-
* @param {number} seriesItem.doughnutHoleSize The hole size of the doughnut chart. This is used for doughnut chart, The maximum value is 0.9, the minimum value is 0.
|
29065
|
-
* @param {number} seriesItem.showConnectorLines Whether the series show connector lines. This is used for waterfall chart, The default value is false.
|
29066
|
-
* @param {number[]} seriesItem.subtotals The waterfall chart set as total points index array(0 base). This is used for waterfall chart, The default value is empty array.
|
29067
|
-
* @param {number} seriesItem.gapWidth The gap width of the bar and column chart group. The maximum value is 5, the minimum value is 0.
|
29068
|
-
* @param {number} seriesItem.overlap The overlap of the bar and column chart group. The maximum value is 1, the minimum value is -1.
|
29069
|
-
* @param {Array} seriesItem.trendlines The trendlines of the series.
|
29070
|
-
* @param {Object.<number, GC.Spread.Sheets.Charts.IDataPointStyle>} seriesItem.dataPoints The data points of the series.
|
29071
|
-
* @param {Object} seriesItem.dataLabels The data labels of the series.
|
29072
|
-
* @param {boolean} seriesItem.dataLabels.showValue Whether to show value in series data labels.
|
29073
|
-
* @param {boolean} seriesItem.dataLabels.showSeriesName Whether to show series name in series data labels.
|
29074
|
-
* @param {boolean} seriesItem.dataLabels.showCategoryName Whether to show category name in series data labels.
|
29075
|
-
* @param {boolean} seriesItem.dataLabels.showPercentage Whether to show the percent value in series data labels.
|
29076
|
-
* @param {string} seriesItem.dataLabels.separator the separator of the series data labels.
|
29077
|
-
* @param {GC.Spread.Sheets.Charts.DataLabelPosition} seriesItem.dataLabels.position The position of the series data labels.
|
29078
|
-
* @param {string} seriesItem.dataLabels.format The format of the series data labels.
|
29079
|
-
* @param {string} seriesItem.dataLabels.color The text color of the series data labels.
|
29080
|
-
* @param {number} seriesItem.dataLabels.transparency The text color transparency of the series data labels.
|
29081
|
-
* @param {string | Object} seriesItem.dataLabels.backColor The background color of the series data labels.
|
29082
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} seriesItem.dataLabels.backColor.type The pattern fill background color type of the chart series dataLabels.
|
29083
|
-
* @param {string} seriesItem.dataLabels.backColor.foregroundColor The pattern fill foreground color of the chart series dataLabels.
|
29084
|
-
* @param {string} seriesItem.dataLabels.backColor.backgroundColor The pattern fill background color of the chart series dataLabels.
|
29085
|
-
* @param {number} seriesItem.dataLabels.backColorTransparency The background color transparency of the series data labels.
|
29086
|
-
* @param {string} seriesItem.dataLabels.borderColor The border color of the series data labels.
|
29087
|
-
* @param {number} seriesItem.dataLabels.borderWidth The border width of the series data labels.
|
29088
|
-
* @param {number} seriesItem.dataLabels.borderColorTransparency The border color transparency of the series data labels.
|
29089
|
-
* @param {boolean} seriesItem.invertIfNegative Whether the series enables invertIfNegative.
|
29090
|
-
* @param {string} seriesItem.invertColor The series point value is negative color when seriesItem type is column or bar chart and invertIfNegative is true.
|
29311
|
+
* @param {GC.Spread.Sheets.Charts.ISeries | GC.Spread.Sheets.Charts.ISeries[]} series The series of the chart.
|
29091
29312
|
* @example
|
29092
29313
|
* ```
|
29093
29314
|
* // This example shows how to add a new series.
|
@@ -29108,8 +29329,8 @@ declare module GC{
|
|
29108
29329
|
add(series: GC.Spread.Sheets.Charts.ISeries | GC.Spread.Sheets.Charts.ISeries[]): void;
|
29109
29330
|
/**
|
29110
29331
|
* Gets all series or a specified series from series collection.
|
29111
|
-
* @param {number} index The index of the series.
|
29112
|
-
* @return {
|
29332
|
+
* @param {number} [index] The index of the series.
|
29333
|
+
* @return {GC.Spread.Sheets.Charts.ISeries | GC.Spread.Sheets.Charts.ISeries[]} The series of the chart.
|
29113
29334
|
* @example
|
29114
29335
|
* ```
|
29115
29336
|
* // This example shows how to get a series.
|
@@ -29134,106 +29355,7 @@ declare module GC{
|
|
29134
29355
|
/**
|
29135
29356
|
* Updates the specified series's property.
|
29136
29357
|
* @param {number} index The index of the series.
|
29137
|
-
* @param {
|
29138
|
-
* @param {Object} seriesItem.symbol, seriesItem The symbol of the series.
|
29139
|
-
* @param {string} seriesItem.symbol.fill The symbol fill color of the series.
|
29140
|
-
* @param {number} seriesItem.symbol.fillColorTransparency The transparency of the symbol fill color.
|
29141
|
-
* @param {number} seriesItem.symbol.size The symbol size of the series.
|
29142
|
-
* @param {GC.Spread.Sheets.Charts.SymbolShape} seriesItem.symbol.shape The symbol shape of the series.
|
29143
|
-
* @param {Object} seriesItem.symbol.border The symbol border of the series.
|
29144
|
-
* @param {string} seriesItem.symbol.border.color The symbol border color of the series.
|
29145
|
-
* @param {number} seriesItem.symbol.border.colorTransparency The transparency of the symbol border color.
|
29146
|
-
* @param {number} seriesItem.symbol.border.width The symbol border width of the series.
|
29147
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.symbol.border.lineType The symbol border line Type of the series.
|
29148
|
-
* @param {Object} seriesItem.errorbars The error bars of the series.
|
29149
|
-
* @param {Object} seriesItem.errorbars.vertical The vertical error bar of the series, each series may has different direction error bar(s) based on chart type.
|
29150
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarType} seriesItem.errorbars.vertical.type The error bar type.
|
29151
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarValueType} seriesItem.errorbars.vertical.valuetype The error bar value type.
|
29152
|
-
* @param {boolean} seriesItem.errorbars.vertical.noEndCap The error bar has end cap or not.
|
29153
|
-
* @param {number} seriesItem.errorbars.vertical.value The error bar value, just take effect on the FixedValue(1) / Percentage(2) / StandardDeviation(3) value type.
|
29154
|
-
* @param {Object} seriesItem.errorbars.vertical.custom The error bar custom formulas, it contains positive formula and negative formula, just take effect on the Custom(0) value type.
|
29155
|
-
* @param {string} seriesItem.errorbars.vertical.custom.positive The error bar custom positive formula.
|
29156
|
-
* @param {string} seriesItem.errorbars.vertical.custom.negative The error bar custom negative formula.
|
29157
|
-
* @param {Object} seriesItem.errorbars.vertical.style The error bar styles.
|
29158
|
-
* @param {string} seriesItem.errorbars.vertical.style.color The error bar color.
|
29159
|
-
* @param {number} seriesItem.errorbars.vertical.style.transparency The error bar transparency.
|
29160
|
-
* @param {number} seriesItem.errorbars.vertical.style.width The error bar width.
|
29161
|
-
* @param {Object} seriesItem.errorbars.horizontal The horizontal error bar of the series, each series may has different direction error bar(s) based on chart type.
|
29162
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarType} seriesItem.errorbars.horizontal.type The error bar type.
|
29163
|
-
* @param {GC.Spread.Sheets.Charts.ErrorBarValueType} seriesItem.errorbars.horizontal.valuetype The error bar value type.
|
29164
|
-
* @param {boolean} seriesItem.errorbars.horizontal.noEndCap The error bar has end cap or not.
|
29165
|
-
* @param {number} seriesItem.errorbars.horizontal.value The error bar value, just take effect on the FixedValue(1) / Percentage(2) / StandardDeviation(3) value type.
|
29166
|
-
* @param {Object} seriesItem.errorbars.horizontal.custom The error bar custom formulas, it contains positive formula and negative formula, just take effect on the Custom(0) value type.
|
29167
|
-
* @param {string} seriesItem.errorbars.horizontal.custom.positive The error bar custom positive formula.
|
29168
|
-
* @param {string} seriesItem.errorbars.horizontal.custom.negative The error bar custom negative formula.
|
29169
|
-
* @param {Object} seriesItem.errorbars.horizontal.style The error bar styles.
|
29170
|
-
* @param {string} seriesItem.errorbars.horizontal.style.color The error bar color.
|
29171
|
-
* @param {number} seriesItem.errorbars.horizontal.style.transparency The error bar transparency.
|
29172
|
-
* @param {number} seriesItem.errorbars.horizontal.style.width The error bar width.
|
29173
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.errorbars.horizontal.style.dashStyle The error bar dash style.
|
29174
|
-
* @param {Object[]} seriesItem.trendlines The trendlines of the series.
|
29175
|
-
* @param {GC.Spread.Sheets.Charts.TrendlineType} seriesItem.trendlines[0].type The type of the trendline.
|
29176
|
-
* @param {number} seriesItem.trendlines[0].order The order of the polynomial trendline.
|
29177
|
-
* @param {number} seriesItem.trendlines[0].period The period of the movingAverage trendline.
|
29178
|
-
* @param {number} seriesItem.trendlines[0].intercept The intercept of the trendline.
|
29179
|
-
* @param {number} seriesItem.trendlines[0].forward The forward of the trendline.
|
29180
|
-
* @param {number} seriesItem.trendlines[0].backward The backward of the trendline.
|
29181
|
-
* @param {boolean} seriesItem.trendlines[0].displayEquation Whether display the equation of the trendline.
|
29182
|
-
* @param {boolean} seriesItem.trendlines[0].displayRSquared Whether display the R squared of the trendline.
|
29183
|
-
* @param {string} seriesItem.trendlines[0].fontFamily The fontFamily of the trendline.
|
29184
|
-
* @param {number} seriesItem.trendlines[0].fontSize The fontSize of the trendline.
|
29185
|
-
* @param {string} seriesItem.trendlines[0].fontColor The fontColor of the trendline.
|
29186
|
-
* @param {string} seriesItem.trendlines[0].name The name of the trendline.
|
29187
|
-
* @param {Object} seriesItem.trendlines[0].style The line style of the trendline.
|
29188
|
-
* @param {string} seriesItem.trendlines[0].style.color The color of the trendline.
|
29189
|
-
* @param {number} seriesItem.trendlines[0].style.transparency The transparency of the trendline.
|
29190
|
-
* @param {number} seriesItem.trendlines[0].style.width The width of the trendline.
|
29191
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.trendlines[0].style.dashStyle The dash style of the trendline.
|
29192
|
-
* @param {GC.Spread.Sheets.Charts.ChartType} seriesItem.chartType The chart type of the series.
|
29193
|
-
* @param {GC.Spread.Sheets.Charts.AxisGroup} seriesItem.axisGroup The axis group of the series.
|
29194
|
-
* @param {string | Object} seriesItem.backColor The background color of the series.
|
29195
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} seriesItem.backColor.type The pattern fill background color type of the chart series.
|
29196
|
-
* @param {string} seriesItem.backColor.foregroundColor The pattern fill foreground color of the chart series.
|
29197
|
-
* @param {string} seriesItem.backColor.backgroundColor The pattern fill background color of the chart series.
|
29198
|
-
* @param {number} seriesItem.backColorTransparency The transparency of the series background color.
|
29199
|
-
* @param {Object} seriesItem.border The border of the series.
|
29200
|
-
* @param {string} seriesItem.border.color The border color of the series.
|
29201
|
-
* @param {GC.Spread.Sheets.Charts.LineType} seriesItem.border.lineType The border line type of the series.
|
29202
|
-
* @param {number} seriesItem.border.transparency The transparency of the series border color.
|
29203
|
-
* @param {number} seriesItem.border.width The border width of the series.
|
29204
|
-
* @param {boolean} seriesItem.smooth Whether to display smooth lines. This is used for line chart and scatter chart.
|
29205
|
-
* @param {number} seriesItem.startAngle The first slice angle of the chart whose chart type is pie. The default value is 0, which represents the 12 o'clock position.
|
29206
|
-
* @param {string} seriesItem.name The name formula of the series.
|
29207
|
-
* @param {string} seriesItem.xValues The x values formula of the series.
|
29208
|
-
* @param {string} seriesItem.yValues The y values formula of the series.
|
29209
|
-
* @param {string} seriesItem.bubbleSizes The bubble sizes formula of the series. This is used for bubble chart.
|
29210
|
-
* @param {number} seriesItem.doughnutHoleSize The hole size of the doughnut chart. This is used for doughnut chart, The maximum value is 0.9, the minimum value is 0.
|
29211
|
-
* @param {number} seriesItem.showConnectorLines Whether the series show connector lines. This is used for waterfall chart, The default value is false.
|
29212
|
-
* @param {number[]} seriesItem.subtotals The waterfall chart set as total points index array(0 base). This is used for waterfall chart, The default value is empty array.
|
29213
|
-
* @param {number} seriesItem.gapWidth The gap width of the bar and column chart group. The maximum value is 5, the minimum value is 0.
|
29214
|
-
* @param {number} seriesItem.overlap The overlap of the bar and column chart group. The maximum value is 1, the minimum value is -1.
|
29215
|
-
* @param {Array} seriesItem.trendlines The trendlines of the series.
|
29216
|
-
* @param {Object.<number, GC.Spread.Sheets.Charts.IDataPointStyle>} seriesItem.dataPoints The data points of the series.
|
29217
|
-
* @param {Object} seriesItem.dataLabels The data labels of the series.
|
29218
|
-
* @param {boolean} seriesItem.dataLabels.showValue Whether to show value in series data labels.
|
29219
|
-
* @param {boolean} seriesItem.dataLabels.showSeriesName Whether to show series name in series data labels.
|
29220
|
-
* @param {boolean} seriesItem.dataLabels.showCategoryName Whether to show category name in series data labels.
|
29221
|
-
* @param {boolean} seriesItem.dataLabels.showPercentage Whether to show the percent value in series data labels.
|
29222
|
-
* @param {string} seriesItem.dataLabels.separator the separator of the series data labels.
|
29223
|
-
* @param {GC.Spread.Sheets.Charts.DataLabelPosition} seriesItem.dataLabels.position The position of the series data labels.
|
29224
|
-
* @param {string} seriesItem.dataLabels.format The format of the series data labels.
|
29225
|
-
* @param {string} seriesItem.dataLabels.color The text color of the series data labels.
|
29226
|
-
* @param {number} seriesItem.dataLabels.transparency The text color transparency of the series data labels.
|
29227
|
-
* @param {string | Object} seriesItem.dataLabels.backColor The background color of the series data labels.
|
29228
|
-
* @param {GC.Spread.Sheets.Charts.PatternType} seriesItem.dataLabels.backColor.type The pattern fill background color type of the chart series dataLabels.
|
29229
|
-
* @param {string} seriesItem.dataLabels.backColor.foregroundColor The pattern fill foreground color of the chart series dataLabels.
|
29230
|
-
* @param {string} seriesItem.dataLabels.backColor.backgroundColor The pattern fill background color of the chart series dataLabels.
|
29231
|
-
* @param {number} seriesItem.dataLabels.backColorTransparency The background color transparency of the series data labels.
|
29232
|
-
* @param {string} seriesItem.dataLabels.borderColor The border color of the series data labels.
|
29233
|
-
* @param {number} seriesItem.dataLabels.borderWidth The border width of the series data labels.
|
29234
|
-
* @param {number} seriesItem.dataLabels.borderColorTransparency The border color transparency of the series data labels.
|
29235
|
-
* @param {boolean} seriesItem.invertIfNegative Whether the series enables invertIfNegative.
|
29236
|
-
* @param {string} seriesItem.invertColor The series point value is negative color when seriesItem type is column or bar chart and invertIfNegative is true.
|
29358
|
+
* @param {GC.Spread.Sheets.Charts.ISeries} series The series of the chart.
|
29237
29359
|
* @example
|
29238
29360
|
* ```
|
29239
29361
|
* // This example shows how to update the property of a series.
|