ExcelScript.ChartDataLabel interface

Specifies if the data label automatically generates appropriate text based on context.

getAutoText(): boolean;

Returns

Represents the format of chart data label.

getFormat(): ChartDataLabelFormat;

Returns

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

getFormula(): string;

Returns

Specifies the geometric shape type of the data label. See ExcelScript.GeometricShapeType for more details. Value is null if the data label is not a geometric shape.

getGeometricShapeType(): GeometricShapeType;

Returns

Returns the height, in points, of the chart data label. Value is null if the chart data label is not visible.

getHeight(): number;

Returns

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

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Returns

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

getLeft(): number;

Returns

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

getLinkNumberFormat(): boolean;

Returns

String value that represents the format code for data label.

getNumberFormat(): string;

Returns

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

getPosition(): ChartDataLabelPosition;

Returns

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

getSeparator(): string;

Returns

Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If true, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType for more details.

getShowAsStickyCallout(): boolean;

Returns

Specifies if the data label bubble size is visible.

getShowBubbleSize(): boolean;

Returns

Specifies if the data label category name is visible.

getShowCategoryName(): boolean;

Returns

Specifies if the data label legend key is visible.

getShowLegendKey(): boolean;

Returns

Specifies if the data label percentage is visible.

getShowPercentage(): boolean;

Returns

Specifies if the data label series name is visible.

getShowSeriesName(): boolean;

Returns

Specifies if the data label value is visible.

getShowValue(): boolean;

Returns

Returns a substring of the data label. The line break character '\n' counts as one character.

getSubstring(start: number, length?: number): ChartFormatString;

Parameters

Returns

Returns the tail anchor of the data label which is shown as a sticky callout.

getTailAnchor(): ChartDataLabelAnchor;

Returns

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

getText(): string;

Returns

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

getTextOrientation(): number;

Returns

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

getTop(): number;

Returns

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

getVerticalAlignment(): ChartTextVerticalAlignment;

Returns

Returns the width, in points, of the chart data label. Value is null if the chart data label is not visible.

getWidth(): number;

Returns

Specifies if the data label automatically generates appropriate text based on context.

setAutoText(autoText: boolean): void;

Parameters

Returns

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

setFormula(formula: string): void;

Parameters

Returns

Specifies the geometric shape type of the data label. See ExcelScript.GeometricShapeType for more details. Value is null if the data label is not a geometric shape.

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Parameters

Returns

Sets the height of the data label in points.

setHeight(height: number): void;

Parameters

Returns

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

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Parameters

Returns

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

setLeft(left: number): void;

Parameters

Returns

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

setLinkNumberFormat(linkNumberFormat: boolean): void;

Parameters

Returns

String value that represents the format code for data label.

setNumberFormat(numberFormat: string): void;

Parameters

Returns

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

setPosition(position: ChartDataLabelPosition): void;

Parameters

Returns

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

setSeparator(separator: string): void;

Parameters

Returns

Specifies if the data label bubble size is visible.

setShowBubbleSize(showBubbleSize: boolean): void;

Parameters

Returns

Specifies if the data label category name is visible.

setShowCategoryName(showCategoryName: boolean): void;

Parameters

Returns

Specifies if the data label legend key is visible.

setShowLegendKey(showLegendKey: boolean): void;

Parameters

Returns

Specifies if the data label percentage is visible.

setShowPercentage(showPercentage: boolean): void;

Parameters

Returns

Specifies if the data label series name is visible.

setShowSeriesName(showSeriesName: boolean): void;

Parameters

Returns

Specifies if the data label value is visible.

setShowValue(showValue: boolean): void;

Parameters

Returns

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

setText(text: string): void;

Parameters

Returns

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

setTextOrientation(textOrientation: number): void;

Parameters

Returns

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

setTop(top: number): void;

Parameters

Returns

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

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Parameters

Returns

Sets the width of the data label in points.

setWidth(width: number): void;

Parameters

Returns