Excel.PivotTable class
Stellt eine Excel-PivotTable dar. Weitere Informationen zum PivotTable-Objektmodell finden Sie unter Arbeiten mit PivotTables mithilfe der Excel-JavaScript-API.
- Extends
Hinweise
Eigenschaften
| allow |
Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt. |
| column |
Die Pivot-Hierarchien der Spalten von PivotTable. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| data |
Die Pivot-Hierarchien der Daten von PivotTable. |
| enable |
Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt. |
| filter |
Die Pivot-Hierarchien der Filter von PivotTable. |
| hierarchies | Die Pivot-Hierarchien von PivotTable. |
| id | ID der PivotTable. |
| layout | Das PivotLayout-Objekt, das das Layout und die visuelle Struktur von PivotTable beschreibt. |
| name | Der Name der PivotTable. |
| refresh |
Gibt an, ob die PivotTable aktualisiert wird, wenn die Arbeitsmappe geöffnet wird. Entspricht der Einstellung "Beim Laden aktualisieren" auf der Benutzeroberfläche. |
| row |
Die Pivot-Hierarchien der Zeilen von PivotTable. |
| use |
Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet. |
| worksheet | Das Arbeitsblatt, das die aktuelle PivotTable enthält. |
Methoden
| delete() | Aktualisiert PivotTable |
| get |
Gibt die Zeichenfolgendarstellung der Datenquelle für die PivotTable zurück. Diese Methode unterstützt derzeit Zeichenfolgendarstellungen für Tabellen- und Bereichsobjekte. Andernfalls wird eine leere Zeichenfolge zurückgegeben. |
| get |
Ruft den Typ der Datenquelle für die PivotTable ab. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| refresh() | Aktualisiert die PivotTable. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
allowMultipleFiltersPerField
Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilter auf einem bestimmten PivotField in der Tabelle zulässt.
allowMultipleFiltersPerField: boolean;Eigenschaftswert
boolean
Hinweise
columnHierarchies
Die Pivot-Hierarchien der Spalten von PivotTable.
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;Eigenschaftswert
Hinweise
Beispiele
// 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
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
dataHierarchies
Die Pivot-Hierarchien der Daten von PivotTable.
readonly dataHierarchies: Excel.DataPivotHierarchyCollection;Eigenschaftswert
Hinweise
Beispiele
// 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
Gibt an, ob die PivotTable das Bearbeiten von Werten im Datentext durch den Benutzer zulässt.
enableDataValueEditing: boolean;Eigenschaftswert
boolean
Hinweise
filterHierarchies
Die Pivot-Hierarchien der Filter von PivotTable.
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;Eigenschaftswert
Hinweise
Beispiele
// 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
Die Pivot-Hierarchien von PivotTable.
readonly hierarchies: Excel.PivotHierarchyCollection;Eigenschaftswert
Hinweise
id
layout
Das PivotLayout-Objekt, das das Layout und die visuelle Struktur von PivotTable beschreibt.
readonly layout: Excel.PivotLayout;Eigenschaftswert
Hinweise
Beispiele
// 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
refreshOnOpen
Gibt an, ob die PivotTable aktualisiert wird, wenn die Arbeitsmappe geöffnet wird. Entspricht der Einstellung "Beim Laden aktualisieren" auf der Benutzeroberfläche.
refreshOnOpen: boolean;Eigenschaftswert
boolean
Hinweise
rowHierarchies
Die Pivot-Hierarchien der Zeilen von PivotTable.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Eigenschaftswert
Hinweise
useCustomSortLists
Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.
useCustomSortLists: boolean;Eigenschaftswert
boolean
Hinweise
worksheet
Das Arbeitsblatt, das die aktuelle PivotTable enthält.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
Details zur Methode
delete()
Aktualisiert PivotTable
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// 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();
});
getDataSourceString()
Gibt die Zeichenfolgendarstellung der Datenquelle für die PivotTable zurück. Diese Methode unterstützt derzeit Zeichenfolgendarstellungen für Tabellen- und Bereichsobjekte. Andernfalls wird eine leere Zeichenfolge zurückgegeben.
getDataSourceString(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml
// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
const worksheet = context.workbook.worksheets.getItem("TotalPivot");
const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");
// Retrieve the type and string representation of the data source of the PivotTable.
const pivotTableDataSourceType = pivotTable.getDataSourceType();
const pivotTableDataSourceString = pivotTable.getDataSourceString();
await context.sync();
// Log the data source information.
console.log("Data source: " + pivotTableDataSourceString.value);
console.log("Source type: " + pivotTableDataSourceType.value);
});
getDataSourceType()
Ruft den Typ der Datenquelle für die PivotTable ab.
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml
// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
const worksheet = context.workbook.worksheets.getItem("TotalPivot");
const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");
// Retrieve the type and string representation of the data source of the PivotTable.
const pivotTableDataSourceType = pivotTable.getDataSourceType();
const pivotTableDataSourceString = pivotTable.getDataSourceString();
await context.sync();
// Log the data source information.
console.log("Data source: " + pivotTableDataSourceString.value);
console.log("Source type: " + pivotTableDataSourceType.value);
});
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.PivotTable;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PivotTable;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
refresh()
Aktualisiert die PivotTable.
refresh(): void;Gibt zurück
void
Hinweise
Beispiele
// 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)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.PivotTableUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.PivotTable): void;Parameter
- properties
- Excel.PivotTable
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.PivotTable-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PivotTableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.PivotTableData;Gibt zurück
Office Add-ins