Excel.SlicerItem class

Пакет:

excel

Представляет элемент среза в срезе.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
hasData	Значение равно, true если элемент среза содержит данные.
isSelected	Значение равно, true если выбран элемент среза. Установка этого значения не очистит выбранное состояние других элементов среза. По умолчанию, если элемент среза является единственным выбранным, при отмене его выбора будут выбраны все элементы.
key	Представляет уникальное значение, соответствующее элементу среза.
name	Представляет заголовок, отображаемый в пользовательском интерфейсе Excel.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

hasData

Значение равно, true если элемент среза содержит данные.

readonly hasData: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

isSelected

Значение равно, true если выбран элемент среза. Установка этого значения не очистит выбранное состояние других элементов среза. По умолчанию, если элемент среза является единственным выбранным, при отмене его выбора будут выбраны все элементы.

isSelected: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

key

Представляет уникальное значение, соответствующее элементу среза.

readonly key: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

name

Представляет заголовок, отображаемый в пользовательском интерфейсе Excel.

readonly name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

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

load(options)

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

load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem;

Параметры

options

Excel.Interfaces.SlicerItemLoadOptions

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

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

Excel.SlicerItem

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.SlicerItem

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.SlicerItem

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.SlicerItemUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.SlicerItem): void;

Параметры

properties

Excel.SlicerItem

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

void

toJSON()

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

toJSON(): Excel.Interfaces.SlicerItemData;

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

Excel.Interfaces.SlicerItemData