Edit

Share via

Excel.Interfaces.ChartDataLabelsData interface

  • Reference
Package:
excel

An interface describing the data returned by calling chartDataLabels.toJSON().

Properties

autoText

Specifies if data labels automatically generate appropriate text based on context.
format

Specifies the format of chart data labels, which includes fill and font formatting.
horizontalAlignment

Specifies the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when the TextOrientation of data label is 0.
linkNumberFormat

Specifies if the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.
numberFormat

Specifies the format code for data labels.
position

Value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.
separator

String representing the separator used for the data labels on a chart.
showBubbleSize

Specifies if the data label bubble size is visible.
showCategoryName

Specifies if the data label category name is visible.
showLegendKey

Specifies if the data label legend key is visible.
showPercentage

Specifies if the data label percentage is visible.
showSeriesName

Specifies if the data label series name is visible.
showValue

Specifies if the data label value is visible.
textOrientation

Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
verticalAlignment

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

Property Details

autoText

Specifies if data labels automatically generate appropriate text based on context.

autoText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

format

Specifies the format of chart data labels, which includes fill and font formatting.

format?: Excel.Interfaces.ChartDataLabelFormatData;

Property Value

Excel.Interfaces.ChartDataLabelFormatData

Remarks

[ API set: ExcelApi 1.1 ]

horizontalAlignment

Specifies the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when the TextOrientation of data label is 0.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]

linkNumberFormat

Specifies if the number format is linked to the cells. If true, the number format will change in the labels when it changes in the cells.

linkNumberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

numberFormat

Specifies the format code for data labels.

numberFormat?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

position

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

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"

Remarks

[ API set: ExcelApi 1.1 ]

separator

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

separator?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

showBubbleSize

Specifies if the data label bubble size is visible.

showBubbleSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showCategoryName

Specifies if the data label category name is visible.

showCategoryName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showLegendKey

Specifies if the data label legend key is visible.

showLegendKey?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showPercentage

Specifies if the data label percentage is visible.

showPercentage?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showSeriesName

Specifies if the data label series name is visible.

showSeriesName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showValue

Specifies if the data label value is visible.

showValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

textOrientation

Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.

textOrientation?: number;

Property Value

number

Remarks

[ 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 the data label is -90, 90, or 180.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]