Excel.Interfaces.ChartSeriesCollectionLoadOptions interface

Represents a collection of chart series.

[ API set: ExcelApi 1.1 ]

Properties

$all
axisGroup

For EACH ITEM in the collection: Returns or sets the group for the specified series. Read/Write

[ API set: ExcelApi 1.8 ]

binOptions

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

[ API set: ExcelApi 1.9 ]

boxwhiskerOptions

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

[ 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. Read/Write.

[ API set: ExcelApi 1.9 ]

chartType

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

[ API set: ExcelApi 1.7 ]

dataLabels

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

[ 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 doughnutExploded charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

explosion

For EACH ITEM in the collection: Returns or sets 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). Read/Write.

[ API set: ExcelApi 1.8 ]

filtered

For EACH ITEM in the collection: Boolean value representing if the series is filtered or not. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

firstSliceAngle

For EACH ITEM in the collection: Returns or sets 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. Read/Write

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

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

[ API set: ExcelApi 1.7 ]

gradientMaximumColor

For EACH ITEM in the collection: Returns or sets the color for maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMaximumType

For EACH ITEM in the collection: Returns or sets the type for maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMaximumValue

For EACH ITEM in the collection: Returns or sets the maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointColor

For EACH ITEM in the collection: Returns or sets the color for midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointType

For EACH ITEM in the collection: Returns or sets the type for midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointValue

For EACH ITEM in the collection: Returns or sets the midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumColor

For EACH ITEM in the collection: Returns or sets the color for minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumType

For EACH ITEM in the collection: Returns or sets the type for minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumValue

For EACH ITEM in the collection: Returns or sets the minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientStyle

For EACH ITEM in the collection: Returns or sets series gradient style of a region map chart. Read/Write.

[ API set: ExcelApi 1.9 ]

hasDataLabels

For EACH ITEM in the collection: Boolean value representing if the series has data labels or not.

[ API set: ExcelApi 1.7 ]

invertColor

For EACH ITEM in the collection: Returns or sets the fill color for negative data points in a series. Read/Write.

[ API set: ExcelApi 1.9 ]

invertIfNegative

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

[ API set: ExcelApi 1.8 ]

mapOptions

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

[ API set: ExcelApi 1.9 ]

markerBackgroundColor

For EACH ITEM in the collection: Represents markers background color of a chart series.

[ API set: ExcelApi 1.7 ]

markerForegroundColor

For EACH ITEM in the collection: Represents markers foreground color of a chart series.

[ API set: ExcelApi 1.7 ]

markerSize

For EACH ITEM in the collection: Represents marker size of a chart series.

[ API set: ExcelApi 1.7 ]

markerStyle

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

[ API set: ExcelApi 1.7 ]

name

For EACH ITEM in the collection: Represents the name of a series in a chart.

[ 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. Read/Write.

[ API set: ExcelApi 1.8 ]

parentLabelStrategy

For EACH ITEM in the collection: Returns or sets the series parent label strategy area for a treemap chart. Read/Write.

[ API set: ExcelApi 1.9 ]

plotOrder

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

[ API set: ExcelApi 1.7 ]

points

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

[ API set: ExcelApi 1.1 ]

secondPlotSize

For EACH ITEM in the collection: Returns or sets 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. Read/Write.

[ API set: ExcelApi 1.8 ]

showConnectorLines

For EACH ITEM in the collection: Specifies whether or not connector lines are shown in waterfall charts. Read/Write.

[ API set: ExcelApi 1.9 ]

showLeaderLines

For EACH ITEM in the collection: Specifies whether or not leader lines are displayed for each data label in the series. Read/Write.

[ API set: ExcelApi 1.9 ]

showShadow

For EACH ITEM in the collection: Boolean value representing if the series has a shadow or not.

[ API set: ExcelApi 1.7 ]

smooth

For EACH ITEM in the collection: Boolean value representing if the series is smooth or not. Only applicable to line and scatter charts.

[ API set: ExcelApi 1.7 ]

splitType

For EACH ITEM in the collection: Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split. Read/Write.

[ API set: ExcelApi 1.8 ]

splitValue

For EACH ITEM in the collection: Returns or sets the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. Read/Write.

[ API set: ExcelApi 1.9 ]

varyByCategories

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

[ API set: ExcelApi 1.8 ]

xErrorBars

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

[ API set: ExcelApi 1.9 ]

yErrorBars

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

[ API set: ExcelApi 1.9 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

axisGroup

For EACH ITEM in the collection: Returns or sets the group for the specified series. Read/Write

[ API set: ExcelApi 1.8 ]

axisGroup?: boolean;

Property Value

boolean

binOptions

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

[ API set: ExcelApi 1.9 ]

binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions;

Property Value

boxwhiskerOptions

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

[ API set: ExcelApi 1.9 ]

boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions;

Property Value

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. Read/Write.

[ API set: ExcelApi 1.9 ]

bubbleScale?: boolean;

Property Value

boolean

chartType

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

[ API set: ExcelApi 1.7 ]

chartType?: boolean;

Property Value

boolean

dataLabels

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

[ API set: ExcelApi 1.8 ]

dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;

Property Value

doughnutHoleSize

For EACH ITEM in the collection: Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnutExploded charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

doughnutHoleSize?: boolean;

Property Value

boolean

explosion

For EACH ITEM in the collection: Returns or sets 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). Read/Write.

[ API set: ExcelApi 1.8 ]

explosion?: boolean;

Property Value

boolean

filtered

For EACH ITEM in the collection: Boolean value representing if the series is filtered or not. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

filtered?: boolean;

Property Value

boolean

firstSliceAngle

For EACH ITEM in the collection: Returns or sets 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. Read/Write

[ API set: ExcelApi 1.8 ]

firstSliceAngle?: boolean;

Property Value

boolean

format

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

[ API set: ExcelApi 1.1 ]

format?: Excel.Interfaces.ChartSeriesFormatLoadOptions;

Property Value

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.

[ API set: ExcelApi 1.7 ]

gapWidth?: boolean;

Property Value

boolean

gradientMaximumColor

For EACH ITEM in the collection: Returns or sets the color for maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMaximumColor?: boolean;

Property Value

boolean

gradientMaximumType

For EACH ITEM in the collection: Returns or sets the type for maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMaximumType?: boolean;

Property Value

boolean

gradientMaximumValue

For EACH ITEM in the collection: Returns or sets the maximum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMaximumValue?: boolean;

Property Value

boolean

gradientMidpointColor

For EACH ITEM in the collection: Returns or sets the color for midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointColor?: boolean;

Property Value

boolean

gradientMidpointType

For EACH ITEM in the collection: Returns or sets the type for midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointType?: boolean;

Property Value

boolean

gradientMidpointValue

For EACH ITEM in the collection: Returns or sets the midpoint value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMidpointValue?: boolean;

Property Value

boolean

gradientMinimumColor

For EACH ITEM in the collection: Returns or sets the color for minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumColor?: boolean;

Property Value

boolean

gradientMinimumType

For EACH ITEM in the collection: Returns or sets the type for minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumType?: boolean;

Property Value

boolean

gradientMinimumValue

For EACH ITEM in the collection: Returns or sets the minimum value of a region map chart series. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientMinimumValue?: boolean;

Property Value

boolean

gradientStyle

For EACH ITEM in the collection: Returns or sets series gradient style of a region map chart. Read/Write.

[ API set: ExcelApi 1.9 ]

gradientStyle?: boolean;

Property Value

boolean

hasDataLabels

For EACH ITEM in the collection: Boolean value representing if the series has data labels or not.

[ API set: ExcelApi 1.7 ]

hasDataLabels?: boolean;

Property Value

boolean

invertColor

For EACH ITEM in the collection: Returns or sets the fill color for negative data points in a series. Read/Write.

[ API set: ExcelApi 1.9 ]

invertColor?: boolean;

Property Value

boolean

invertIfNegative

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

[ API set: ExcelApi 1.8 ]

invertIfNegative?: boolean;

Property Value

boolean

mapOptions

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

[ API set: ExcelApi 1.9 ]

mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions;

Property Value

markerBackgroundColor

For EACH ITEM in the collection: Represents markers background color of a chart series.

[ API set: ExcelApi 1.7 ]

markerBackgroundColor?: boolean;

Property Value

boolean

markerForegroundColor

For EACH ITEM in the collection: Represents markers foreground color of a chart series.

[ API set: ExcelApi 1.7 ]

markerForegroundColor?: boolean;

Property Value

boolean

markerSize

For EACH ITEM in the collection: Represents marker size of a chart series.

[ API set: ExcelApi 1.7 ]

markerSize?: boolean;

Property Value

boolean

markerStyle

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

[ API set: ExcelApi 1.7 ]

markerStyle?: boolean;

Property Value

boolean

name

For EACH ITEM in the collection: Represents the name of a series in a chart.

[ API set: ExcelApi 1.1 ]

name?: boolean;

Property Value

boolean

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. Read/Write.

[ API set: ExcelApi 1.8 ]

overlap?: boolean;

Property Value

boolean

parentLabelStrategy

For EACH ITEM in the collection: Returns or sets the series parent label strategy area for a treemap chart. Read/Write.

[ API set: ExcelApi 1.9 ]

parentLabelStrategy?: boolean;

Property Value

boolean

plotOrder

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

[ API set: ExcelApi 1.7 ]

plotOrder?: boolean;

Property Value

boolean

points

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

[ API set: ExcelApi 1.1 ]

points?: Excel.Interfaces.ChartPointsCollectionLoadOptions;

Property Value

secondPlotSize

For EACH ITEM in the collection: Returns or sets 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. Read/Write.

[ API set: ExcelApi 1.8 ]

secondPlotSize?: boolean;

Property Value

boolean

showConnectorLines

For EACH ITEM in the collection: Specifies whether or not connector lines are shown in waterfall charts. Read/Write.

[ API set: ExcelApi 1.9 ]

showConnectorLines?: boolean;

Property Value

boolean

showLeaderLines

For EACH ITEM in the collection: Specifies whether or not leader lines are displayed for each data label in the series. Read/Write.

[ API set: ExcelApi 1.9 ]

showLeaderLines?: boolean;

Property Value

boolean

showShadow

For EACH ITEM in the collection: Boolean value representing if the series has a shadow or not.

[ API set: ExcelApi 1.7 ]

showShadow?: boolean;

Property Value

boolean

smooth

For EACH ITEM in the collection: Boolean value representing if the series is smooth or not. Only applicable to line and scatter charts.

[ API set: ExcelApi 1.7 ]

smooth?: boolean;

Property Value

boolean

splitType

For EACH ITEM in the collection: Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split. Read/Write.

[ API set: ExcelApi 1.8 ]

splitType?: boolean;

Property Value

boolean

splitValue

For EACH ITEM in the collection: Returns or sets the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. Read/Write.

[ API set: ExcelApi 1.9 ]

splitValue?: boolean;

Property Value

boolean

varyByCategories

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

[ API set: ExcelApi 1.8 ]

varyByCategories?: boolean;

Property Value

boolean

xErrorBars

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

[ API set: ExcelApi 1.9 ]

xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;

Property Value

yErrorBars

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

[ API set: ExcelApi 1.9 ]

yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;

Property Value