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

Excel.ChartDataLabels class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

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

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

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

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

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

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

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

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

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

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

Методы

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.ChartDataLabels объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelsData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

format

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

readonly format: Excel.ChartDataLabelFormat;

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

Excel.ChartDataLabelFormat

Комментарии

[ Набор API: ExcelApi 1.1 ]

position

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

separator

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

separator: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

showBubbleSize

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

showBubbleSize: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showCategoryName

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

showCategoryName: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showLegendKey

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

showLegendKey: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showPercentage

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

showPercentage: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showSeriesName

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

showSeriesName: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showValue

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

showValue: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Параметры

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

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

Excel.ChartDataLabels

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartDataLabels

Примеры

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartDataLabels

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.ChartDataLabelsUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartDataLabels): void;

Параметры

properties
Excel.ChartDataLabels

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartDataLabelsData;

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

Excel.Interfaces.ChartDataLabelsData