constructor

• new Series(a): Series

• Parameters

  • a: IChartObject

  Returns Series

Static $t

applyPicToEnd

• get applyPicToEnd(): boolean

• Apply the picture to the end of the series.

  Returns boolean

• set applyPicToEnd(a): void

• Parameters

  • a: boolean

  Returns void

applyPicToFront

• get applyPicToFront(): boolean

• Apply the picture to the front of the series.

  Returns boolean

• set applyPicToFront(a): void

• Parameters

  • a: boolean

  Returns void

applyPicToSides

• get applyPicToSides(): boolean

• Apply the picture to the sides.

  Returns boolean

• set applyPicToSides(a): void

• Parameters

  • a: boolean

  Returns void

axisBinning

• get axisBinning(): CategoryAxisBinning

• Returns or sets a [[CategoryAxisBinning]] instance which determines the binning properties for the category axis on a histogram or pareto chart.

  This property is only applicable for histogram and pareto charts.

  Returns CategoryAxisBinning

• set axisBinning(a): void

• Parameters

  • a: CategoryAxisBinning

  Returns void

axisGroup

• get axisGroup(): AxisGroup

• Specifies which axis group this series applies to.

  This property is only applicable for combo charts.

  This property defaults to Primary, causing all series to be plotted on the primary axis unless otherwise specified.

  To plot this series on the secondary value axis, set this property to Secondary.

  Setting this property to Secondary triggers creation of secondary category and value axes.

  Not all series can be plotted on the same axis; the following table lists each ChartType along with the other ChartTypes which can be plotted on the same axis:

  ChartType	Valid on same axis
  ColumnClustered	Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  ColumnStacked	Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  ColumnStacked100	Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  BarClustered	BarClustered only
  BarStacked	BarStacked only
  BarStacked100	BarStacked100 only
  Line	ColumnClustered, ColumnStacked, ColumnStacked100, LineMarkers, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  LineStacked	ColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  LineStacked100	ColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  LineMarkers	ColumnClustered, ColumnStacked, ColumnStacked100, Line, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  LineMarkersStacked	ColumnClustered, ColumnStacked, ColumnStacked100, LineStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  LineMarkersStacked100	ColumnClustered, ColumnStacked, ColumnStacked100, LineStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  Area	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  AreaStacked	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  AreaStacked100	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  Pie	PieExploded, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
  PieExploded	Pie, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
  BarOfPie	Pie, PieExploded, PieOfPie, Doughnut, DoughnutExploded
  PieOfPie	Pie, PieExploded, BarOfPie, Doughnut, DoughnutExploded
  Doughnut	Pie, PieExploded, BarOfPie, PieOfPie, DoughnutExploded
  DoughnutExploded	Pie, PieExploded, BarOfPie, PieOfPie, Doughnut
  XYScatter	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  XYScatterLines	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
  XYScatterLinesNoMarkers	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterSmooth, XYScatterSmoothNoMarkers
  XYScatterSmooth	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmoothNoMarkers
  XYScatterSmoothNoMarkers	ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth
  Radar	RadarFilled, RadarMarkers
  RadarFilled	Radar, RadarMarkers
  RadarMarkers	Radar, RadarFilled

  Attempting to set the series axis to the same value as an incompatible series causes an exception to be thrown.

  See

  • [[chartType]]
  • [[Axis]]
  • [[WorksheetChart.axisCollection]]

  Throws

  [[NotSupportedException]] The target axis already contains a chart type which cannot share axes with this series because of the value of the [[chartType]] property of this series.

  Returns AxisGroup

• set axisGroup(a): void

• Parameters

  • a: AxisGroup

  Returns void

barShape

• get barShape(): BarShape

• Determines the shape of the bar for this series. Applicable only for 3D bar charts.

  This property controls the shape of the bar displayed for this series only.

  To set the bar shape for all series in the chart, use the [[WorksheetChart.barShape]] property.

  See

  [[WorksheetChart.barShape]]

  Returns BarShape

• set barShape(a): void

• Parameters

  • a: BarShape

  Returns void

barShapeResolved

• get barShapeResolved(): BarShape

• Returns the resolved value of the [[barShape]] property.

  See

  • [[barShape]]
  • [[WorksheetChart.barShape]]

  Returns BarShape

border

• get border(): ChartBorder

• Determines the appearance of the border drawn around the [[fill]] area. Applicable only for chart series which support fills, such as bar charts, area charts, and pie charts.

  For series which support fills, this property controls the color and size of the line drawn around the fill region.

  For line-based series, use the [[line]] property.

  See

  • [[fill]]
  • [[line]]

  Returns ChartBorder

• set border(a): void

• Parameters

  • a: ChartBorder

  Returns void

boxAndWhiskerSettings

• get boxAndWhiskerSettings(): BoxAndWhiskerSettings

• Returns or sets a [[boxAndWhiskerSettings]] instance which determines the properties for a box and whisker chart.

  This property is only applicable for box and whisker charts.

  Returns BoxAndWhiskerSettings

• set boxAndWhiskerSettings(a): void

• Parameters

  • a: BoxAndWhiskerSettings

  Returns void

bubbleSizes

• get bubbleSizes(): SeriesValues

• Returns or sets a [[values]] instance that determines the bubble sizes in a bubble chart.

  Returns SeriesValues

• set bubbleSizes(a): void

• Parameters

  • a: SeriesValues

  Returns void

chartType

• get chartType(): ChartType

• Specifies the type of chart for this series. Applicable only for combo charts.

  This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

  Not all ChartType values are supported for series which are plotted within a combo chart. For a list of the supported values, see documentation for the WorksheetChart.SetComboChartSourceData method.

  If the value assigned to this property necessitates plotting this series on a different axis than the one referenced by the [[axisGroup]] property, and the other axis can accommodate this series, the AxisGroup property is changed accordingly.

  If the other axis cannot accommodate this series, and other series which are of the same series type exist on the same axis, an attempt is made to change the ChartType of those other series. For example, if a different series exists with a ChartType of BarClustered, and a value of BarStacked is assigned to this series, the ChartType of the other series is changed to BarStacked in order to accommodate the setting of the property on this series.

  If no adjustment can be made that would allow the ChartType to be changed to the specified value, an exception is thrown.

  Note that in all cases, the value of the [[type]] property is automatically changed to a value which is appropriate for the assigned ChartType.

  See

  • [[type]]
  • [[axisGroup]]

  Throws

  [[NotSupportedException]] The [[axisGroup]] on which this series currently resides cannot share an axis with a series of this ChartType, and no adjustment could be made to avoid this.

  Returns ChartType

• set chartType(a): void

• Parameters

  • a: ChartType

  Returns void

dataLabels

• get dataLabels(): SeriesDataLabels

• Returns a [[SeriesDataLabels]] instance which applies to all [[DataLabel]] instances which do not have a specific setting for a given property.

  Use the [[DataPoint.dataLabel]] property to customize an individual data label.

  Returns SeriesDataLabels

errorBars

• get errorBars(): ErrorBars

• Returns or sets an [[ErrorBars]] object.

  Returns ErrorBars

• set errorBars(a): void

• Parameters

  • a: ErrorBars

  Returns void

explosion

• get explosion(): number

• Returns or sets a value which determines the amount by which individual slices are offset from the center of the pie or doughnut, expressed as a percentage of the radius.

  The valid range of values is between 0 and 400, inclusive.

  Throws

  [[ArgumentOutOfRangeException]] The value is outside the range of 0 and 400.

  Returns number

• set explosion(a): void

• Parameters

  • a: number

  Returns void

fill

• get fill(): ChartFillBase

• Returns or sets a [[ChartFillBase]] derived object which defines the fill for this series. Not applicable for line charts.

  This property is not applicable to charts which depict the data series as a line. For these chart types, use the [[line]] property, which controls the color and width of the line.

  See

  [[border]]

  Returns ChartFillBase

• set fill(a): void

• Parameters

  • a: ChartFillBase

  Returns void

geographicMapSettings

• get geographicMapSettings(): GeographicMapSettings

• Returns or sets a [[geographicMapSettings]] instance which defines the appearance and behavior for a geographic map chart.

  This property is only applicable when the ChartType property is set to RegionMap.

  Returns GeographicMapSettings

• set geographicMapSettings(a): void

• Parameters

  • a: GeographicMapSettings

  Returns void

invertIfNegative

• get invertIfNegative(): boolean

• Determines if negative values will be inverted.

  Returns boolean

• set invertIfNegative(a): void

• Parameters

  • a: boolean

  Returns void

leaderLines

• get leaderLines(): LeaderLines

• Returns or sets the instance.

  A leader line connects a [[DataLabel]] to it's associated series.

  See

  • [[leaderLines]]
  • [[DataLabel]]
  • [[dataPointCollection]]

  Returns LeaderLines

• set leaderLines(a): void

• Parameters

  • a: LeaderLines

  Returns void

line

• get line(): ChartLine

• Determines the fill and width of a series line.

  This property is not applicable for series which support fills, such as bar, area, or pie charts.

  For chart series which supports fills, use the [[fill]] property to control the fill color, and the [[border]] property for the line drawn around that fill area.

  See

  • [[fill]]
  • [[border]]
  • [[markerFill]]
  • [[markerBorder]]

  Returns ChartLine

• set line(a): void

• Parameters

  • a: ChartLine

  Returns void

markerBorder

• get markerBorder(): ChartBorder

• Determines the appearance of the border (a.k.a. outline) for the marker.

  Returns ChartBorder

• set markerBorder(a): void

• Parameters

  • a: ChartBorder

  Returns void

markerFill

• get markerFill(): ChartFillBase

• Defines the fill appearance for the marker.

  Returns ChartFillBase

• set markerFill(a): void

• Parameters

  • a: ChartFillBase

  Returns void

markerSize

• get markerSize(): number

• Determines the size of the markers.

  Returns number

• set markerSize(a): void

• Parameters

  • a: number

  Returns void

markerStyle

• get markerStyle(): MarkerStyle

• Determines the style of the markers

  Returns MarkerStyle

• set markerStyle(a): void

• Parameters

  • a: MarkerStyle

  Returns void

name

• get name(): SeriesName

• The name of the series

  Returns SeriesName

• set name(a): void

• Parameters

  • a: SeriesName

  Returns void

owningSeries

• get owningSeries(): Series

• Returns or sets a reference to the owning [[Series]]. Applicable only for a line series in a Pareto chart.

  This property is only applicable for Series contained within a Pareto chart.

  If the [[chartType]] property of this series, as well as that of the associated chart, are not both set to 'Pareto', an exception is thrown.

  If the value assigned to this property has a [[chartType]] of any value other than 'ClusteredColumn', an exception is thrown.

  Returns Series

• set owningSeries(a): void

• Parameters

  • a: Series

  Returns void

pictureType

• get pictureType(): PictureType

• Determines whether pictures are scaled, stacked, or stretched.

  Returns PictureType

• set pictureType(a): void

• Parameters

  • a: PictureType

  Returns void

pictureUnit

• get pictureUnit(): number

• Returns or sets a value which defines the unit of measure when [[pictureType]] is set to Stack.

  Returns number

• set pictureUnit(a): void

• Parameters

  • a: number

  Returns void

plotOrder

• get plotOrder(): number

• The plotting order for the data series. Note: this is the order in which the series names will appear in the legend. When there is only one series then this is omitted. This must be a whole number between 1 and the number of series on the chart. If you enter zero then 1 is used. If you enter a number greater than the number of series then the total number of series is used.

  Returns number

• set plotOrder(a): void

• Parameters

  • a: number

  Returns void

showDataLabels

• get showDataLabels(): boolean

• Returns or sets a boolean value indicating whether to display [[dataLabels]].

  Returns boolean

• set showDataLabels(a): void

• Parameters

  • a: boolean

  Returns void

showWaterfallConnectorLines

• get showWaterfallConnectorLines(): boolean

• Returns or sets a boolean value indicating whether to display connecting lines between the data points in a waterfall chart.

  This property is only applicable for waterfall charts.

  Use the [[border]] property to control the visual appearance of the connector lines.

  Returns boolean

• set showWaterfallConnectorLines(a): void

• Parameters

  • a: boolean

  Returns void

smooth

• get smooth(): boolean

• Determines whether a smoothing effect should be applied.

  Returns boolean

• set smooth(a): void

• Parameters

  • a: boolean

  Returns void

type

• get type(): SeriesType

• Returns or sets a [[SeriesType]] value which determines the type of this series. Applicable only for combo charts.

  This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

  Combo charts do not support Bubble or Surface; setting this property to either of those values causes an exception to be thrown.

  The [[chartType]] property must be set to a value that is compatible with assigned series type. If the current value of the ChartType property is not compatible with the value assigned to this property, a reasonable default value, which is compatible, is assigned to the ChartType property.

  See

  [[chartType]]

  Returns SeriesType

• set type(a): void

• Parameters

  • a: SeriesType

  Returns void

values

• get values(): SeriesValues

• Returns or sets a [[values]] instance that contains a collection of all the values in the series. The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

  Returns SeriesValues

• set values(a): void

• Parameters

  • a: SeriesValues

  Returns void

xValues

• get xValues(): XValues

• Returns or sets a [[xValues]] instance that contains a collection of all the x values in the series. The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

  Returns XValues

• set xValues(a): void

• Parameters

  • a: XValues

  Returns void

dataPointCollection

• dataPointCollection(index): DataPoint

• Returns the [[DataPoint]] instance at the specified ordinal position within this collection.

  Parameters

  • index: number

    A zero based index

  Returns DataPoint

• dataPointCollection(): DataPointCollection

• Returns a collection of [[DataPoint]] instances which represent the individual data points in this series.

  Returns DataPointCollection

trendlineCollection

• trendlineCollection(index): Trendline

• Returns the [[Trendline]] instance at the specified ordinal position within the collection.

  Parameters

  • index: number

    A zero based index

  Returns Trendline

• trendlineCollection(): TrendlineCollection

• Returns a collection of [[Trendline]] instances for this series.

  Trendlines are supported for Area, Bar, Bubble, Line, and Scatter charts, and are not supported for other chart types.

  See

  [[Trendline]]

  Returns TrendlineCollection