Excel.PivotTable class
Представляет сводную таблицу Excel. Дополнительные сведения об объектной модели сводной таблицы см. в статье Работа со сводными таблицами с помощью API JavaScript для Excel.
- Extends
Комментарии
Свойства
| allow |
Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице. |
| column |
Иерархии сводных столбцов сводной таблицы. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| data |
Иерархии сводных данных сводной таблицы. |
| enable |
Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем. |
| filter |
Иерархии сводных фильтров сводной таблицы. |
| hierarchies | Иерархии сводного документа сводной таблицы. |
| id | Идентификатор сводной таблицы. |
| layout | PivotLayout, описывающий макет и визуальную структуру сводной таблицы. |
| name | Имя сводной таблицы. |
| row |
Иерархии сводных строк сводной таблицы. |
| use |
Указывает, использует ли сводная таблица настраиваемые списки при сортировке. |
| worksheet | Лист, содержащий текущую сводную таблицу. |
Методы
| delete() | Удаляет сводную таблицу. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| refresh() | Обновляет сводную таблицу. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
allowMultipleFiltersPerField
Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.
allowMultipleFiltersPerField: boolean;Значение свойства
boolean
Комментарии
columnHierarchies
Иерархии сводных столбцов сводной таблицы.
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;Значение свойства
Комментарии
Примеры
// 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 a column.
const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
column.load("id");
await context.sync();
if (column.isNullObject) {
// Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
} else {
pivotTable.columnHierarchies.remove(column);
}
await context.sync();
});
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
dataHierarchies
Иерархии сводных данных сводной таблицы.
readonly dataHierarchies: Excel.DataPivotHierarchyCollection;Значение свойства
Комментарии
Примеры
// 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");
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));
await context.sync();
});
enableDataValueEditing
Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем.
enableDataValueEditing: boolean;Значение свойства
boolean
Комментарии
filterHierarchies
Иерархии сводных фильтров сводной таблицы.
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml
async function filter(functionType: Excel.AggregationFunction) {
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
const filters = pivotTable.filterHierarchies;
const filter = filters.getItemOrNullObject("Classification");
filter.load();
await context.sync();
// Add the Classification hierarchy to the filter, if it's not already there.
if (filter.isNullObject) {
filters.add(pivotTable.hierarchies.getItem("Classification"));
await context.sync();
}
});
}
hierarchies
Иерархии сводного документа сводной таблицы.
readonly hierarchies: Excel.PivotHierarchyCollection;Значение свойства
Комментарии
id
Идентификатор сводной таблицы.
readonly id: string;Значение свойства
string
Комментарии
layout
PivotLayout, описывающий макет и визуальную структуру сводной таблицы.
readonly layout: Excel.PivotLayout;Значение свойства
Комментарии
Примеры
// 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");
pivotTable.layout.load("layoutType");
await context.sync();
// Cycle between the three layout types.
if (pivotTable.layout.layoutType === "Compact") {
pivotTable.layout.layoutType = "Outline";
} else if (pivotTable.layout.layoutType === "Outline") {
pivotTable.layout.layoutType = "Tabular";
} else {
pivotTable.layout.layoutType = "Compact";
}
await context.sync();
console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});
name
rowHierarchies
Иерархии сводных строк сводной таблицы.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Значение свойства
Комментарии
useCustomSortLists
Указывает, использует ли сводная таблица настраиваемые списки при сортировке.
useCustomSortLists: boolean;Значение свойства
boolean
Комментарии
worksheet
Лист, содержащий текущую сводную таблицу.
readonly worksheet: Excel.Worksheet;Значение свойства
Комментарии
Сведения о методе
delete()
Удаляет сводную таблицу.
delete(): void;Возвращаемое значение
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) => {
context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.PivotTable;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PivotTable;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
refresh()
Обновляет сводную таблицу.
refresh(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml
// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
pivotTable.refresh();
await context.sync();
});
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.PivotTableUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.PivotTable): void;Параметры
- properties
- Excel.PivotTable
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PivotTable объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotTableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.PivotTableData;Возвращаемое значение
Office Add-ins