Поделиться через


ExcelScript.ChartDataLabels interface

Представляет коллекцию всех меток данных в точке диаграммы.

Замечания

Примеры

/**
 * This sample configures data labels on a chart series.
 * This assumes the active worksheet has a pie chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure the data labels.
  const series = chart.getSeries()[0];
  const dataLabels = series.getDataLabels();
  dataLabels.setShowPercentage(true);
  dataLabels.setShowSeriesName(false);
  dataLabels.setShowCategoryName(false);
  dataLabels.setShowValue(false);
}

Методика

getAutoText()

Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.

getFormat()

Задает формат меток данных диаграммы, включая форматирование заливки и шрифта.

getGeometricShapeType()

Указывает тип геометрической фигуры меток данных. Дополнительные сведения см. в разделе ExcelScript.GeometricShapeType. Значением является, null если метки данных не являются геометрическими фигурами.

getHorizontalAlignment()

Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextHorizontalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение 0.

getLeaderLines()

Возвращает объект , представляющий линии-лидеры меток данных.

getLinkNumberFormat()

Указывает, связан ли числовой формат с ячейками. Если trueзадано значение , числовой формат изменится в метках при изменении в ячейках.

getNumberFormat()

Задает код формата для меток данных.

getPosition()

Значение, представляющее положение метки данных. Дополнительные сведения см. в этой ExcelScript.ChartDataLabelPosition статье.

getSeparator()

Строка, представляющая разделитель, который используется для меток данных на диаграмме.

getShowAsStickyCallout()

Указывает, отображаются ли метки данных в виде выноски с прикрепленной к точке данных хвостовой привязкой. Если trueзначение равно , выноска является одним из следующих значений: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRectCallout" или "WedgeEllipseCallout".

getShowBubbleSize()

Указывает, отображается ли размер пузырька метки данных.

getShowCategoryName()

Указывает, отображается ли имя категории метки данных.

getShowLeaderLines()

Указывает, отображаются ли строки лидеров для меток данных. true Значение , если отображаются строки лидеров; В противном случае — falseзначение .

getShowLegendKey()

Указывает, отображается ли ключ условных обозначений метки данных.

getShowPercentage()

Указывает, отображается ли процент метки данных.

getShowSeriesName()

Указывает, отображается ли имя ряда меток данных.

getShowValue()

Указывает, отображается ли значение метки данных.

getTextOrientation()

Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.

getVerticalAlignment()

Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение -90, 90 или 180.

setAutoText(autoText)

Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.

setGeometricShapeType(geometricShapeType)

Указывает тип геометрической фигуры меток данных. Дополнительные сведения см. в разделе ExcelScript.GeometricShapeType. Значением является, null если метки данных не являются геометрическими фигурами.

setHorizontalAlignment(horizontalAlignment)

Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextHorizontalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение 0.

setLinkNumberFormat(linkNumberFormat)

Указывает, связан ли числовой формат с ячейками. Если trueзадано значение , числовой формат изменится в метках при изменении в ячейках.

setNumberFormat(numberFormat)

Задает код формата для меток данных.

setPosition(position)

Значение, представляющее положение метки данных. Дополнительные сведения см. в этой ExcelScript.ChartDataLabelPosition статье.

setSeparator(separator)

Строка, представляющая разделитель, который используется для меток данных на диаграмме.

setShowBubbleSize(showBubbleSize)

Указывает, отображается ли размер пузырька метки данных.

setShowCategoryName(showCategoryName)

Указывает, отображается ли имя категории метки данных.

setShowLeaderLines(showLeaderLines)

Указывает, отображаются ли строки лидеров для меток данных. true Значение , если отображаются строки лидеров; В противном случае — falseзначение .

setShowLegendKey(showLegendKey)

Указывает, отображается ли ключ условных обозначений метки данных.

setShowPercentage(showPercentage)

Указывает, отображается ли процент метки данных.

setShowSeriesName(showSeriesName)

Указывает, отображается ли имя ряда меток данных.

setShowValue(showValue)

Указывает, отображается ли значение метки данных.

setTextOrientation(textOrientation)

Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.

setVerticalAlignment(verticalAlignment)

Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение -90, 90 или 180.

Подробнее о методе

getAutoText()

Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.

getAutoText(): boolean;

Возвращает

boolean

getFormat()

Задает формат меток данных диаграммы, включая форматирование заливки и шрифта.

getFormat(): ChartDataLabelFormat;

Возвращает

getGeometricShapeType()

Указывает тип геометрической фигуры меток данных. Дополнительные сведения см. в разделе ExcelScript.GeometricShapeType. Значением является, null если метки данных не являются геометрическими фигурами.

getGeometricShapeType(): GeometricShapeType;

Возвращает

getHorizontalAlignment()

Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextHorizontalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение 0.

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Возвращает

getLeaderLines()

Возвращает объект , представляющий линии-лидеры меток данных.

getLeaderLines(): ChartLeaderLines;

Возвращает

getLinkNumberFormat()

Указывает, связан ли числовой формат с ячейками. Если trueзадано значение , числовой формат изменится в метках при изменении в ячейках.

getLinkNumberFormat(): boolean;

Возвращает

boolean

getNumberFormat()

Задает код формата для меток данных.

getNumberFormat(): string;

Возвращает

string

getPosition()

Значение, представляющее положение метки данных. Дополнительные сведения см. в этой ExcelScript.ChartDataLabelPosition статье.

getPosition(): ChartDataLabelPosition;

Возвращает

getSeparator()

Строка, представляющая разделитель, который используется для меток данных на диаграмме.

getSeparator(): string;

Возвращает

string

getShowAsStickyCallout()

Указывает, отображаются ли метки данных в виде выноски с прикрепленной к точке данных хвостовой привязкой. Если trueзначение равно , выноска является одним из следующих значений: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRectCallout" или "WedgeEllipseCallout".

getShowAsStickyCallout(): boolean;

Возвращает

boolean

getShowBubbleSize()

Указывает, отображается ли размер пузырька метки данных.

getShowBubbleSize(): boolean;

Возвращает

boolean

getShowCategoryName()

Указывает, отображается ли имя категории метки данных.

getShowCategoryName(): boolean;

Возвращает

boolean

getShowLeaderLines()

Указывает, отображаются ли строки лидеров для меток данных. true Значение , если отображаются строки лидеров; В противном случае — falseзначение .

getShowLeaderLines(): boolean;

Возвращает

boolean

getShowLegendKey()

Указывает, отображается ли ключ условных обозначений метки данных.

getShowLegendKey(): boolean;

Возвращает

boolean

getShowPercentage()

Указывает, отображается ли процент метки данных.

getShowPercentage(): boolean;

Возвращает

boolean

getShowSeriesName()

Указывает, отображается ли имя ряда меток данных.

getShowSeriesName(): boolean;

Возвращает

boolean

getShowValue()

Указывает, отображается ли значение метки данных.

getShowValue(): boolean;

Возвращает

boolean

getTextOrientation()

Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.

getTextOrientation(): number;

Возвращает

number

getVerticalAlignment()

Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение -90, 90 или 180.

getVerticalAlignment(): ChartTextVerticalAlignment;

Возвращает

setAutoText(autoText)

Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.

setAutoText(autoText: boolean): void;

Параметры

autoText

boolean

Возвращает

void

setGeometricShapeType(geometricShapeType)

Указывает тип геометрической фигуры меток данных. Дополнительные сведения см. в разделе ExcelScript.GeometricShapeType. Значением является, null если метки данных не являются геометрическими фигурами.

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Параметры

geometricShapeType
ExcelScript.GeometricShapeType

Возвращает

void

setHorizontalAlignment(horizontalAlignment)

Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextHorizontalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение 0.

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Параметры

Возвращает

void

setLinkNumberFormat(linkNumberFormat)

Указывает, связан ли числовой формат с ячейками. Если trueзадано значение , числовой формат изменится в метках при изменении в ячейках.

setLinkNumberFormat(linkNumberFormat: boolean): void;

Параметры

linkNumberFormat

boolean

Возвращает

void

setNumberFormat(numberFormat)

Задает код формата для меток данных.

setNumberFormat(numberFormat: string): void;

Параметры

numberFormat

string

Возвращает

void

setPosition(position)

Значение, представляющее положение метки данных. Дополнительные сведения см. в этой ExcelScript.ChartDataLabelPosition статье.

setPosition(position: ChartDataLabelPosition): void;

Параметры

Возвращает

void

Примеры

/**
 * 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);
}

setSeparator(separator)

Строка, представляющая разделитель, который используется для меток данных на диаграмме.

setSeparator(separator: string): void;

Параметры

separator

string

Возвращает

void

setShowBubbleSize(showBubbleSize)

Указывает, отображается ли размер пузырька метки данных.

setShowBubbleSize(showBubbleSize: boolean): void;

Параметры

showBubbleSize

boolean

Возвращает

void

setShowCategoryName(showCategoryName)

Указывает, отображается ли имя категории метки данных.

setShowCategoryName(showCategoryName: boolean): void;

Параметры

showCategoryName

boolean

Возвращает

void

Примеры

/**
 * 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);
}

setShowLeaderLines(showLeaderLines)

Указывает, отображаются ли строки лидеров для меток данных. true Значение , если отображаются строки лидеров; В противном случае — falseзначение .

setShowLeaderLines(showLeaderLines: boolean): void;

Параметры

showLeaderLines

boolean

Возвращает

void

Примеры

/**
 * 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);
}

setShowLegendKey(showLegendKey)

Указывает, отображается ли ключ условных обозначений метки данных.

setShowLegendKey(showLegendKey: boolean): void;

Параметры

showLegendKey

boolean

Возвращает

void

setShowPercentage(showPercentage)

Указывает, отображается ли процент метки данных.

setShowPercentage(showPercentage: boolean): void;

Параметры

showPercentage

boolean

Возвращает

void

Примеры

/**
 * 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);
}

setShowSeriesName(showSeriesName)

Указывает, отображается ли имя ряда меток данных.

setShowSeriesName(showSeriesName: boolean): void;

Параметры

showSeriesName

boolean

Возвращает

void

Примеры

/**
 * 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);
}

setShowValue(showValue)

Указывает, отображается ли значение метки данных.

setShowValue(showValue: boolean): void;

Параметры

showValue

boolean

Возвращает

void

Примеры

/**
 * 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);
}

setTextOrientation(textOrientation)

Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.

setTextOrientation(textOrientation: number): void;

Параметры

textOrientation

number

Возвращает

void

setVerticalAlignment(verticalAlignment)

Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение -90, 90 или 180.

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Параметры

Возвращает

void