Series
Series class
Encapsulates the object that represents a single data series in a chart.
class Series;
Methods
| Method | Description |
|---|---|
| isFiltered() | Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart. |
| setIsFiltered(boolean) | Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart. |
| getLayoutProperties() | Represents the properties of layout. |
| getPoints() | Gets the collection of points in a series in a chart. |
| getArea() | Represents the background area of Series object. |
| getBorder() | Represents border of Series object. |
| getName() | Gets or sets the name of the data series. |
| setName(string) | Gets or sets the name of the data series. |
| getDisplayName() | Gets the series’s name that displays on the chart graph. |
| getCountOfDataValues() | Gets the number of the data values. |
| isVerticalValues() | Indicates whether the data source is vertical. |
| getValues() | Represents the Y values of this chart series. |
| setValues(string) | Represents the Y values of this chart series. |
| getValuesFormatCode() | Represents format code of Values’s NumberList. |
| setValuesFormatCode(string) | Represents format code of Values’s NumberList. |
| getXValuesFormatCode() | Represents format code of X Values’s NumberList. |
| setXValuesFormatCode(string) | Represents format code of X Values’s NumberList. |
| getXValues() | Represents the x values of the chart series. |
| setXValues(string) | Represents the x values of the chart series. |
| getBubbleSizes() | Gets or sets the bubble sizes values of the chart series. |
| setBubbleSizes(string) | Gets or sets the bubble sizes values of the chart series. |
| getTrendLines() | Returns all the trendlines of this series. |
| getSmooth() | Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts. |
| setSmooth(boolean) | Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts. |
| getShadow() | True if the series has a shadow. |
| setShadow(boolean) | True if the series has a shadow. |
| getHas3DEffect() | True if the series has a three-dimensional appearance. Applies only to bubble charts. |
| setHas3DEffect(boolean) | True if the series has a three-dimensional appearance. Applies only to bubble charts. |
| getBar3DShapeType() | Gets or sets the 3D shape type used with the 3-D bar or column chart. |
| setBar3DShapeType(Bar3DShapeType) | Gets or sets the 3D shape type used with the 3-D bar or column chart. |
| getDataLabels() | Represents the DataLabels object for the specified ASeries. |
| getType() | Gets or sets a data series’ type. |
| setType(ChartType) | Gets or sets a data series’ type. |
| getMarker() | Gets the |
| getPlotOnSecondAxis() | Indicates if this series is plotted on second value axis. |
| setPlotOnSecondAxis(boolean) | Indicates if this series is plotted on second value axis. |
| getXErrorBar() | Represents X direction error bar of the series. |
| getYErrorBar() | Represents Y direction error bar of the series. |
| getHasHiLoLines() | True if the line chart has high-low lines. Applies only to line charts. |
| setHasHiLoLines(boolean) | True if the line chart has high-low lines. Applies only to line charts. |
| getHiLoLines() | Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts. |
| getHasSeriesLines() | True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts. |
| setHasSeriesLines(boolean) | True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts. |
| getSeriesLines() | Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts. |
| getHasDropLines() | True if the chart has drop lines. Applies only to line chart or area charts. |
| setHasDropLines(boolean) | True if the chart has drop lines. Applies only to line chart or area charts. |
| getDropLines() | Returns a Line object that represents the drop lines for a series on the line chart or area chart. Applies only to line chart or area charts. |
| getHasUpDownBars() | True if a line chart has up and down bars. Applies only to line charts. |
| setHasUpDownBars(boolean) | True if a line chart has up and down bars. Applies only to line charts. |
| getUpBars() | Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts. |
| getDownBars() | Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts. |
| isColorVaried() | Represents if the color of points is varied. The chart must contain only one series. |
| setIsColorVaried(boolean) | Represents if the color of points is varied. The chart must contain only one series. |
| getGapWidth() | Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500. |
| setGapWidth(number) | Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500. |
| getFirstSliceAngle() | Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360. |
| setFirstSliceAngle(number) | Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360. |
| getOverlap() | Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. |
| setOverlap(number) | Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. |
| getSecondPlotSize() | Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. |
| setSecondPlotSize(number) | Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. |
| getSplitType() | Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
| setSplitType(ChartSplitType) | Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
| getSplitValue() | Returns or sets a value that shall be used to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
| setSplitValue(number) | Returns or sets a value that shall be used to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart. |
| isAutoSplit() | Indicates whether the threshold value is automatic. |
| getBubbleScale() | Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts. |
| setBubbleScale(number) | Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts. |
| getSizeRepresents() | Gets or sets what the bubble size represents on a bubble chart. |
| setSizeRepresents(BubbleSizeRepresents) | Gets or sets what the bubble size represents on a bubble chart. |
| getShowNegativeBubbles() | True if negative bubbles are shown for the chart group. Valid only for bubble charts. |
| setShowNegativeBubbles(boolean) | True if negative bubbles are shown for the chart group. Valid only for bubble charts. |
| getDoughnutHoleSize() | Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent. |
| setDoughnutHoleSize(number) | Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent. |
| getExplosion() | The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. |
| setExplosion(number) | The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. |
| getHasRadarAxisLabels() | True if a radar chart has category axis labels. Applies only to radar charts. |
| setHasRadarAxisLabels(boolean) | True if a radar chart has category axis labels. Applies only to radar charts. |
| getHasLeaderLines() | True if the series has leader lines. |
| setHasLeaderLines(boolean) | True if the series has leader lines. |
| getLeaderLines() | Represents leader lines on a chart. Leader lines connect data labels to data points. This object isn’t a collection; there’s no object that represents a single leader line. |
| getLegendEntry() | Gets the legend entry according to this series. |
| getShapeProperties() | Gets the ShapePropertyCollection object that holds the visual shape properties of the Series. |
| move(number) | Moves the series up or down. |
isFiltered()
Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
isFiltered() : boolean;
setIsFiltered(boolean)
Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
setIsFiltered(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getLayoutProperties()
Represents the properties of layout.
getLayoutProperties() : SeriesLayoutProperties;
Returns
getPoints()
Gets the collection of points in a series in a chart.
getPoints() : ChartPointCollection;
Returns
Remarks
When the chart is Pie of Pie or Bar of Pie, the last point is other point in first pie plot.
getArea()
Represents the background area of Series object.
getArea() : Area;
Returns
getBorder()
Represents border of Series object.
getBorder() : Line;
Returns
getName()
Gets or sets the name of the data series.
getName() : string;
setName(string)
Gets or sets the name of the data series.
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getDisplayName()
Gets the series’s name that displays on the chart graph.
getDisplayName() : string;
getCountOfDataValues()
Gets the number of the data values.
getCountOfDataValues() : number;
isVerticalValues()
Indicates whether the data source is vertical.
isVerticalValues() : boolean;
getValues()
Represents the Y values of this chart series.
getValues() : string;
setValues(string)
Represents the Y values of this chart series.
setValues(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getValuesFormatCode()
Represents format code of Values’s NumberList.
getValuesFormatCode() : string;
setValuesFormatCode(string)
Represents format code of Values’s NumberList.
setValuesFormatCode(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getXValuesFormatCode()
Represents format code of X Values’s NumberList.
getXValuesFormatCode() : string;
setXValuesFormatCode(string)
Represents format code of X Values’s NumberList.
setXValuesFormatCode(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getXValues()
Represents the x values of the chart series.
getXValues() : string;
setXValues(string)
Represents the x values of the chart series.
setXValues(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getBubbleSizes()
Gets or sets the bubble sizes values of the chart series.
getBubbleSizes() : string;
setBubbleSizes(string)
Gets or sets the bubble sizes values of the chart series.
setBubbleSizes(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTrendLines()
Returns all the trendlines of this series.
getTrendLines() : TrendlineCollection;
Returns
getSmooth()
Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts.
getSmooth() : boolean;
setSmooth(boolean)
Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts.
setSmooth(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShadow()
True if the series has a shadow.
getShadow() : boolean;
setShadow(boolean)
True if the series has a shadow.
setShadow(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getHas3DEffect()
True if the series has a three-dimensional appearance. Applies only to bubble charts.
getHas3DEffect() : boolean;
setHas3DEffect(boolean)
True if the series has a three-dimensional appearance. Applies only to bubble charts.
setHas3DEffect(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getBar3DShapeType()
Gets or sets the 3D shape type used with the 3-D bar or column chart.
getBar3DShapeType() : Bar3DShapeType;
Returns
setBar3DShapeType(Bar3DShapeType)
Gets or sets the 3D shape type used with the 3-D bar or column chart.
setBar3DShapeType(value: Bar3DShapeType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Bar3DShapeType | The value to set. |
getDataLabels()
Represents the DataLabels object for the specified ASeries.
getDataLabels() : DataLabels;
Returns
getType()
Gets or sets a data series’ type.
getType() : ChartType;
Returns
setType(ChartType)
Gets or sets a data series’ type.
setType(value: ChartType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ChartType | The value to set. |
getMarker()
Gets the
getMarker() : Marker;
Returns
getPlotOnSecondAxis()
Indicates if this series is plotted on second value axis.
getPlotOnSecondAxis() : boolean;
setPlotOnSecondAxis(boolean)
Indicates if this series is plotted on second value axis.
setPlotOnSecondAxis(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getXErrorBar()
Represents X direction error bar of the series.
getXErrorBar() : ErrorBar;
Returns
getYErrorBar()
Represents Y direction error bar of the series.
getYErrorBar() : ErrorBar;
Returns
getHasHiLoLines()
True if the line chart has high-low lines. Applies only to line charts.
getHasHiLoLines() : boolean;
setHasHiLoLines(boolean)
True if the line chart has high-low lines. Applies only to line charts.
setHasHiLoLines(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getHiLoLines()
Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts.
getHiLoLines() : Line;
Returns
getHasSeriesLines()
True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.
getHasSeriesLines() : boolean;
setHasSeriesLines(boolean)
True if a stacked column chart or bar chart has series lines or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.
setHasSeriesLines(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSeriesLines()
Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart. Applies only to stacked bar and stacked column charts.
getSeriesLines() : Line;
Returns
getHasDropLines()
True if the chart has drop lines. Applies only to line chart or area charts.
getHasDropLines() : boolean;
setHasDropLines(boolean)
True if the chart has drop lines. Applies only to line chart or area charts.
setHasDropLines(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDropLines()
Returns a Line object that represents the drop lines for a series on the line chart or area chart. Applies only to line chart or area charts.
getDropLines() : Line;
Returns
getHasUpDownBars()
True if a line chart has up and down bars. Applies only to line charts.
getHasUpDownBars() : boolean;
setHasUpDownBars(boolean)
True if a line chart has up and down bars. Applies only to line charts.
setHasUpDownBars(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getUpBars()
Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts.
getUpBars() : DropBars;
Returns
getDownBars()
Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts.
getDownBars() : DropBars;
Returns
isColorVaried()
Represents if the color of points is varied. The chart must contain only one series.
isColorVaried() : boolean;
setIsColorVaried(boolean)
Represents if the color of points is varied. The chart must contain only one series.
setIsColorVaried(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getGapWidth()
Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.
getGapWidth() : number;
setGapWidth(number)
Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.
setGapWidth(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getFirstSliceAngle()
Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
getFirstSliceAngle() : number;
setFirstSliceAngle(number)
Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
setFirstSliceAngle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getOverlap()
Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts.
getOverlap() : number;
setOverlap(number)
Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts.
setOverlap(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getSecondPlotSize()
Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.
getSecondPlotSize() : number;
setSecondPlotSize(number)
Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.
setSecondPlotSize(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getSplitType()
Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart.
getSplitType() : ChartSplitType;
Returns
setSplitType(ChartSplitType)
Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart.
setSplitType(value: ChartSplitType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ChartSplitType | The value to set. |
getSplitValue()
Returns or sets a value that shall be used to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart.
getSplitValue() : number;
setSplitValue(number)
Returns or sets a value that shall be used to determine which data points are in the second pie or bar on a pie of pie or bar of pie chart.
setSplitValue(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isAutoSplit()
Indicates whether the threshold value is automatic.
isAutoSplit() : boolean;
getBubbleScale()
Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts.
getBubbleScale() : number;
setBubbleScale(number)
Gets or sets the scale factor for bubbles in the specified chart group. It can be an integer value from 0 (zero) to 300, corresponding to a percentage of the default size. Applies only to bubble charts.
setBubbleScale(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getSizeRepresents()
Gets or sets what the bubble size represents on a bubble chart.
getSizeRepresents() : BubbleSizeRepresents;
Returns
Remarks
BubbleSizeRepresents.SizeIsArea means the value Series.BubbleSizes is the area of the bubble. BubbleSizeRepresents.SizeIsWidth means the value Series.BubbleSizes is the width of the bubble.
setSizeRepresents(BubbleSizeRepresents)
Gets or sets what the bubble size represents on a bubble chart.
setSizeRepresents(value: BubbleSizeRepresents) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BubbleSizeRepresents | The value to set. |
Remarks
BubbleSizeRepresents.SizeIsArea means the value Series.BubbleSizes is the area of the bubble. BubbleSizeRepresents.SizeIsWidth means the value Series.BubbleSizes is the width of the bubble.
getShowNegativeBubbles()
True if negative bubbles are shown for the chart group. Valid only for bubble charts.
getShowNegativeBubbles() : boolean;
setShowNegativeBubbles(boolean)
True if negative bubbles are shown for the chart group. Valid only for bubble charts.
setShowNegativeBubbles(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDoughnutHoleSize()
Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
getDoughnutHoleSize() : number;
setDoughnutHoleSize(number)
Returns or sets the size of the hole in a doughnut chart group. The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.
setDoughnutHoleSize(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getExplosion()
The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
getExplosion() : number;
setExplosion(number)
The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
setExplosion(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getHasRadarAxisLabels()
True if a radar chart has category axis labels. Applies only to radar charts.
getHasRadarAxisLabels() : boolean;
setHasRadarAxisLabels(boolean)
True if a radar chart has category axis labels. Applies only to radar charts.
setHasRadarAxisLabels(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getHasLeaderLines()
True if the series has leader lines.
getHasLeaderLines() : boolean;
setHasLeaderLines(boolean)
True if the series has leader lines.
setHasLeaderLines(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getLeaderLines()
Represents leader lines on a chart. Leader lines connect data labels to data points. This object isn’t a collection; there’s no object that represents a single leader line.
getLeaderLines() : Line;
Returns
getLegendEntry()
Gets the legend entry according to this series.
getLegendEntry() : LegendEntry;
Returns
getShapeProperties()
Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.
getShapeProperties() : ShapePropertyCollection;
Returns
move(number)
Moves the series up or down.
move(count: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| count | number | The number of moving up or down. /// Move the series up if this is less than zero; /// Move the series down if this is greater than zero. |