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).
axisGroup	For EACH ITEM in the collection: Specifies the group for the specified series.
binOptions	For EACH ITEM in the collection: Encapsulates the bin options for histogram charts and pareto charts.
boxwhiskerOptions	For EACH ITEM in the collection: Encapsulates the options for the box and whisker charts.
bubbleScale	For EACH ITEM in the collection: This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts.
chartType	For EACH ITEM in the collection: Represents the chart type of a series. See Excel.ChartType for details.
dataLabels	For EACH ITEM in the collection: Represents a collection of all data labels in the series.
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.
explosion	For EACH ITEM in the collection: Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie).
filtered	For EACH ITEM in the collection: Specifies if the series is filtered. Not applicable for surface charts.
firstSliceAngle	For EACH ITEM in the collection: Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
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.
gradientMaximumColor	For EACH ITEM in the collection: Specifies the color for maximum value of a region map chart series.
gradientMaximumType	For EACH ITEM in the collection: Specifies the type for maximum value of a region map chart series.
gradientMaximumValue	For EACH ITEM in the collection: Specifies the maximum value of a region map chart series.
gradientMidpointColor	For EACH ITEM in the collection: Specifies the color for the midpoint value of a region map chart series.
gradientMidpointType	For EACH ITEM in the collection: Specifies the type for the midpoint value of a region map chart series.
gradientMidpointValue	For EACH ITEM in the collection: Specifies the midpoint value of a region map chart series.
gradientMinimumColor	For EACH ITEM in the collection: Specifies the color for the minimum value of a region map chart series.
gradientMinimumType	For EACH ITEM in the collection: Specifies the type for the minimum value of a region map chart series.
gradientMinimumValue	For EACH ITEM in the collection: Specifies the minimum value of a region map chart series.
gradientStyle	For EACH ITEM in the collection: Specifies the series gradient style of a region map chart.
hasDataLabels	For EACH ITEM in the collection: Specifies if the series has data labels.
invertColor	For EACH ITEM in the collection: Specifies the fill color for negative data points in a series.
invertIfNegative	For EACH ITEM in the collection: True if Excel inverts the pattern in the item when it corresponds to a negative number.
mapOptions	For EACH ITEM in the collection: Encapsulates the options for a region map chart.
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.
overlap	For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
parentLabelStrategy	For EACH ITEM in the collection: Specifies the series parent label strategy area for a treemap chart.
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.
secondPlotSize	For EACH ITEM in the collection: Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.
showConnectorLines	For EACH ITEM in the collection: Specifies whether connector lines are shown in waterfall charts.
showLeaderLines	For EACH ITEM in the collection: Specifies whether leader lines are displayed for each data label 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.
splitType	For EACH ITEM in the collection: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
splitValue	For EACH ITEM in the collection: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
varyByCategories	For EACH ITEM in the collection: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
xErrorBars	For EACH ITEM in the collection: Represents the error bar object of a chart series.
yErrorBars	For EACH ITEM in the collection: Represents the error bar object of a chart series.

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

axisGroup

For EACH ITEM in the collection: Specifies the group for the specified series.

axisGroup?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

binOptions

For EACH ITEM in the collection: Encapsulates the bin options for histogram charts and pareto charts.

binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions;

Property Value

Excel.Interfaces.ChartBinOptionsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

boxwhiskerOptions

For EACH ITEM in the collection: Encapsulates the options for the box and whisker charts.

boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions;

Property Value

Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

bubbleScale

For EACH ITEM in the collection: This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts.

bubbleScale?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

dataLabels

For EACH ITEM in the collection: Represents a collection of all data labels in the series.

dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;

Property Value

Excel.Interfaces.ChartDataLabelsLoadOptions

Remarks

[ API set: ExcelApi 1.8 ]

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 ]

explosion

For EACH ITEM in the collection: Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie).

explosion?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

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 ]

firstSliceAngle

For EACH ITEM in the collection: Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.

firstSliceAngle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

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 ]

gradientMaximumColor

For EACH ITEM in the collection: Specifies the color for maximum value of a region map chart series.

gradientMaximumColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMaximumType

For EACH ITEM in the collection: Specifies the type for maximum value of a region map chart series.

gradientMaximumType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMaximumValue

For EACH ITEM in the collection: Specifies the maximum value of a region map chart series.

gradientMaximumValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMidpointColor

For EACH ITEM in the collection: Specifies the color for the midpoint value of a region map chart series.

gradientMidpointColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMidpointType

For EACH ITEM in the collection: Specifies the type for the midpoint value of a region map chart series.

gradientMidpointType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMidpointValue

For EACH ITEM in the collection: Specifies the midpoint value of a region map chart series.

gradientMidpointValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMinimumColor

For EACH ITEM in the collection: Specifies the color for the minimum value of a region map chart series.

gradientMinimumColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMinimumType

For EACH ITEM in the collection: Specifies the type for the minimum value of a region map chart series.

gradientMinimumType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMinimumValue

For EACH ITEM in the collection: Specifies the minimum value of a region map chart series.

gradientMinimumValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientStyle

For EACH ITEM in the collection: Specifies the series gradient style of a region map chart.

gradientStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

invertColor

For EACH ITEM in the collection: Specifies the fill color for negative data points in a series.

invertColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

invertIfNegative

For EACH ITEM in the collection: True if Excel inverts the pattern in the item when it corresponds to a negative number.

invertIfNegative?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

mapOptions

For EACH ITEM in the collection: Encapsulates the options for a region map chart.

mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions;

Property Value

Excel.Interfaces.ChartMapOptionsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

overlap

For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.

overlap?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

parentLabelStrategy

For EACH ITEM in the collection: Specifies the series parent label strategy area for a treemap chart.

parentLabelStrategy?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

secondPlotSize

For EACH ITEM in the collection: Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.

secondPlotSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showConnectorLines

For EACH ITEM in the collection: Specifies whether connector lines are shown in waterfall charts.

showConnectorLines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

showLeaderLines

For EACH ITEM in the collection: Specifies whether leader lines are displayed for each data label in the series.

showLeaderLines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

splitType

For EACH ITEM in the collection: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.

splitType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

splitValue

For EACH ITEM in the collection: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.

splitValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

varyByCategories

For EACH ITEM in the collection: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.

varyByCategories?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

xErrorBars

For EACH ITEM in the collection: Represents the error bar object of a chart series.

xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;

Property Value

Excel.Interfaces.ChartErrorBarsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

yErrorBars

For EACH ITEM in the collection: Represents the error bar object of a chart series.

yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;

Property Value

Excel.Interfaces.ChartErrorBarsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]