ExcelScript.ChartDataLabels interface

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

getAutoText(): boolean;

Returns

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

getFormat(): ChartDataLabelFormat;

Returns

Specifies the geometric shape type of the data labels. See ExcelScript.GeometricShapeType for more details. Value is null if the data labels are not geometric shapes.

getGeometricShapeType(): GeometricShapeType;

Returns

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

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Returns

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

getLeaderLines(): ChartLeaderLines;

Returns

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.

getLinkNumberFormat(): boolean;

Returns

Specifies the format code for data labels.

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 labels on a chart.

getSeparator(): string;

Returns

Specifies if 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".

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 leader lines are displayed for the data labels. true if leader lines are shown; otherwise, false.

getShowLeaderLines(): 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

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.

getTextOrientation(): number;

Returns

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

getVerticalAlignment(): ChartTextVerticalAlignment;

Returns

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

setAutoText(autoText: boolean): void;

Parameters

Returns

Specifies the geometric shape type of the data labels. See ExcelScript.GeometricShapeType for more details. Value is null if the data labels are not geometric shapes.

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Parameters

Returns

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

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Parameters

Returns

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.

setLinkNumberFormat(linkNumberFormat: boolean): void;

Parameters

Returns

Specifies the format code for data labels.

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

Examples

/**
 * This sample sets the position of data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the data label position to best fit.
  const series = chart.getSeries()[0];
  series.getDataLabels().setPosition(ExcelScript.ChartDataLabelPosition.bestFit);
}

String representing the separator used for the data labels 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

Examples

/**
 * This sample shows category names in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show category names in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowCategoryName(true);
}

Specifies if leader lines are displayed for the data labels. true if leader lines are shown; otherwise, false.

setShowLeaderLines(showLeaderLines: boolean): void;

Parameters

Returns

Examples

/**
 * This sample enables leader lines for data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Enable leader lines.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowLeaderLines(true);
}

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

Examples

/**
 * This sample shows percentages in data labels.
 * This assumes the active worksheet has a pie chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show percentages in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowPercentage(true);
}

Specifies if the data label series name is visible.

setShowSeriesName(showSeriesName: boolean): void;

Parameters

Returns

Examples

/**
 * This sample controls series name visibility in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the series name in data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowSeriesName(false);
}

Specifies if the data label value is visible.

setShowValue(showValue: boolean): void;

Parameters

Returns

Examples

/**
 * This sample shows values in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show values in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowValue(true);
}

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.

setTextOrientation(textOrientation: 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 the data label is -90, 90, or 180.

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Parameters

Returns