Edit

Share via

Excel.Interfaces.ChartSeriesLoadOptions interface

  • Reference
Package:
excel

Represents a series in a chart.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
chartType

Represents the chart type of a series. See Excel.ChartType for details.
doughnutHoleSize

Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an InvalidArgument error on invalid charts.
filtered

Specifies if the series is filtered. Not applicable for surface charts.
format

Represents the formatting of a chart series, which includes fill and line formatting.
gapWidth

Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts.
hasDataLabels

Specifies if the series has data labels.
markerBackgroundColor

Specifies the marker background color of a chart series.
markerForegroundColor

Specifies the marker foreground color of a chart series.
markerSize

Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
markerStyle

Specifies the marker style of a chart series. See Excel.ChartMarkerStyle for details.
name

Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
plotOrder

Specifies the plot order of a chart series within the chart group.
points

Returns a collection of all points in the series.
showShadow

Specifies if the series has a shadow.
smooth

Specifies if the series is smooth. Only applicable to line and scatter charts.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

chartType

Represents the chart type of a series. See Excel.ChartType for details.

chartType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

doughnutHoleSize

Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an InvalidArgument error on invalid charts.

doughnutHoleSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

filtered

Specifies if the series is filtered. Not applicable for surface charts.

filtered?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

format

Represents the formatting of a chart series, which includes fill and line formatting.

format?: Excel.Interfaces.ChartSeriesFormatLoadOptions;

Property Value

Excel.Interfaces.ChartSeriesFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

gapWidth

Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts.

gapWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

hasDataLabels

Specifies if the series has data labels.

hasDataLabels?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerBackgroundColor

Specifies the marker background color of a chart series.

markerBackgroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerForegroundColor

Specifies the marker foreground color of a chart series.

markerForegroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerSize

Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.

markerSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerStyle

Specifies the marker style of a chart series. See Excel.ChartMarkerStyle for details.

markerStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

name

Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

plotOrder

Specifies the plot order of a chart series within the chart group.

plotOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

points

Returns a collection of all points in the series.

points?: Excel.Interfaces.ChartPointsCollectionLoadOptions;

Property Value

Excel.Interfaces.ChartPointsCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

showShadow

Specifies if the series has a shadow.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

smooth

Specifies if the series is smooth. Only applicable to line and scatter charts.

smooth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]