Edit

Share via

Excel.Interfaces.ChartPointsCollectionLoadOptions interface

Package:
excel

A collection of all the chart points within a series inside 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).
dataLabel

For EACH ITEM in the collection: Returns the data label of a chart point.
format

For EACH ITEM in the collection: Encapsulates the format properties chart point.
hasDataLabel

For EACH ITEM in the collection: Represents whether a data point has a data label. Not applicable for surface charts.
markerBackgroundColor

For EACH ITEM in the collection: HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).
markerForegroundColor

For EACH ITEM in the collection: HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).
markerSize

For EACH ITEM in the collection: Represents marker size of a data point. 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: Represents marker style of a chart data point. See Excel.ChartMarkerStyle for details.
value

For EACH ITEM in the collection: Returns the value of a chart point.

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

dataLabel

For EACH ITEM in the collection: Returns the data label of a chart point.

dataLabel?: Excel.Interfaces.ChartDataLabelLoadOptions;

Property Value

Excel.Interfaces.ChartDataLabelLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

format

For EACH ITEM in the collection: Encapsulates the format properties chart point.

format?: Excel.Interfaces.ChartPointFormatLoadOptions;

Property Value

Excel.Interfaces.ChartPointFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

hasDataLabel

For EACH ITEM in the collection: Represents whether a data point has a data label. Not applicable for surface charts.

hasDataLabel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerBackgroundColor

For EACH ITEM in the collection: HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).

markerBackgroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerForegroundColor

For EACH ITEM in the collection: HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).

markerForegroundColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

markerSize

For EACH ITEM in the collection: Represents marker size of a data point. 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: Represents marker style of a chart data point. See Excel.ChartMarkerStyle for details.

markerStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

value

For EACH ITEM in the collection: Returns the value of a chart point.

value?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]