Excel.ChartDataLabel class

Represents the data label of a chart point.

[ API set: ExcelApi 1.7 ]

Extends
OfficeExtension.ClientObject

Properties

autoText

Boolean value representing if data label automatically generates appropriate text based on context.

[ API set: ExcelApi 1.8 ]

context

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

format

Represents the format of chart data label.

[ API set: ExcelApi 1.8 ]

formula

String value that represents the formula of chart data label using A1-style notation.

[ API set: ExcelApi 1.8 ]

height

Returns the height, in points, of the chart data label. Read-only. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

horizontalAlignment

Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of data label is -90, 90, or 180.

[ API set: ExcelApi 1.8 ]

left

Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

linkNumberFormat

Boolean value representing if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

[ API set: ExcelApi 1.9 ]

numberFormat

String value that represents the format code for data label.

[ API set: ExcelApi 1.8 ]

position

DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.

[ API set: ExcelApi 1.7 ]

separator

String representing the separator used for the data label on a chart.

[ API set: ExcelApi 1.7 ]

showBubbleSize

Boolean value representing if the data label bubble size is visible or not.

[ API set: ExcelApi 1.7 ]

showCategoryName

Boolean value representing if the data label category name is visible or not.

[ API set: ExcelApi 1.7 ]

showLegendKey

Boolean value representing if the data label legend key is visible or not.

[ API set: ExcelApi 1.7 ]

showPercentage

Boolean value representing if the data label percentage is visible or not.

[ API set: ExcelApi 1.7 ]

showSeriesName

Boolean value representing if the data label series name is visible or not.

[ API set: ExcelApi 1.7 ]

showValue

Boolean value representing if the data label value is visible or not.

[ API set: ExcelApi 1.7 ]

text

String representing the text of the data label on a chart.

[ API set: ExcelApi 1.8 ]

textOrientation

Represents the text orientation of chart data label. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.8 ]

top

Represents the distance, in points, from the top edge of chart data label to the top of chart area. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

verticalAlignment

Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of data label is 0.

[ API set: ExcelApi 1.8 ]

width

Returns the width, in points, of the chart data label. Read-only. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

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.ChartDataLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelData) that contains shallow copies of any loaded child properties from the original object.

Property Details

autoText

Boolean value representing if data label automatically generates appropriate text based on context.

[ API set: ExcelApi 1.8 ]

autoText: boolean;

Property Value

boolean

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

format

Represents the format of chart data label.

[ API set: ExcelApi 1.8 ]

readonly format: Excel.ChartDataLabelFormat;

Property Value

formula

String value that represents the formula of chart data label using A1-style notation.

[ API set: ExcelApi 1.8 ]

formula: string;

Property Value

string

height

Returns the height, in points, of the chart data label. Read-only. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

readonly height: number;

Property Value

number

horizontalAlignment

Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of data label is -90, 90, or 180.

[ API set: ExcelApi 1.8 ]

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Property Value

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

left

Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

left: number;

Property Value

number

linkNumberFormat

Boolean value representing if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

[ API set: ExcelApi 1.9 ]

linkNumberFormat: boolean;

Property Value

boolean

numberFormat

String value that represents the format code for data label.

[ API set: ExcelApi 1.8 ]

numberFormat: string;

Property Value

string

position

DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.

[ API set: ExcelApi 1.7 ]

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

Property Value

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

separator

String representing the separator used for the data label on a chart.

[ API set: ExcelApi 1.7 ]

separator: string;

Property Value

string

showBubbleSize

Boolean value representing if the data label bubble size is visible or not.

[ API set: ExcelApi 1.7 ]

showBubbleSize: boolean;

Property Value

boolean

showCategoryName

Boolean value representing if the data label category name is visible or not.

[ API set: ExcelApi 1.7 ]

showCategoryName: boolean;

Property Value

boolean

showLegendKey

Boolean value representing if the data label legend key is visible or not.

[ API set: ExcelApi 1.7 ]

showLegendKey: boolean;

Property Value

boolean

showPercentage

Boolean value representing if the data label percentage is visible or not.

[ API set: ExcelApi 1.7 ]

showPercentage: boolean;

Property Value

boolean

showSeriesName

Boolean value representing if the data label series name is visible or not.

[ API set: ExcelApi 1.7 ]

showSeriesName: boolean;

Property Value

boolean

showValue

Boolean value representing if the data label value is visible or not.

[ API set: ExcelApi 1.7 ]

showValue: boolean;

Property Value

boolean

text

String representing the text of the data label on a chart.

[ API set: ExcelApi 1.8 ]

text: string;

Property Value

string

textOrientation

Represents the text orientation of chart data label. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.8 ]

textOrientation: number;

Property Value

number

top

Represents the distance, in points, from the top edge of chart data label to the top of chart area. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

top: number;

Property Value

number

verticalAlignment

Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of data label is 0.

[ API set: ExcelApi 1.8 ]

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Property Value

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

width

Returns the width, in points, of the chart data label. Read-only. Null if chart data label is not visible.

[ API set: ExcelApi 1.8 ]

readonly width: number;

Property Value

number

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.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

Parameters

options
Excel.Interfaces.ChartDataLabelLoadOptions

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.ChartDataLabel;

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.ChartDataLabel;

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.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.ChartDataLabelUpdateData

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.ChartDataLabel): void

set(properties)

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

set(properties: Excel.ChartDataLabel): void;

Parameters

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.ChartDataLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartDataLabelData;

Returns