Excel.ChartDataLabels class

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

autoText: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.8 ]

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

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

readonly format: Excel.ChartDataLabelFormat;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: ExcelApi 1.8 ]

Gets an object that represents the leader lines of the data labels.

readonly leaderLines: Excel.ChartLeaderLines;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: ExcelApi 1.9 ]

Specifies the format code for data labels.

numberFormat: string;

Property Value

Remarks

[ API set: ExcelApi 1.8 ]

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

[ API set: ExcelApi 1.1 ]

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

separator: string;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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 GeometricShapeType for more details.

readonly showAsStickyCallout: boolean;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Specifies if the data label bubble size is visible.

showBubbleSize: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Specifies if the data label category name is visible.

showCategoryName: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Gets or sets a value that indicates whether leader lines are displayed for the data labels. true if leader lines are shown; otherwise, false.

showLeaderLines: boolean;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Specifies if the data label legend key is visible.

showLegendKey: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Specifies if the data label percentage is visible.

showPercentage: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Specifies if the data label series name is visible.

showSeriesName: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Specifies if the data label value is visible.

showValue: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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

Remarks

[ API set: ExcelApi 1.8 ]

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

Remarks

[ API set: ExcelApi 1.8 ]

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.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Parameters

Returns

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

Parameters

Returns

Examples

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

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

Parameters

Returns

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

Parameters

Returns

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

set(properties: Excel.ChartDataLabels): void;

Parameters

Returns

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's passed to it.) Whereas the original Excel.ChartDataLabels object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Returns