Excel.ChartPoint class

Represents a point of a series in a chart.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

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(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartPoint object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartPointData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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(options)

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

load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint;

Parameters

options
Excel.Interfaces.ChartPointLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

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

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

Parameters

propertyNames
string | string[]

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

Returns

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartPoint;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ChartPointUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.ChartPointUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.ChartPoint): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartPoint): void;

Parameters

properties
Excel.ChartPoint

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartPoint object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartPointData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartPointData;

Returns