Excel.ChartDataLabel class

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

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

Extends

Свойства

autoText

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

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

context

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

format

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

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

formula

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

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

height

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

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

horizontalAlignment

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

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

left

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

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

linkNumberFormat

Указывает, связан ли числовой формат с ячейками (поэтому формат чисел изменяется в метках при изменении в ячейках).

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

numberFormat

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

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

position

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

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

separator

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

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

showBubbleSize

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

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

showCategoryName

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

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

showLegendKey

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

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

showPercentage

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

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

showSeriesName

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

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

showValue

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

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

text

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

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

textOrientation

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

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

top

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

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

verticalAlignment

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

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

width

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

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

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

autoText

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

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

autoText: boolean;

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

boolean

context

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

context: RequestContext;

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

format

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

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

readonly format: Excel.ChartDataLabelFormat;

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

formula

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

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

formula: string;

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

string

height

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

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

readonly height: number;

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

number

horizontalAlignment

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

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

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

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

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

left

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

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

left: number;

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

number

linkNumberFormat

Указывает, связан ли числовой формат с ячейками (поэтому формат чисел изменяется в метках при изменении в ячейках).

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

linkNumberFormat: boolean;

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

boolean

numberFormat

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

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

numberFormat: string;

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

string

position

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

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

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,7]

separator: string;

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

string

showBubbleSize

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

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

showBubbleSize: boolean;

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

boolean

showCategoryName

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

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

showCategoryName: boolean;

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

boolean

showLegendKey

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

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

showLegendKey: boolean;

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

boolean

showPercentage

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

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

showPercentage: boolean;

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

boolean

showSeriesName

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

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

showSeriesName: boolean;

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

boolean

showValue

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

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

showValue: boolean;

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

boolean

text

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

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

text: string;

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

string

textOrientation

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

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

textOrientation: number;

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

number

top

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

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

top: number;

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

number

verticalAlignment

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

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

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

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

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

width

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

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

readonly width: number;

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

number

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

load(options)

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

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

Параметры

options
Excel.Interfaces.ChartDataLabelLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

set(properties, options)

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

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

Параметры

properties
Interfaces.ChartDataLabelUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

Комментарии

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

set(properties: Excel.ChartDataLabel): void

set(properties)

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

set(properties: Excel.ChartDataLabel): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartDataLabelData;

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