Excel.ChartDataLabel class

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml

// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  await context.sync();

  const series = chart.series.getItemAt(0);
  series.load("points");
  await context.sync();

  series.points.load("items");
  await context.sync();

  // Style a substring in the first data label.
  let searchString = "sports";
  let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
  await context.sync();
  let substringStart = dataLabel.text.indexOf(searchString);
  let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
  subLabel.font.size = 13;
  subLabel.font.bold = true;

  // Style a substring in the second data label.
  searchString = "'Titanic'";
  dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
  await context.sync();

  substringStart = dataLabel.text.indexOf(searchString);
  subLabel = dataLabel.getSubstring(substringStart, searchString.length);
  subLabel.font.name = "Calibri";
  subLabel.font.size = 13;
  subLabel.font.italic = true;
  subLabel.font.color = "blue";
  await context.sync();
});

Свойства

autoText	Указывает, создает ли метка данных соответствующий текст автоматически на основе контекста.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
format	Представляет формат метки данных диаграммы.
formula	Строковое значение, представляющее формулу метки данных диаграммы с использованием нотации стиля A1.
height	Возвращает высоту метки данных диаграммы (в пунктах). Значением является, `null` если метка данных диаграммы не видна.
horizontalAlignment	Представляет горизонтальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой `Excel.ChartTextHorizontalAlignment` статье. Это свойство допустимо, только если `TextOrientation` метка данных имеет значение -90, 90 или 180.
left	Представляет расстояние от левого края метки данных диаграммы до левого края области диаграммы (в пунктах). Значением является, `null` если метка данных диаграммы не видна.
numberFormat	Задает код формата для метки данных.
position	Значение, представляющее положение метки данных. Дополнительные сведения см. в этой `Excel.ChartDataLabelPosition` статье.
separator	Строка, представляющая разделитель для метки данных на диаграмме.
showBubbleSize	Указывает, отображается ли размер пузырька метки данных.
showCategoryName	Указывает, отображается ли имя категории метки данных.
showLegendKey	Указывает, отображается ли ключ условных обозначений метки данных.
showPercentage	Указывает, отображается ли процент метки данных.
showSeriesName	Указывает, отображается ли имя ряда меток данных.
showValue	Указывает, отображается ли значение метки данных.
text	Строка, представляющая текст метки данных на диаграмме.
textOrientation	Представляет угол, на который текст ориентирован для метки данных диаграммы. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.
top	Представляет расстояние от верхнего края метки данных диаграммы до верха области диаграммы (в пунктах). Значением является, `null` если метка данных диаграммы не видна.
verticalAlignment	Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой `Excel.ChartTextVerticalAlignment` статье. Это свойство допустимо, только если `TextOrientation` метка данных имеет значение 0.
width	Возвращает ширину метки данных диаграммы (в пунктах). Значением является, `null` если метка данных диаграммы не видна.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.ChartDataLabel` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.ChartDataLabelData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

autoText

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

autoText: boolean;

Значение свойства

boolean

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

format

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

readonly format: Excel.ChartDataLabelFormat;

Значение свойства

Excel.ChartDataLabelFormat

formula

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

formula: string;

Значение свойства

string

height

Возвращает высоту метки данных диаграммы (в пунктах). Значением является, null если метка данных диаграммы не видна.

readonly height: number;

Значение свойства

number

horizontalAlignment

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

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

Значение свойства

left

Представляет расстояние от левого края метки данных диаграммы до левого края области диаграммы (в пунктах). Значением является, null если метка данных диаграммы не видна.

left: number;

Значение свойства

number

numberFormat

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

numberFormat: string;

Значение свойства

string

position

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

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

Значение свойства

separator

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

separator: string;

Значение свойства

string

showBubbleSize

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

showBubbleSize: boolean;

Значение свойства

boolean

showCategoryName

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

showCategoryName: boolean;

Значение свойства

boolean

showLegendKey

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

showLegendKey: boolean;

Значение свойства

boolean

showPercentage

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

showPercentage: boolean;

Значение свойства

boolean

showSeriesName

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

showSeriesName: boolean;

Значение свойства

boolean

showValue

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

showValue: boolean;

Значение свойства

boolean

text

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

text: string;

Значение свойства

string

textOrientation

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

textOrientation: number;

Значение свойства

number

top

Представляет расстояние от верхнего края метки данных диаграммы до верха области диаграммы (в пунктах). Значением является, null если метка данных диаграммы не видна.

top: number;

Значение свойства

number

verticalAlignment

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

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

Значение свойства

width

Возвращает ширину метки данных диаграммы (в пунктах). Значением является, null если метка данных диаграммы не видна.

readonly width: number;

Значение свойства

number

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

Параметры

options: Excel.Interfaces.ChartDataLabelLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.ChartDataLabel

load(propertyNames)

load(propertyNames?: string | string[]): Excel.ChartDataLabel;

Параметры

propertyNames: string | string[]

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

Возвращаемое значение

Excel.ChartDataLabel

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartDataLabel;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.ChartDataLabel

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.ChartDataLabelUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.ChartDataLabel): void;

Параметры

properties: Excel.ChartDataLabel

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartDataLabel объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.ChartDataLabelData;

Возвращаемое значение

Excel.Interfaces.ChartDataLabelData

Обратная связь

Была ли эта страница полезна?

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

Excel.ChartDataLabel class

Комментарии

Примеры

Свойства

Методы

Сведения о свойстве

autoText

Значение свойства

Комментарии

context

Значение свойства

format

Значение свойства

Комментарии

formula

Значение свойства

Комментарии

height

Значение свойства

Комментарии

horizontalAlignment

Значение свойства

Комментарии

left

Значение свойства

Комментарии

numberFormat

Значение свойства

Комментарии

position

Значение свойства

Комментарии

separator

Значение свойства

Комментарии

showBubbleSize

Значение свойства

Комментарии

showCategoryName

Значение свойства

Комментарии

showLegendKey

Значение свойства

Комментарии

showPercentage

Значение свойства

Комментарии

showSeriesName

Значение свойства

Комментарии

showValue

Значение свойства

Комментарии

text

Значение свойства

Комментарии

textOrientation

Значение свойства

Комментарии

top

Значение свойства

Комментарии

verticalAlignment

Значение свойства

Комментарии

width

Значение свойства

Комментарии

Сведения о методе

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)