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

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

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

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