Excel.Interfaces.ChartSeriesLoadOptions interface
Represents a series in a chart.
Remarks
Properties
$all | Specifying |
chart |
Represents the chart type of a series. See |
doughnut |
Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an |
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. |
gap |
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. |
has |
Specifies if the series has data labels. |
marker |
Specifies the marker background color of a chart series. |
marker |
Specifies the marker foreground color of a chart series. |
marker |
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. |
marker |
Specifies the marker style of a chart series. See |
name | Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. |
plot |
Specifies the plot order of a chart series within the chart group. |
points | Returns a collection of all points in the series. |
show |
Specifies if the series has a shadow. |
smooth | Specifies if the series is smooth. Only applicable to line and scatter charts. |
Property Details
$all
Warning
This API is now deprecated.
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
Warning
This API is now deprecated.
Represents the chart type of a series. See Excel.ChartType
for details.
chartType?: boolean;
Property Value
boolean
Remarks
doughnutHoleSize
Warning
This API is now deprecated.
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
filtered
Warning
This API is now deprecated.
Specifies if the series is filtered. Not applicable for surface charts.
filtered?: boolean;
Property Value
boolean
Remarks
format
Warning
This API is now deprecated.
Represents the formatting of a chart series, which includes fill and line formatting.
format?: Excel.Interfaces.ChartSeriesFormatLoadOptions;
Property Value
Remarks
gapWidth
Warning
This API is now deprecated.
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
hasDataLabels
Warning
This API is now deprecated.
Specifies if the series has data labels.
hasDataLabels?: boolean;
Property Value
boolean
Remarks
markerBackgroundColor
Warning
This API is now deprecated.
Specifies the marker background color of a chart series.
markerBackgroundColor?: boolean;
Property Value
boolean
Remarks
markerForegroundColor
Warning
This API is now deprecated.
Specifies the marker foreground color of a chart series.
markerForegroundColor?: boolean;
Property Value
boolean
Remarks
markerSize
Warning
This API is now deprecated.
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
markerStyle
Warning
This API is now deprecated.
Specifies the marker style of a chart series. See Excel.ChartMarkerStyle
for details.
markerStyle?: boolean;
Property Value
boolean
Remarks
name
Warning
This API is now deprecated.
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
plotOrder
Warning
This API is now deprecated.
Specifies the plot order of a chart series within the chart group.
plotOrder?: boolean;
Property Value
boolean
Remarks
points
Warning
This API is now deprecated.
Returns a collection of all points in the series.
points?: Excel.Interfaces.ChartPointsCollectionLoadOptions;
Property Value
Remarks
showShadow
Warning
This API is now deprecated.
Specifies if the series has a shadow.
showShadow?: boolean;
Property Value
boolean
Remarks
smooth
Warning
This API is now deprecated.
Specifies if the series is smooth. Only applicable to line and scatter charts.
smooth?: boolean;
Property Value
boolean
Remarks
Office Add-ins