An object that represents a specific series in a chart

Series

new Series(a: IChartObject): Series

Returns Series

Apply the picture to the end of the series.

get applyPicToEnd(): boolean

Returns boolean

set applyPicToEnd(a: boolean): void

Parameters

  • a: boolean

Returns void

Apply the picture to the front of the series.

get applyPicToFront(): boolean

Returns boolean

set applyPicToFront(a: boolean): void

Parameters

  • a: boolean

Returns void

Apply the picture to the sides.

get applyPicToSides(): boolean

Returns boolean

set applyPicToSides(a: boolean): void

Parameters

  • a: boolean

Returns void

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

get axisBinning(): CategoryAxisBinning

Returns CategoryAxisBinning

set axisBinning(a: CategoryAxisBinning): void

Parameters

Returns void

Specifies which axis group this series applies to.

get axisGroup(): AxisGroup

Returns AxisGroup

set axisGroup(a: AxisGroup): void

Parameters

Returns void

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

get barShape(): BarShape | null

Returns BarShape | null

set barShape(a: BarShape | null): void

Parameters

Returns void

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

get barShapeResolved(): BarShape

Returns BarShape

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.

get border(): ChartBorder

Returns ChartBorder

set border(a: ChartBorder): void

Parameters

Returns void

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

get boxAndWhiskerSettings(): BoxAndWhiskerSettings

Returns BoxAndWhiskerSettings

set boxAndWhiskerSettings(a: BoxAndWhiskerSettings): void

Parameters

Returns void

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

get bubbleSizes(): SeriesValues

Returns SeriesValues

set bubbleSizes(a: SeriesValues): void

Parameters

Returns void

Inherited from: ChartObject

Returns the owning chart (read-only)

get chart(): WorksheetChart

Returns WorksheetChart

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

get chartType(): ChartType

Returns ChartType

set chartType(a: ChartType): void

Parameters

Returns void

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

get dataLabels(): SeriesDataLabels

Returns SeriesDataLabels

Returns or sets an [[ErrorBars]] object.

get errorBars(): ErrorBars

Returns ErrorBars

set errorBars(a: ErrorBars): void

Parameters

Returns void

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.

get explosion(): number

Returns number

set explosion(a: number): void

Parameters

  • a: number

Returns void

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

get fill(): ChartFillBase

Returns ChartFillBase

set fill(a: ChartFillBase): void

Parameters

Returns void

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

get geographicMapSettings(): GeographicMapSettings

Returns GeographicMapSettings

set geographicMapSettings(a: GeographicMapSettings): void

Parameters

Returns void

Determines if negative values will be inverted.

get invertIfNegative(): boolean

Returns boolean

set invertIfNegative(a: boolean): void

Parameters

  • a: boolean

Returns void

Returns or sets the instance.

get leaderLines(): LeaderLines

Returns LeaderLines

set leaderLines(a: LeaderLines): void

Parameters

Returns void

Determines the fill and width of a series line.

get line(): ChartLine

Returns ChartLine

set line(a: ChartLine): void

Parameters

Returns void

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

get markerBorder(): ChartBorder

Returns ChartBorder

set markerBorder(a: ChartBorder): void

Parameters

Returns void

Defines the fill appearance for the marker.

get markerFill(): ChartFillBase

Returns ChartFillBase

set markerFill(a: ChartFillBase): void

Parameters

Returns void

Determines the size of the markers.

get markerSize(): number

Returns number

set markerSize(a: number): void

Parameters

  • a: number

Returns void

Determines the style of the markers

get markerStyle(): MarkerStyle

Returns MarkerStyle

set markerStyle(a: MarkerStyle): void

Parameters

Returns void

The name of the series

get name(): SeriesName

Returns SeriesName

set name(a: SeriesName): void

Parameters

Returns void

Inherited from: ChartObject

returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

get owner(): ChartObject

Returns ChartObject

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

get owningSeries(): Series

Returns Series

set owningSeries(a: Series): void

Parameters

Returns void

Determines whether pictures are scaled, stacked, or stretched.

get pictureType(): PictureType

Returns PictureType

set pictureType(a: PictureType): void

Parameters

Returns void

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

get pictureUnit(): number

Returns number

set pictureUnit(a: number): void

Parameters

  • a: number

Returns void

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.

get plotOrder(): number

Returns number

set plotOrder(a: number): void

Parameters

  • a: number

Returns void

Inherited from: ChartObject

The owning sheet (read-only)

get sheet(): Sheet

Returns Sheet

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

get showDataLabels(): boolean

Returns boolean

set showDataLabels(a: boolean): void

Parameters

  • a: boolean

Returns void

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

get showWaterfallConnectorLines(): boolean

Returns boolean

set showWaterfallConnectorLines(a: boolean): void

Parameters

  • a: boolean

Returns void

Determines whether a smoothing effect should be applied.

get smooth(): boolean

Returns boolean

set smooth(a: boolean): void

Parameters

  • a: boolean

Returns void

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

get type(): SeriesType

Returns SeriesType

set type(a: SeriesType): void

Parameters

Returns void

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.

get values(): SeriesValues

Returns SeriesValues

set values(a: SeriesValues): void

Parameters

Returns void

Inherited from: ChartObject

The owning workbook (read-only)

get workbook(): Workbook

Returns Workbook

Inherited from: ChartObject

The owning worksheet (read-only)

get worksheet(): Worksheet

Returns Worksheet

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.

get xValues(): XValues

Returns XValues

set xValues(a: XValues): void

Parameters

Returns void

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

dataPointCollection(index: number): DataPoint

Parameters

  • index: number

    A zero based index

Returns DataPoint

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

trendlineCollection(index: number): Trendline

Parameters

  • index: number

    A zero based index

Returns Trendline