Series

Series class

Encapsulates the object that represents a single data series in a chart.

class Series;

Example

const { Workbook, ChartType, ChartMarkerType, FormattingType, Color } = require("aspose.cells.node");

//Instantiating a Workbook object
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "A4" cell
worksheet.cells.get("A4").putValue(200);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a sample value to "B4" cell
worksheet.cells.get("B4").putValue(40);
//Adding a sample value to "C1" cell as category data
worksheet.cells.get("C1").putValue("Q1");
//Adding a sample value to "C2" cell as category data
worksheet.cells.get("C2").putValue("Q2");
//Adding a sample value to "C3" cell as category data
worksheet.cells.get("C3").putValue("Y1");
//Adding a sample value to "C4" cell as category data
worksheet.cells.get("C4").putValue("Y2");
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.nSeries.add("A1:B4", true);
//Setting the data source for the category data of NSeries
chart.nSeries.categoryData = "C1:C4";
var series = chart.nSeries.get(1);
//Setting the values of the series.
series.values = "=B1:B4";
//Changing the chart type of the series.
series.type = ChartType.Line;
//Setting marker properties.
series.marker.markerStyle = ChartMarkerType.Circle;
series.marker.foregroundColorSetType = FormattingType.Automatic;
series.marker.foregroundColor = Color.Black;
series.marker.backgroundColorSetType = FormattingType.Automatic;
//Saving the Excel file
workbook.save("output/ChartsSeries.xls");

Properties

Property	Type	Description
isFiltered	boolean	Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
layoutProperties	SeriesLayoutProperties	Readonly. Represents the properties of layout.
points	ChartPointCollection	Readonly. Gets the collection of points in a series in a chart.
area	Area	Readonly. Represents the background area of Series object.
border	Line	Readonly. Represents border of Series object.
name	string	Gets or sets the name of the data series.
displayName	string	Readonly. Gets the series’s name that displays on the chart graph.
countOfDataValues	number	Readonly. Gets the number of the data values.
isVerticalValues	boolean	Readonly. Indicates whether the data source is vertical.
values	string	Represents the Y values of this chart series.
valuesFormatCode	string	Represents format code of Values’s NumberList.
xValuesFormatCode	string	Represents format code of X Values’s NumberList.
xValues	string	Represents the x values of the chart series.
bubbleSizes	string	Gets or sets the bubble sizes values of the chart series.
trendLines	TrendlineCollection	Readonly. Returns all the trendlines of this series.
smooth	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.
shadow	boolean	True if the series has a shadow.
has3DEffect	boolean	True if the series has a three-dimensional appearance. Applies only to bubble charts.
bar3DShapeType	Bar3DShapeType	Gets or sets the 3D shape type used with the 3-D bar or column chart.
dataLabels	DataLabels	Readonly. Represents the DataLabels object for the specified ASeries.
type	ChartType	Gets or sets a data series’ type.
marker	Marker	Readonly. Gets the marker.
plotOnSecondAxis	boolean	Indicates if this series is plotted on second value axis.
xErrorBar	ErrorBar	Readonly. Represents X direction error bar of the series.
yErrorBar	ErrorBar	Readonly. Represents Y direction error bar of the series.
hasHiLoLines	boolean	True if the line chart has high-low lines. Applies only to line charts.
hiLoLines	Line	Readonly. Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts.
hasSeriesLines	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.
seriesLines	Line	Readonly. 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.
hasDropLines	boolean	True if the chart has drop lines. Applies only to line chart or area charts.
dropLines	Line	Readonly. 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.
hasUpDownBars	boolean	True if a line chart has up and down bars. Applies only to line charts.
upBars	DropBars	Readonly. Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts.
downBars	DropBars	Readonly. Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts.
isColorVaried	boolean	Represents if the color of points is varied. The chart must contain only one series.
gapWidth	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.
firstSliceAngle	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.
overlap	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.
secondPlotSize	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.
splitType	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.
splitValue	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	boolean	Readonly. Indicates whether the threshold value is automatic.
bubbleScale	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.
sizeRepresents	BubbleSizeRepresents	Gets or sets what the bubble size represents on a bubble chart.
showNegativeBubbles	boolean	True if negative bubbles are shown for the chart group. Valid only for bubble charts.
doughnutHoleSize	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.
explosion	number	The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
hasRadarAxisLabels	boolean	True if a radar chart has category axis labels. Applies only to radar charts.
hasLeaderLines	boolean	True if the series has leader lines.
leaderLines	Line	Readonly. 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.
legendEntry	LegendEntry	Readonly. Gets the legend entry according to this series.
shapeProperties	ShapePropertyCollection	Readonly. Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.

Methods

Method	Description
isFiltered()	@deprecated. Please use the ‘isFiltered’ property instead. 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)	@deprecated. Please use the ‘isFiltered’ property instead. Indicates whether the series is selected or filtered.True represents this series is filtered, and it will not be displayed on the chart.
getLayoutProperties()	@deprecated. Please use the ’layoutProperties’ property instead. Represents the properties of layout.
getPoints()	@deprecated. Please use the ‘points’ property instead. Gets the collection of points in a series in a chart.
getArea()	@deprecated. Please use the ‘area’ property instead. Represents the background area of Series object.
getBorder()	@deprecated. Please use the ‘border’ property instead. Represents border of Series object.
getName()	@deprecated. Please use the ’name’ property instead. Gets or sets the name of the data series.
setName(string)	@deprecated. Please use the ’name’ property instead. Gets or sets the name of the data series.
getDisplayName()	@deprecated. Please use the ‘displayName’ property instead. Gets the series’s name that displays on the chart graph.
getCountOfDataValues()	@deprecated. Please use the ‘countOfDataValues’ property instead. Gets the number of the data values.
isVerticalValues()	@deprecated. Please use the ‘isVerticalValues’ property instead. Indicates whether the data source is vertical.
getValues()	@deprecated. Please use the ‘values’ property instead. Represents the Y values of this chart series.
setValues(string)	@deprecated. Please use the ‘values’ property instead. Represents the Y values of this chart series.
getValuesFormatCode()	@deprecated. Please use the ‘valuesFormatCode’ property instead. Represents format code of Values’s NumberList.
setValuesFormatCode(string)	@deprecated. Please use the ‘valuesFormatCode’ property instead. Represents format code of Values’s NumberList.
getXValuesFormatCode()	@deprecated. Please use the ‘xValuesFormatCode’ property instead. Represents format code of X Values’s NumberList.
setXValuesFormatCode(string)	@deprecated. Please use the ‘xValuesFormatCode’ property instead. Represents format code of X Values’s NumberList.
getXValues()	@deprecated. Please use the ‘xValues’ property instead. Represents the x values of the chart series.
setXValues(string)	@deprecated. Please use the ‘xValues’ property instead. Represents the x values of the chart series.
getBubbleSizes()	@deprecated. Please use the ‘bubbleSizes’ property instead. Gets or sets the bubble sizes values of the chart series.
setBubbleSizes(string)	@deprecated. Please use the ‘bubbleSizes’ property instead. Gets or sets the bubble sizes values of the chart series.
getTrendLines()	@deprecated. Please use the ’trendLines’ property instead. Returns all the trendlines of this series.
getSmooth()	@deprecated. Please use the ‘smooth’ property instead. 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)	@deprecated. Please use the ‘smooth’ property instead. 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()	@deprecated. Please use the ‘shadow’ property instead. True if the series has a shadow.
setShadow(boolean)	@deprecated. Please use the ‘shadow’ property instead. True if the series has a shadow.
getHas3DEffect()	@deprecated. Please use the ‘has3DEffect’ property instead. True if the series has a three-dimensional appearance. Applies only to bubble charts.
setHas3DEffect(boolean)	@deprecated. Please use the ‘has3DEffect’ property instead. True if the series has a three-dimensional appearance. Applies only to bubble charts.
getBar3DShapeType()	@deprecated. Please use the ‘bar3DShapeType’ property instead. Gets or sets the 3D shape type used with the 3-D bar or column chart.
setBar3DShapeType(Bar3DShapeType)	@deprecated. Please use the ‘bar3DShapeType’ property instead. Gets or sets the 3D shape type used with the 3-D bar or column chart.
getDataLabels()	@deprecated. Please use the ‘dataLabels’ property instead. Represents the DataLabels object for the specified ASeries.
getType()	@deprecated. Please use the ’type’ property instead. Gets or sets a data series’ type.
setType(ChartType)	@deprecated. Please use the ’type’ property instead. Gets or sets a data series’ type.
getMarker()	@deprecated. Please use the ‘marker’ property instead. Gets the marker.
getPlotOnSecondAxis()	@deprecated. Please use the ‘plotOnSecondAxis’ property instead. Indicates if this series is plotted on second value axis.
setPlotOnSecondAxis(boolean)	@deprecated. Please use the ‘plotOnSecondAxis’ property instead. Indicates if this series is plotted on second value axis.
getXErrorBar()	@deprecated. Please use the ‘xErrorBar’ property instead. Represents X direction error bar of the series.
getYErrorBar()	@deprecated. Please use the ‘yErrorBar’ property instead. Represents Y direction error bar of the series.
getHasHiLoLines()	@deprecated. Please use the ‘hasHiLoLines’ property instead. True if the line chart has high-low lines. Applies only to line charts.
setHasHiLoLines(boolean)	@deprecated. Please use the ‘hasHiLoLines’ property instead. True if the line chart has high-low lines. Applies only to line charts.
getHiLoLines()	@deprecated. Please use the ‘hiLoLines’ property instead. Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts.
getHasSeriesLines()	@deprecated. Please use the ‘hasSeriesLines’ property instead. 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)	@deprecated. Please use the ‘hasSeriesLines’ property instead. 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()	@deprecated. Please use the ‘seriesLines’ property instead. 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()	@deprecated. Please use the ‘hasDropLines’ property instead. True if the chart has drop lines. Applies only to line chart or area charts.
setHasDropLines(boolean)	@deprecated. Please use the ‘hasDropLines’ property instead. True if the chart has drop lines. Applies only to line chart or area charts.
getDropLines()	@deprecated. Please use the ‘dropLines’ property instead. 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()	@deprecated. Please use the ‘hasUpDownBars’ property instead. True if a line chart has up and down bars. Applies only to line charts.
setHasUpDownBars(boolean)	@deprecated. Please use the ‘hasUpDownBars’ property instead. True if a line chart has up and down bars. Applies only to line charts.
getUpBars()	@deprecated. Please use the ‘upBars’ property instead. Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts.
getDownBars()	@deprecated. Please use the ‘downBars’ property instead. Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts.
isColorVaried()	@deprecated. Please use the ‘isColorVaried’ property instead. Represents if the color of points is varied. The chart must contain only one series.
setIsColorVaried(boolean)	@deprecated. Please use the ‘isColorVaried’ property instead. Represents if the color of points is varied. The chart must contain only one series.
getGapWidth()	@deprecated. Please use the ‘gapWidth’ property instead. 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)	@deprecated. Please use the ‘gapWidth’ property instead. 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()	@deprecated. Please use the ‘firstSliceAngle’ property instead. 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)	@deprecated. Please use the ‘firstSliceAngle’ property instead. 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()	@deprecated. Please use the ‘overlap’ property instead. 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)	@deprecated. Please use the ‘overlap’ property instead. 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()	@deprecated. Please use the ‘secondPlotSize’ property instead. 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)	@deprecated. Please use the ‘secondPlotSize’ property instead. 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()	@deprecated. Please use the ‘splitType’ property instead. 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)	@deprecated. Please use the ‘splitType’ property instead. 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()	@deprecated. Please use the ‘splitValue’ property instead. 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)	@deprecated. Please use the ‘splitValue’ property instead. 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()	@deprecated. Please use the ‘isAutoSplit’ property instead. Indicates whether the threshold value is automatic.
getBubbleScale()	@deprecated. Please use the ‘bubbleScale’ property instead. 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)	@deprecated. Please use the ‘bubbleScale’ property instead. 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()	@deprecated. Please use the ‘sizeRepresents’ property instead. Gets or sets what the bubble size represents on a bubble chart.
setSizeRepresents(BubbleSizeRepresents)	@deprecated. Please use the ‘sizeRepresents’ property instead. Gets or sets what the bubble size represents on a bubble chart.
getShowNegativeBubbles()	@deprecated. Please use the ‘showNegativeBubbles’ property instead. True if negative bubbles are shown for the chart group. Valid only for bubble charts.
setShowNegativeBubbles(boolean)	@deprecated. Please use the ‘showNegativeBubbles’ property instead. True if negative bubbles are shown for the chart group. Valid only for bubble charts.
getDoughnutHoleSize()	@deprecated. Please use the ‘doughnutHoleSize’ property instead. 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)	@deprecated. Please use the ‘doughnutHoleSize’ property instead. 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()	@deprecated. Please use the ’explosion’ property instead. 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)	@deprecated. Please use the ’explosion’ property instead. The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
getHasRadarAxisLabels()	@deprecated. Please use the ‘hasRadarAxisLabels’ property instead. True if a radar chart has category axis labels. Applies only to radar charts.
setHasRadarAxisLabels(boolean)	@deprecated. Please use the ‘hasRadarAxisLabels’ property instead. True if a radar chart has category axis labels. Applies only to radar charts.
getHasLeaderLines()	@deprecated. Please use the ‘hasLeaderLines’ property instead. True if the series has leader lines.
setHasLeaderLines(boolean)	@deprecated. Please use the ‘hasLeaderLines’ property instead. True if the series has leader lines.
getLeaderLines()	@deprecated. Please use the ’leaderLines’ property instead. 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()	@deprecated. Please use the ’legendEntry’ property instead. Gets the legend entry according to this series.
getShapeProperties()	@deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.
move(number)	Moves the series up or down.
isNull()	Checks whether the implementation object is null.

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;

layoutProperties

Readonly. Represents the properties of layout.

layoutProperties : SeriesLayoutProperties;

points

Readonly. Gets the collection of points in a series in a chart.

points : ChartPointCollection;

Remarks

When the chart is Pie of Pie or Bar of Pie, the last point is other point in first pie plot.

area

Readonly. Represents the background area of Series object.

area : Area;

border

Readonly. Represents border of Series object.

border : Line;

name

Gets or sets the name of the data series.

name : string;

Example

const { Workbook, ChartType } = require("aspose.cells.node");

var workbook = new Workbook();
//Get the first worksheet.
var worksheet = workbook.worksheets.get(0);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.nSeries.add("A1:B4", true);
//Reference name to a cell
chart.nSeries.get(0).name = "=A1";
//Set a string to name
chart.nSeries.get(0).name = "First Series";

displayName

Readonly. Gets the series’s name that displays on the chart graph.

displayName : string;

countOfDataValues

Readonly. Gets the number of the data values.

countOfDataValues : number;

isVerticalValues

Readonly. Indicates whether the data source is vertical.

isVerticalValues : boolean;

values

Represents the Y values of this chart series.

values : string;

valuesFormatCode

Represents format code of Values’s NumberList.

valuesFormatCode : string;

xValuesFormatCode

Represents format code of X Values’s NumberList.

xValuesFormatCode : string;

xValues

Represents the x values of the chart series.

xValues : string;

bubbleSizes

Gets or sets the bubble sizes values of the chart series.

bubbleSizes : string;

trendLines

Readonly. Returns all the trendlines of this series.

trendLines : TrendlineCollection;

smooth

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.

smooth : boolean;

shadow

True if the series has a shadow.

shadow : boolean;

has3DEffect

True if the series has a three-dimensional appearance. Applies only to bubble charts.

has3DEffect : boolean;

bar3DShapeType

Gets or sets the 3D shape type used with the 3-D bar or column chart.

bar3DShapeType : Bar3DShapeType;

dataLabels

Readonly. Represents the DataLabels object for the specified ASeries.

dataLabels : DataLabels;

type

Gets or sets a data series’ type.

type : ChartType;

marker

Readonly. Gets the marker.

marker : Marker;

plotOnSecondAxis

Indicates if this series is plotted on second value axis.

plotOnSecondAxis : boolean;

xErrorBar

Readonly. Represents X direction error bar of the series.

xErrorBar : ErrorBar;

yErrorBar

Readonly. Represents Y direction error bar of the series.

yErrorBar : ErrorBar;

hasHiLoLines

True if the line chart has high-low lines. Applies only to line charts.

hasHiLoLines : boolean;

hiLoLines

Readonly. Returns a HiLoLines object that represents the high-low lines for a series on a line chart. Applies only to line charts.

hiLoLines : Line;

hasSeriesLines

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.

hasSeriesLines : boolean;

seriesLines

Readonly. 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.

seriesLines : Line;

hasDropLines

True if the chart has drop lines. Applies only to line chart or area charts.

hasDropLines : boolean;

dropLines

Readonly. 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.

dropLines : Line;

hasUpDownBars

True if a line chart has up and down bars. Applies only to line charts.

hasUpDownBars : boolean;

upBars

Readonly. Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts.

upBars : DropBars;

downBars

Readonly. Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts.

downBars : DropBars;

isColorVaried

Represents if the color of points is varied. The chart must contain only one series.

isColorVaried : boolean;

gapWidth

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.

gapWidth : number;

firstSliceAngle

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.

firstSliceAngle : number;

overlap

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.

overlap : number;

secondPlotSize

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.

secondPlotSize : number;

splitType

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.

splitType : ChartSplitType;

splitValue

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.

splitValue : number;

isAutoSplit

Readonly. Indicates whether the threshold value is automatic.

isAutoSplit : boolean;

bubbleScale

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.

bubbleScale : number;

sizeRepresents

Gets or sets what the bubble size represents on a bubble chart.

sizeRepresents : BubbleSizeRepresents;

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.

showNegativeBubbles

True if negative bubbles are shown for the chart group. Valid only for bubble charts.

showNegativeBubbles : boolean;

doughnutHoleSize

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.

doughnutHoleSize : number;

explosion

The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.

explosion : number;

hasRadarAxisLabels

True if a radar chart has category axis labels. Applies only to radar charts.

hasRadarAxisLabels : boolean;

hasLeaderLines

True if the series has leader lines.

hasLeaderLines : boolean;

leaderLines

Readonly. 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.

leaderLines : Line;

legendEntry

Readonly. Gets the legend entry according to this series.

legendEntry : LegendEntry;

shapeProperties

Readonly. Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.

shapeProperties : ShapePropertyCollection;

isFiltered()

@deprecated. Please use the ‘isFiltered’ property instead. 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)

setIsFiltered(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLayoutProperties()

@deprecated. Please use the ’layoutProperties’ property instead. Represents the properties of layout.

getLayoutProperties() : SeriesLayoutProperties;

Returns

SeriesLayoutProperties

getPoints()

@deprecated. Please use the ‘points’ property instead. Gets the collection of points in a series in a chart.

getPoints() : ChartPointCollection;

Returns

ChartPointCollection

Remarks

When the chart is Pie of Pie or Bar of Pie, the last point is other point in first pie plot.

getArea()

@deprecated. Please use the ‘area’ property instead. Represents the background area of Series object.

getArea() : Area;

Returns

Area

getBorder()

@deprecated. Please use the ‘border’ property instead. Represents border of Series object.

getBorder() : Line;

Returns

Line

getName()

@deprecated. Please use the ’name’ property instead. Gets or sets the name of the data series.

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Gets or sets the name of the data series.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getDisplayName()

@deprecated. Please use the ‘displayName’ property instead. Gets the series’s name that displays on the chart graph.

getDisplayName() : string;

getCountOfDataValues()

@deprecated. Please use the ‘countOfDataValues’ property instead. Gets the number of the data values.

getCountOfDataValues() : number;

isVerticalValues()

@deprecated. Please use the ‘isVerticalValues’ property instead. Indicates whether the data source is vertical.

isVerticalValues() : boolean;

getValues()

@deprecated. Please use the ‘values’ property instead. Represents the Y values of this chart series.

getValues() : string;

setValues(string)

@deprecated. Please use the ‘values’ property instead. Represents the Y values of this chart series.

setValues(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValuesFormatCode()

@deprecated. Please use the ‘valuesFormatCode’ property instead. Represents format code of Values’s NumberList.

getValuesFormatCode() : string;

setValuesFormatCode(string)

@deprecated. Please use the ‘valuesFormatCode’ property instead. Represents format code of Values’s NumberList.

setValuesFormatCode(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getXValuesFormatCode()

@deprecated. Please use the ‘xValuesFormatCode’ property instead. Represents format code of X Values’s NumberList.

getXValuesFormatCode() : string;

setXValuesFormatCode(string)

@deprecated. Please use the ‘xValuesFormatCode’ property instead. Represents format code of X Values’s NumberList.

setXValuesFormatCode(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getXValues()

@deprecated. Please use the ‘xValues’ property instead. Represents the x values of the chart series.

getXValues() : string;

setXValues(string)

@deprecated. Please use the ‘xValues’ property instead. Represents the x values of the chart series.

setXValues(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getBubbleSizes()

@deprecated. Please use the ‘bubbleSizes’ property instead. Gets or sets the bubble sizes values of the chart series.

getBubbleSizes() : string;

setBubbleSizes(string)

@deprecated. Please use the ‘bubbleSizes’ property instead. 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()

@deprecated. Please use the ’trendLines’ property instead. Returns all the trendlines of this series.

getTrendLines() : TrendlineCollection;

Returns

TrendlineCollection

getSmooth()

@deprecated. Please use the ‘smooth’ property instead. 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)

setSmooth(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShadow()

@deprecated. Please use the ‘shadow’ property instead. True if the series has a shadow.

getShadow() : boolean;

setShadow(boolean)

@deprecated. Please use the ‘shadow’ property instead. True if the series has a shadow.

setShadow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getHas3DEffect()

@deprecated. Please use the ‘has3DEffect’ property instead. True if the series has a three-dimensional appearance. Applies only to bubble charts.

getHas3DEffect() : boolean;

setHas3DEffect(boolean)

@deprecated. Please use the ‘has3DEffect’ property instead. 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()

@deprecated. Please use the ‘bar3DShapeType’ property instead. Gets or sets the 3D shape type used with the 3-D bar or column chart.

getBar3DShapeType() : Bar3DShapeType;

Returns

Bar3DShapeType

setBar3DShapeType(Bar3DShapeType)

@deprecated. Please use the ‘bar3DShapeType’ property instead. 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()

@deprecated. Please use the ‘dataLabels’ property instead. Represents the DataLabels object for the specified ASeries.

getDataLabels() : DataLabels;

Returns

DataLabels

getType()

@deprecated. Please use the ’type’ property instead. Gets or sets a data series’ type.

getType() : ChartType;

Returns

ChartType

setType(ChartType)

@deprecated. Please use the ’type’ property instead. Gets or sets a data series’ type.

setType(value: ChartType) : void;

Parameters:

Parameter	Type	Description
value	ChartType	The value to set.

getMarker()

@deprecated. Please use the ‘marker’ property instead. Gets the marker.

getMarker() : Marker;

Returns

Marker

getPlotOnSecondAxis()

@deprecated. Please use the ‘plotOnSecondAxis’ property instead. Indicates if this series is plotted on second value axis.

getPlotOnSecondAxis() : boolean;

setPlotOnSecondAxis(boolean)

@deprecated. Please use the ‘plotOnSecondAxis’ property instead. 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()

@deprecated. Please use the ‘xErrorBar’ property instead. Represents X direction error bar of the series.

getXErrorBar() : ErrorBar;

Returns

ErrorBar

getYErrorBar()

@deprecated. Please use the ‘yErrorBar’ property instead. Represents Y direction error bar of the series.

getYErrorBar() : ErrorBar;

Returns

ErrorBar

getHasHiLoLines()

@deprecated. Please use the ‘hasHiLoLines’ property instead. True if the line chart has high-low lines. Applies only to line charts.

getHasHiLoLines() : boolean;

setHasHiLoLines(boolean)

@deprecated. Please use the ‘hasHiLoLines’ property instead. 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()

@deprecated. Please use the ‘hiLoLines’ property instead. 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

Line

getHasSeriesLines()

@deprecated. Please use the ‘hasSeriesLines’ property instead. 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)

setHasSeriesLines(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSeriesLines()

@deprecated. Please use the ‘seriesLines’ property instead. 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

Line

getHasDropLines()

@deprecated. Please use the ‘hasDropLines’ property instead. True if the chart has drop lines. Applies only to line chart or area charts.

getHasDropLines() : boolean;

setHasDropLines(boolean)

@deprecated. Please use the ‘hasDropLines’ property instead. 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()

@deprecated. Please use the ‘dropLines’ property instead. 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

Line

getHasUpDownBars()

@deprecated. Please use the ‘hasUpDownBars’ property instead. True if a line chart has up and down bars. Applies only to line charts.

getHasUpDownBars() : boolean;

setHasUpDownBars(boolean)

@deprecated. Please use the ‘hasUpDownBars’ property instead. 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()

@deprecated. Please use the ‘upBars’ property instead. Returns an DropBars object that represents the up bars on a line chart. Applies only to line charts.

getUpBars() : DropBars;

Returns

DropBars

getDownBars()

@deprecated. Please use the ‘downBars’ property instead. Returns a DropBars object that represents the down bars on a line chart. Applies only to line charts.

getDownBars() : DropBars;

Returns

DropBars

isColorVaried()

@deprecated. Please use the ‘isColorVaried’ property instead. Represents if the color of points is varied. The chart must contain only one series.

isColorVaried() : boolean;

setIsColorVaried(boolean)

@deprecated. Please use the ‘isColorVaried’ property instead. 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()

@deprecated. Please use the ‘gapWidth’ property instead. 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)

setGapWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getFirstSliceAngle()

@deprecated. Please use the ‘firstSliceAngle’ property instead. 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)

setFirstSliceAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOverlap()

@deprecated. Please use the ‘overlap’ property instead. 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)

@deprecated. Please use the ‘overlap’ property instead. 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()

@deprecated. Please use the ‘secondPlotSize’ property instead. 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)

setSecondPlotSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSplitType()

@deprecated. Please use the ‘splitType’ property instead. 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

ChartSplitType

setSplitType(ChartSplitType)

@deprecated. Please use the ‘splitType’ property instead. 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()

@deprecated. Please use the ‘splitValue’ property instead. 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)

setSplitValue(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isAutoSplit()

@deprecated. Please use the ‘isAutoSplit’ property instead. Indicates whether the threshold value is automatic.

isAutoSplit() : boolean;

getBubbleScale()

@deprecated. Please use the ‘bubbleScale’ property instead. 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)

setBubbleScale(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSizeRepresents()

@deprecated. Please use the ‘sizeRepresents’ property instead. Gets or sets what the bubble size represents on a bubble chart.

getSizeRepresents() : BubbleSizeRepresents;

Returns

BubbleSizeRepresents

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)

@deprecated. Please use the ‘sizeRepresents’ property instead. 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()

@deprecated. Please use the ‘showNegativeBubbles’ property instead. True if negative bubbles are shown for the chart group. Valid only for bubble charts.

getShowNegativeBubbles() : boolean;

setShowNegativeBubbles(boolean)

@deprecated. Please use the ‘showNegativeBubbles’ property instead. 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()

@deprecated. Please use the ‘doughnutHoleSize’ property instead. 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)

setDoughnutHoleSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getExplosion()

@deprecated. Please use the ’explosion’ property instead. 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)

@deprecated. Please use the ’explosion’ property instead. 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()

@deprecated. Please use the ‘hasRadarAxisLabels’ property instead. True if a radar chart has category axis labels. Applies only to radar charts.

getHasRadarAxisLabels() : boolean;

setHasRadarAxisLabels(boolean)

@deprecated. Please use the ‘hasRadarAxisLabels’ property instead. 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()

@deprecated. Please use the ‘hasLeaderLines’ property instead. True if the series has leader lines.

getHasLeaderLines() : boolean;

setHasLeaderLines(boolean)

@deprecated. Please use the ‘hasLeaderLines’ property instead. True if the series has leader lines.

setHasLeaderLines(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLeaderLines()

@deprecated. Please use the ’leaderLines’ property instead. 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

Line

getLegendEntry()

@deprecated. Please use the ’legendEntry’ property instead. Gets the legend entry according to this series.

getLegendEntry() : LegendEntry;

Returns

LegendEntry

getShapeProperties()

@deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapePropertyCollection object that holds the visual shape properties of the Series.

getShapeProperties() : ShapePropertyCollection;

Returns

ShapePropertyCollection

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.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;