Excel.RowColumnPivotHierarchyCollection class
Представляет коллекцию элементов RowColumnPivotHierarchy, связанных со сводной таблицей.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(pivot |
Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения. |
| get |
Получает количество иерархий сводного объекта в коллекции. |
| get |
Возвращает RowColumnPivotHierarchy по его имени или идентификатору. |
| get |
Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, то этот метод возвращает объект со свойством , для которых |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| remove(row |
Удаляет PivotHierarchy из текущей оси. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.RowColumnPivotHierarchy[];Значение свойства
Сведения о методе
add(pivotHierarchy)
Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.
add(pivotHierarchy: Excel.PivotHierarchy): Excel.RowColumnPivotHierarchy;Параметры
- pivotHierarchy
- Excel.PivotHierarchy
Возвращаемое значение
Комментарии
getCount()
Получает количество иерархий сводного объекта в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(name)
Возвращает RowColumnPivotHierarchy по его имени или идентификатору.
getItem(name: string): Excel.RowColumnPivotHierarchy;Параметры
- name
-
string
Имя извлекаемой иерархии RowColumnPivotHierarchy.
Возвращаемое значение
Комментарии
getItemOrNullObject(name)
Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, то этот метод возвращает объект со свойством , для которых isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy;Параметры
- name
-
string
Имя извлекаемой иерархии RowColumnPivotHierarchy.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection;Параметры
- options
-
Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchyCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
remove(rowColumnPivotHierarchy)
Удаляет PivotHierarchy из текущей оси.
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void;Параметры
- rowColumnPivotHierarchy
- Excel.RowColumnPivotHierarchy
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RowColumnPivotHierarchyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.RowColumnPivotHierarchyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;Возвращаемое значение
Office Add-ins