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).
axisGroup

Specifies the group for the specified series.
binOptions

Encapsulates the bin options for histogram charts and pareto charts.
boxwhiskerOptions

Encapsulates the options for the box and whisker charts.
bubbleScale

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

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

Represents a collection of all data labels in the series.
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.
explosion

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

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

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

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.
gradientMaximumColor

Specifies the color for maximum value of a region map chart series.
gradientMaximumType

Specifies the type for maximum value of a region map chart series.
gradientMaximumValue

Specifies the maximum value of a region map chart series.
gradientMidpointColor

Specifies the color for the midpoint value of a region map chart series.
gradientMidpointType

Specifies the type for the midpoint value of a region map chart series.
gradientMidpointValue

Specifies the midpoint value of a region map chart series.
gradientMinimumColor

Specifies the color for the minimum value of a region map chart series.
gradientMinimumType

Specifies the type for the minimum value of a region map chart series.
gradientMinimumValue

Specifies the minimum value of a region map chart series.
gradientStyle

Specifies the series gradient style of a region map chart.
hasDataLabels

Specifies if the series has data labels.
invertColor

Specifies the fill color for negative data points in a series.
invertIfNegative

True if Excel inverts the pattern in the item when it corresponds to a negative number.
mapOptions

Encapsulates the options for a region map chart.
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.
overlap

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

Specifies the series parent label strategy area for a treemap chart.
plotOrder

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

Returns a collection of all points in the series.
secondPlotSize

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

Specifies whether connector lines are shown in waterfall charts.
showLeaderLines

Specifies whether leader lines are displayed for each data label 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.
splitType

Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
splitValue

Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
varyByCategories

True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
xErrorBars

Represents the error bar object of a chart series.
yErrorBars

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

Specifies the group for the specified series.

axisGroup?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

binOptions

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

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

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

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

chartType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

dataLabels

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

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

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

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

filtered?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

firstSliceAngle

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

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 ]

gradientMaximumColor

Specifies the color for maximum value of a region map chart series.

gradientMaximumColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMaximumType

Specifies the type for maximum value of a region map chart series.

gradientMaximumType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMaximumValue

Specifies the maximum value of a region map chart series.

gradientMaximumValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMidpointColor

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

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

Specifies the midpoint value of a region map chart series.

gradientMidpointValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientMinimumColor

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

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

Specifies the minimum value of a region map chart series.

gradientMinimumValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

gradientStyle

Specifies the series gradient style of a region map chart.

gradientStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

hasDataLabels

Specifies if the series has data labels.

hasDataLabels?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

invertColor

Specifies the fill color for negative data points in a series.

invertColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

invertIfNegative

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

Encapsulates the options for a region map chart.

mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions;

Property Value

Excel.Interfaces.ChartMapOptionsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

overlap

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

Specifies the series parent label strategy area for a treemap chart.

parentLabelStrategy?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

secondPlotSize

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

Specifies whether connector lines are shown in waterfall charts.

showConnectorLines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

showLeaderLines

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

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 ]

splitType

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

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

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

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

Represents the error bar object of a chart series.

yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;

Property Value

Excel.Interfaces.ChartErrorBarsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]