Excel.ChartDataLabels class

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

[Набор API: ExcelApi 1,1]

Extends

Свойства

autoText

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

[Набор API: ExcelApi 1,8]

context

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

format

Задает формат подписей данных диаграммы, включающий форматирование текста и заливки.

[Набор API: ExcelApi 1,1]

horizontalAlignment

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

[Набор API: ExcelApi 1,8]

linkNumberFormat

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

[Набор API: ExcelApi 1,9]

numberFormat

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

[Набор API: ExcelApi 1,8]

position

Значение DataLabelPosition, которое представляет положение метки данных. Дополнительные сведения см. в статье Excel. Чартдаталабелпоситион.

[Набор API: ExcelApi 1,1]

separator

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

[Набор API: ExcelApi 1,1]

showBubbleSize

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

[Набор API: ExcelApi 1,1]

showCategoryName

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

[Набор API: ExcelApi 1,1]

showLegendKey

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

[Набор API: ExcelApi 1,1]

showPercentage

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

[Набор API: ExcelApi 1,1]

showSeriesName

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

[Набор API: ExcelApi 1,1]

showValue

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

[Набор API: ExcelApi 1,1]

textOrientation

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

[Набор API: ExcelApi 1,8]

verticalAlignment

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

[Набор API: ExcelApi 1,8]

Методы

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

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

autoText

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

[Набор API: ExcelApi 1,8]

autoText: boolean;

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

boolean

context

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

context: RequestContext;

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

format

Задает формат подписей данных диаграммы, включающий форматирование текста и заливки.

[Набор API: ExcelApi 1,1]

readonly format: Excel.ChartDataLabelFormat;

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

horizontalAlignment

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

[Набор API: ExcelApi 1,8]

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

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

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

linkNumberFormat

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

[Набор API: ExcelApi 1,9]

linkNumberFormat: boolean;

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

boolean

numberFormat

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

[Набор API: ExcelApi 1,8]

numberFormat: string;

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

string

position

Значение DataLabelPosition, которое представляет положение метки данных. Дополнительные сведения см. в статье Excel. Чартдаталабелпоситион.

[Набор API: ExcelApi 1,1]

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"

separator

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

[Набор API: ExcelApi 1,1]

separator: string;

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

string

showBubbleSize

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

[Набор API: ExcelApi 1,1]

showBubbleSize: boolean;

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

boolean

showCategoryName

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

[Набор API: ExcelApi 1,1]

showCategoryName: boolean;

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

boolean

showLegendKey

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

[Набор API: ExcelApi 1,1]

showLegendKey: boolean;

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

boolean

showPercentage

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

[Набор API: ExcelApi 1,1]

showPercentage: boolean;

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

boolean

showSeriesName

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

[Набор API: ExcelApi 1,1]

showSeriesName: boolean;

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

boolean

showValue

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

[Набор API: ExcelApi 1,1]

showValue: boolean;

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

boolean

textOrientation

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

[Набор API: ExcelApi 1,8]

textOrientation: number;

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

number

verticalAlignment

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

[Набор API: ExcelApi 1,8]

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

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

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

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

load(options)

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

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

Параметры

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

Примеры

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

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

set(properties, options)

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

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

Параметры

properties
Interfaces.ChartDataLabelsUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

Комментарии

Этот метод имеет следующую дополнительную подпись:

set(properties: Excel.ChartDataLabels): void

set(properties)

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

set(properties: Excel.ChartDataLabels): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartDataLabelsData;

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