Excel.DataPivotHierarchyCollection class

Пакет:

excel

Представляет коллекцию элементов DataPivotHierarchy, связанных со сводной таблицей.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

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

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.DataPivotHierarchy[];

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

Excel.DataPivotHierarchy[]

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

add(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси.

add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;

Параметры

pivotHierarchy

Excel.PivotHierarchy

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

Excel.DataPivotHierarchy

Комментарии

[ Набор API: ExcelApi 1.8 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.8 ]

getItem(name)

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

getItem(name: string): Excel.DataPivotHierarchy;

Параметры

name

string

Имя извлекаемой dataPivotHierarchy.

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

Excel.DataPivotHierarchy

Комментарии

[ Набор API: ExcelApi 1.8 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.DataPivotHierarchy;

Параметры

name

string

Имя извлекаемой dataPivotHierarchy.

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

Excel.DataPivotHierarchy

Комментарии

[ Набор API: ExcelApi 1.8 ]

load(options)

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

load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;

Параметры

options

Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.DataPivotHierarchyCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.DataPivotHierarchyCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.DataPivotHierarchyCollection

remove(DataPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;

Параметры

DataPivotHierarchy

Excel.DataPivotHierarchy

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

void

Комментарии

[ Набор API: ExcelApi 1.8 ]

toJSON()

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

toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;

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

Excel.Interfaces.DataPivotHierarchyCollectionData