Excel. Chart Data Label class

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

Excel.RequestContext

format

Represents the format of chart data label.

readonly format: Excel.ChartDataLabelFormat;

Property Value

Excel.ChartDataLabelFormat

Remarks

formula

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

formula: string;

Property Value

string

Remarks

geometricShapeType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets or sets the geometric shape type of the data label. See Excel.GeometricShapeType for more details. Value is null if the data label is not a geometric shape.

geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Property Value

Remarks

height

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

readonly height: number;

Property Value

number

Remarks

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.

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

Property Value

Remarks

left

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.

left: number;

Property Value

number

Remarks

linkNumberFormat

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).

linkNumberFormat: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

numberFormat

String value that represents the format code for data label.

numberFormat: string;

Property Value

string

Remarks

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

Remarks

separator

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

separator: string;

Property Value

string

Remarks

showAsStickyCallout

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a value that indicates whether the data label is 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 GeometricShapeType for more details.

readonly showAsStickyCallout: boolean;

Property Value

boolean

Remarks

showBubbleSize

Specifies if the data label bubble size is visible.

showBubbleSize: boolean;

Property Value

boolean

Remarks

showCategoryName

Specifies if the data label category name is visible.

showCategoryName: boolean;

Property Value

boolean

Remarks

showLegendKey

Specifies if the data label legend key is visible.

showLegendKey: boolean;

Property Value

boolean

Remarks

showPercentage

Specifies if the data label percentage is visible.

showPercentage: boolean;

Property Value

boolean

Remarks

showSeriesName

Specifies if the data label series name is visible.

showSeriesName: boolean;

Property Value

boolean

Remarks

showValue

Specifies if the data label value is visible.

showValue: boolean;

Property Value

boolean

Remarks

text

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

text: string;

Property Value

string

Remarks

textOrientation

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.

textOrientation: number;

Property Value

number

Remarks

top

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.

top: number;

Property Value

number

Remarks

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.

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

Property Value

Remarks

width

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

readonly width: number;

Property Value

number

Remarks

Method Details

getSubstring(start, length)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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

Parameters

start: number

The zero-based starting character position of a substring in the data label.

length: number

Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved.

Returns

Excel.ChartFormatString

Remarks

getTailAnchor()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

getTailAnchor(): Excel.ChartDataLabelAnchor;

Returns

Excel.ChartDataLabelAnchor

Remarks

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

Excel.ChartDataLabel

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

Excel.ChartDataLabel

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

Excel.ChartDataLabel

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: Excel.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

set(properties)

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

set(properties: Excel.ChartDataLabel): void;

Parameters

properties: Excel.ChartDataLabel

Returns

void

setHeight(height)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sets the height of the data label in points.

setHeight(height: number): void;

Parameters

height: number

The height of the data label in points.

Returns

void

Remarks

setWidth(width)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sets the width of the data label in points.

setWidth(width: number): void;

Parameters

width: number

The width of the data label in points.

Returns

void

Remarks