Excel.PivotHierarchyCollection class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

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

Методы

getCount()	Получает количество иерархий сводного объекта в коллекции.
getItem(name)	Возвращает сводную иерархию по ее имени или идентификатору.
getItemOrNullObject(name)	Получает PivotHierarchy по имени. Если PivotHierarchy не существует, то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PivotHierarchyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotHierarchyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.PivotHierarchy[];

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

Excel.PivotHierarchy[]

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

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.8 ]

getItem(name)

Возвращает сводную иерархию по ее имени или идентификатору.

getItem(name: string): Excel.PivotHierarchy;

Параметры

name

string

Имя извлекаемой сводной иерархии.

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

Excel.PivotHierarchy

Комментарии

[ Набор API: ExcelApi 1.8 ]

getItemOrNullObject(name)

Получает PivotHierarchy по имени. Если PivotHierarchy не существует, то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(name: string): Excel.PivotHierarchy;

Параметры

name

string

Имя извлекаемой сводной иерархии.

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

Excel.PivotHierarchy

Комментарии

[ Набор API: ExcelApi 1.8 ]

load(options)

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

load(options?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection;

Параметры

options

Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.PivotHierarchyCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.PivotHierarchyCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.PivotHierarchyCollection

toJSON()

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

toJSON(): Excel.Interfaces.PivotHierarchyCollectionData;

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

Excel.Interfaces.PivotHierarchyCollectionData