Excel.ChartDataLabel class

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

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

context

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

context: RequestContext;

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

Excel.RequestContext

format

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

readonly format: Excel.ChartDataLabelFormat;

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

Excel.ChartDataLabelFormat

Комментарии

[ Набор API: ExcelApi 1.8 ]

formula

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

formula: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

height

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

readonly height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

horizontalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

left

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

left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

numberFormat

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

numberFormat: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

separator

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

separator: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

showBubbleSize

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

showBubbleSize: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

showCategoryName

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

showCategoryName: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

showLegendKey

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

showLegendKey: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

showPercentage

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

showPercentage: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

showSeriesName

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

showSeriesName: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

showValue

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

showValue: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

text

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

text: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

textOrientation

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

textOrientation: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

top

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

top: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

verticalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

width

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

readonly width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

load(options)

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

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

Параметры

options
Excel.Interfaces.ChartDataLabelLoadOptions

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

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

Excel.ChartDataLabel

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartDataLabel

load(propertyNamesAndPaths)

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

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