Excel.SlicerStyle class

Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.10

Используется

Свойства

context

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

Указывает имя стиля среза.
readOnly

Указывает, доступен ли этот SlicerStyle объект только для чтения.

Методы

delete()

Удаляет стиль среза.
duplicate()

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

name

Указывает имя стиля среза.

name: string;

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

string

Комментарии

Набор API: ExcelApi 1.10

readOnly

Указывает, доступен ли этот SlicerStyle объект только для чтения.

readonly readOnly: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

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

delete()

Удаляет стиль среза.

delete(): void;

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

void

Комментарии

Набор API: ExcelApi 1.10

duplicate()

Создает копию стиля среза с копиями всех элементов стиля.

duplicate(): Excel.SlicerStyle;

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

Excel.SlicerStyle

Новый SlicerStyle объект, скопированный из этого стиля среза.

Комментарии

Набор API: ExcelApi 1.10

load(options)

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

load(options?: Excel.Interfaces.SlicerStyleLoadOptions): Excel.SlicerStyle;

Параметры

options
Excel.Interfaces.SlicerStyleLoadOptions

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

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

Excel.SlicerStyle

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.SlicerStyle

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.SlicerStyle

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.SlicerStyleUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.SlicerStyle): void;

Параметры

properties
Excel.SlicerStyle

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

void

toJSON()

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

toJSON(): Excel.Interfaces.SlicerStyleData;

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

Excel.Interfaces.SlicerStyleData