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
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
const pivotTable = context.workbook.worksheets
.getItem("Pivot")
.pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);
pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));
await context.sync();
});
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
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// Check if the PivotTable already has rows.
const farmRow = pivotTable.rowHierarchies.getItemOrNullObject("Farm");
const typeRow = pivotTable.rowHierarchies.getItemOrNullObject("Type");
const classificationRow = pivotTable.rowHierarchies.getItemOrNullObject("Classification");
pivotTable.rowHierarchies.load();
await context.sync();
if (!classificationRow.isNullObject) {
pivotTable.rowHierarchies.remove(classificationRow);
} else if (!typeRow.isNullObject) {
pivotTable.rowHierarchies.remove(typeRow);
} else if (!farmRow.isNullObject) {
pivotTable.rowHierarchies.remove(farmRow);
}
await context.sync();
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RowColumnPivotHierarchyCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RowColumnPivotHierarchyCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;