Excel.ChartPoint class

Represents a point of a series in a chart.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

dataLabel

Returns the data label of a chart point. Read-only.

[ API set: ExcelApi 1.7 ]

format

Encapsulates the format properties chart point. Read-only.

[ API set: ExcelApi 1.1 ]

hasDataLabel

Represents whether a data point has a data label. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

markerBackgroundColor

HTML color code representation of the marker background color of data point. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.7 ]

markerForegroundColor

HTML color code representation of the marker foreground color of data point. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.7 ]

markerSize

Represents marker size of data point.

[ API set: ExcelApi 1.7 ]

markerStyle

Represents marker style of a chart data point. See Excel.ChartMarkerStyle for details.

[ API set: ExcelApi 1.7 ]

value

Returns the value of a chart point. Read-only.

[ API set: ExcelApi 1.1 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

dataLabel

Returns the data label of a chart point. Read-only.

[ API set: ExcelApi 1.7 ]

readonly dataLabel: Excel.ChartDataLabel;
Property Value

format

Encapsulates the format properties chart point. Read-only.

[ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartPointFormat;
Property Value

hasDataLabel

Represents whether a data point has a data label. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

hasDataLabel: boolean;
Property Value
boolean

markerBackgroundColor

HTML color code representation of the marker background color of data point. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.7 ]

markerBackgroundColor: string;
Property Value
string

markerForegroundColor

HTML color code representation of the marker foreground color of data point. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.7 ]

markerForegroundColor: string;
Property Value
string

markerSize

Represents marker size of data point.

[ API set: ExcelApi 1.7 ]

markerSize: number;
Property Value
number

markerStyle

Represents marker style of a chart data point. See Excel.ChartMarkerStyle for details.

[ API set: ExcelApi 1.7 ]

markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";
Property Value
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"

value

Returns the value of a chart point. Read-only.

[ API set: ExcelApi 1.1 ]

readonly value: any;
Property Value
any

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.ChartPoint;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ChartPoint - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartPoint - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Excel.Interfaces.ChartPointData;
Returns