Excel.ChartLegendEntry class

Пакет:

excel

Представляет запись условных обозначений в legendEntryCollection.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
height	Указывает высоту записи условных обозначений в условных обозначениях диаграммы.
index	Указывает индекс записи условных обозначений в условных обозначениях диаграммы.
left	Задает левое значение записи условных обозначений диаграммы.
top	Указывает начало записи условных обозначений диаграммы.
visible	Представляет видимость записи условных обозначений диаграммы.
width	Представляет ширину записи условных обозначений на диаграмме Условные обозначения.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

height

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

readonly height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

index

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

readonly index: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

left

Задает левое значение записи условных обозначений диаграммы.

readonly left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

top

Указывает начало записи условных обозначений диаграммы.

readonly top: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

visible

Представляет видимость записи условных обозначений диаграммы.

visible: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

width

Представляет ширину записи условных обозначений на диаграмме Условные обозначения.

readonly width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;

Параметры

options

Excel.Interfaces.ChartLegendEntryLoadOptions

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

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

Excel.ChartLegendEntry

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartLegendEntry

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartLegendEntry

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ChartLegendEntryUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartLegendEntry): void;

Параметры

properties

Excel.ChartLegendEntry

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendEntryData;

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

Excel.Interfaces.ChartLegendEntryData