ExcelScript.ChartPoint interface

Represents a point of a series in a chart.

Methods

getDataLabel()

Returns the data label of a chart point.

getFormat()

Encapsulates the format properties chart point.

getHasDataLabel()

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

getMarkerBackgroundColor()

HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).

getMarkerForegroundColor()

HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).

getMarkerSize()

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.

getMarkerStyle()

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

getValue()

Returns the value of a chart point.

setHasDataLabel(hasDataLabel)

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

setMarkerBackgroundColor(markerBackgroundColor)

HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).

setMarkerForegroundColor(markerForegroundColor)

HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).

setMarkerSize(markerSize)

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.

setMarkerStyle(markerStyle)

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

Method Details

getDataLabel()

Returns the data label of a chart point.

getDataLabel(): ChartDataLabel;

Returns

getFormat()

Encapsulates the format properties chart point.

getFormat(): ChartPointFormat;

Returns

getHasDataLabel()

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

getHasDataLabel(): boolean;

Returns

boolean

getMarkerBackgroundColor()

HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).

getMarkerBackgroundColor(): string;

Returns

string

getMarkerForegroundColor()

HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).

getMarkerForegroundColor(): string;

Returns

string

getMarkerSize()

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.

getMarkerSize(): number;

Returns

number

getMarkerStyle()

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

getMarkerStyle(): ChartMarkerStyle;

Returns

getValue()

Returns the value of a chart point.

getValue(): number;

Returns

number

setHasDataLabel(hasDataLabel)

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

setHasDataLabel(hasDataLabel: boolean): void;

Parameters

hasDataLabel

boolean

Returns

void

setMarkerBackgroundColor(markerBackgroundColor)

HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Parameters

markerBackgroundColor

string

Returns

void

setMarkerForegroundColor(markerForegroundColor)

HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).

setMarkerForegroundColor(markerForegroundColor: string): void;

Parameters

markerForegroundColor

string

Returns

void

setMarkerSize(markerSize)

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.

setMarkerSize(markerSize: number): void;

Parameters

markerSize

number

Returns

void

setMarkerStyle(markerStyle)

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

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Parameters

Returns

void