ExcelScript.ChartPoint interface
Represents a point of a series in a chart.
Methods
| get |
Returns the data label of a chart point. |
| get |
Encapsulates the format properties chart point. |
| get |
Represents whether a data point has a data label. Not applicable for surface charts. |
| get |
HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). |
| get |
HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). |
| get |
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. |
| get |
Represents marker style of a chart data point. See |
| get |
Returns the value of a chart point. |
| set |
Represents whether a data point has a data label. Not applicable for surface charts. |
| set |
HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). |
| set |
HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). |
| set |
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. |
| set |
Represents marker style of a chart data point. See |
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
- markerStyle
- ExcelScript.ChartMarkerStyle
Returns
void
Office Scripts