Edit

Share via

Excel.Interfaces.ChartSeriesCollectionLoadOptions interface

Package:
excel

Represents a collection of chart series.

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

For EACH ITEM in the collection: Represents the chart type of a series. See Excel.ChartType for details.
doughnutHoleSize

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the series is filtered. Not applicable for surface charts.
format

For EACH ITEM in the collection: Represents the formatting of a chart series, which includes fill and line formatting.
gapWidth

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the series has data labels.
markerBackgroundColor

For EACH ITEM in the collection: Specifies the marker background color of a chart series.
markerForegroundColor

For EACH ITEM in the collection: Specifies the marker foreground color of a chart series.
markerSize

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the marker style of a chart series. See Excel.ChartMarkerStyle for details.
name

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

For EACH ITEM in the collection: Specifies the plot order of a chart series within the chart group.
points

For EACH ITEM in the collection: Returns a collection of all points in the series.
showShadow

For EACH ITEM in the collection: Specifies if the series has a shadow.
smooth

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents the chart type of a series. See Excel.ChartType for details.

chartType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

doughnutHoleSize

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the series is filtered. Not applicable for surface charts.

filtered?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

format

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the series has data labels.

hasDataLabels?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerBackgroundColor

For EACH ITEM in the collection: Specifies the marker background color of a chart series.

markerBackgroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerForegroundColor

For EACH ITEM in the collection: Specifies the marker foreground color of a chart series.

markerForegroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerSize

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the plot order of a chart series within the chart group.

plotOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

points

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the series has a shadow.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

smooth

For EACH ITEM in the collection: Specifies if the series is smooth. Only applicable to line and scatter charts.

smooth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]