An object that represents a specific series in a chart
Constructors
Section titled "Constructors"Series
new Series(a: IChartObject): Series Returns Series
Properties
Section titled "Properties"$t: Type Accessors
Section titled "Accessors"applyPicToEnd
Section titled "applyPicToEnd"Apply the picture to the end of the series.
get applyPicToEnd(): boolean
Returns boolean
set applyPicToEnd(a: boolean): void Parameters
- a:
boolean
Returns void
applyPicToFront
Section titled "applyPicToFront"Apply the picture to the front of the series.
get applyPicToFront(): boolean
Returns boolean
set applyPicToFront(a: boolean): void Parameters
- a:
boolean
Returns void
applyPicToSides
Section titled "applyPicToSides"Apply the picture to the sides.
get applyPicToSides(): boolean
Returns boolean
set applyPicToSides(a: boolean): void Parameters
- a:
boolean
Returns void
axisBinning
Section titled "axisBinning"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
axisGroup
Section titled "axisGroup"barShape
Section titled "barShape"Determines the shape of the bar for this series. Applicable only for 3D bar charts.
get barShape(): BarShape | null
Returns BarShape | null
barShapeResolved
Section titled "barShapeResolved"Returns the resolved value of the [[barShape]] property.
get barShapeResolved(): BarShape
Returns BarShape
border
Section titled "border"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
boxAndWhiskerSettings
Section titled "boxAndWhiskerSettings"Returns or sets a [[boxAndWhiskerSettings]] instance which determines the properties for a box and whisker chart.
get boxAndWhiskerSettings(): BoxAndWhiskerSettings
Returns BoxAndWhiskerSettings
bubbleSizes
Section titled "bubbleSizes"Returns or sets a [[values]] instance that determines the bubble sizes in a bubble chart.
get bubbleSizes(): SeriesValues
Returns SeriesValues
chart
Section titled "chart"Inherited from: ChartObject
chartType
Section titled "chartType"Specifies the type of chart for this series. Applicable only for combo charts.
get chartType(): ChartType
Returns ChartType
dataLabels
Section titled "dataLabels"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
errorBars
Section titled "errorBars"explosion
Section titled "explosion"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
geographicMapSettings
Section titled "geographicMapSettings"Returns or sets a [[geographicMapSettings]] instance which defines the appearance and behavior for a geographic map chart.
get geographicMapSettings(): GeographicMapSettings
Returns GeographicMapSettings
invertIfNegative
Section titled "invertIfNegative"Determines if negative values will be inverted.
get invertIfNegative(): boolean
Returns boolean
set invertIfNegative(a: boolean): void Parameters
- a:
boolean
Returns void
leaderLines
Section titled "leaderLines"markerBorder
Section titled "markerBorder"Determines the appearance of the border (a.k.a. outline) for the marker.
get markerBorder(): ChartBorder
Returns ChartBorder
markerFill
Section titled "markerFill"markerSize
Section titled "markerSize"Determines the size of the markers.
get markerSize(): number
Returns number
set markerSize(a: number): void Parameters
- a:
number
Returns void
markerStyle
Section titled "markerStyle"owner
Section titled "owner"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
owningSeries
Section titled "owningSeries"Returns or sets a reference to the owning [[Series]]. Applicable only for a line series in a Pareto chart.
get owningSeries(): Series
Returns Series
pictureType
Section titled "pictureType"Determines whether pictures are scaled, stacked, or stretched.
get pictureType(): PictureType
Returns PictureType
pictureUnit
Section titled "pictureUnit"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
plotOrder
Section titled "plotOrder"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
sheet
Section titled "sheet"Inherited from: ChartObject
showDataLabels
Section titled "showDataLabels"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
showWaterfallConnectorLines
Section titled "showWaterfallConnectorLines"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
smooth
Section titled "smooth"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
values
Section titled "values"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
workbook
Section titled "workbook"Inherited from: ChartObject
worksheet
Section titled "worksheet"Inherited from: ChartObject
xValues
Section titled "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.
get xValues(): XValues
Returns XValues
Methods
Section titled "Methods"dataPointCollection
Section titled "dataPointCollection"Returns the [[DataPoint]] instance at the specified ordinal position within this collection.
dataPointCollection(index: number): DataPoint Parameters
- index:
numberA zero based index
Returns DataPoint
trendlineCollection
Section titled "trendlineCollection"Returns the [[Trendline]] instance at the specified ordinal position within the collection.
trendlineCollection(index: number): Trendline Parameters
- index:
numberA zero based index