Excel.PivotTableStyleCollection class

Пакет:

excel

Представляет коллекцию стилей сводной таблицы.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

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

Методы

add(name, makeUniqueName)	Создает пустой PivotTableStyle объект с указанным именем.
getCount()	Получает количество стилей сводных таблиц в коллекции.
getDefault()	Возвращает стиль сводной таблицы по умолчанию для области родительского объекта.
getItem(name)	Возвращает по PivotTableStyle имени.
getItemOrNullObject(name)	Возвращает по PivotTableStyle имени. PivotTableStyle Если объект не существует, то этот метод возвращает объект со свойством trueisNullObject. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
setDefault(newDefaultStyle)	Задает стиль сводной таблицы по умолчанию для использования в области родительского объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PivotTableStyleCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotTableStyleCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.PivotTableStyle[];

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

Excel.PivotTableStyle[]

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

add(name, makeUniqueName)

Создает пустой PivotTableStyle объект с указанным именем.

add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;

Параметры

name

string

Уникальное имя нового стиля сводной таблицы. Если имя уже используется, вызовет InvalidArgument ошибку.

makeUniqueName

boolean

Необязательный параметр. По умолчанию используется значение false. Если trueзначение , при необходимости добавит к имени номера, чтобы сделать его уникальным.

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

Excel.PivotTableStyle

Только что созданный PivotTableStyleобъект .

Комментарии

[ Набор API: ExcelApi 1.10 ]

getCount()

Получает количество стилей сводных таблиц в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.10 ]

getDefault()

Возвращает стиль сводной таблицы по умолчанию для области родительского объекта.

getDefault(): Excel.PivotTableStyle;

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

Excel.PivotTableStyle

Объект PivotTableStyle , который является текущим стилем сводной таблицы по умолчанию.

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItem(name)

Возвращает по PivotTableStyle имени.

getItem(name: string): Excel.PivotTableStyle;

Параметры

name

string

Имя стиля сводной таблицы, который требуется извлечь.

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

Excel.PivotTableStyle

Объект PivotTableStyle , имя которого соответствует входным данным.

Комментарии

[ Набор API: ExcelApi 1.10 ]

getItemOrNullObject(name)

Возвращает по PivotTableStyle имени. PivotTableStyle Если объект не существует, то этот метод возвращает объект со свойством trueisNullObject. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(name: string): Excel.PivotTableStyle;

Параметры

name

string

Имя стиля сводной таблицы, который требуется извлечь.

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

Excel.PivotTableStyle

Объект PivotTableStyle , имя которого соответствует входным данным.

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;

Параметры

options

Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.PivotTableStyleCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.PivotTableStyleCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.PivotTableStyleCollection

setDefault(newDefaultStyle)

Задает стиль сводной таблицы по умолчанию для использования в области родительского объекта.

setDefault(newDefaultStyle: PivotTableStyle | string): void;

Параметры

newDefaultStyle

Excel.PivotTableStyle | string

Объект PivotTableStyle или имя PivotTableStyle объекта, который должен быть новым значением по умолчанию.

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

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;

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

Excel.Interfaces.PivotTableStyleCollectionData