ChartDataLabels Object (JavaScript API for Excel)

Represents a collection of all the data labels on a chart point.

Properties

Property Type Description Req. Set
position string DataLabelPosition value that represents the position of the data label. Possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout. 1.1
separator string String representing the separator used for the data labels on a chart. 1.1
showBubbleSize bool Boolean value representing if the data label bubble size is visible or not. 1.1
showCategoryName bool Boolean value representing if the data label category name is visible or not. 1.1
showLegendKey bool Boolean value representing if the data label legend key is visible or not. 1.1
showPercentage bool Boolean value representing if the data label percentage is visible or not. 1.1
showSeriesName bool Boolean value representing if the data label series name is visible or not. 1.1
showValue bool Boolean value representing if the data label value is visible or not. 1.1

See property access examples.

Relationships

Relationship Type Description Req. Set
format ChartDataLabelFormat Represents the format of chart data labels, which includes fill and font formatting. Read-only. 1.1

Methods

None

Method Details

Property access examples

Make Series Name shown in Datalabels and set the position of datalabels to be "top";

Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.datalabels.showValue = true;
    chart.datalabels.position = "top";
    chart.datalabels.showSeriesName = true;
    return ctx.sync().then(function() {
            console.log("Datalabels Shown");
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});
scription   param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.  

Returns

void

Property access examples

Make Series Name shown in Datalabels and set the position of datalabels to be "top";

Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.datalabels.showValue = true;
    chart.datalabels.position = "top";
    chart.datalabels.showSeriesName = true;
    return ctx.sync().then(function() {
            console.log("Datalabels Shown");
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});