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
[API-Satz: ExcelApi 1.3]
Eigenschaften
| allow |
Gibt an, ob die PivotTable die Anwendung mehrerer PivotFilters auf ein bestimmtes PivotField in der Tabelle zulässt. |
| column |
Die Pivot-Hierarchien der Spalten von PivotTable. |
| context | Der dem Objekt zugeordnete Anforderungskontext. 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 zulässt, dass Werte im Datentext vom Benutzer bearbeitet werden. |
| 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 beim Öffnen der Arbeitsmappe aktualisiert wird. Entspricht der Einstellung "Beim Laden aktualisieren" in 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 PivotFilters auf ein bestimmtes PivotField in der Tabelle zulässt.
allowMultipleFiltersPerField: boolean;Eigenschaftswert
boolean
Hinweise
[API-Satz: ExcelApi 1.12]
columnHierarchies
Die Pivot-Hierarchien der Spalten von PivotTable.
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.8]
context
Der dem Objekt zugeordnete Anforderungskontext. 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
[API-Satz: ExcelApi 1.8]
enableDataValueEditing
Gibt an, ob die PivotTable zulässt, dass Werte im Datentext vom Benutzer bearbeitet werden.
enableDataValueEditing: boolean;Eigenschaftswert
boolean
Hinweise
[API-Satz: ExcelApi 1.9]
filterHierarchies
Die Pivot-Hierarchien der Filter von PivotTable.
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.8]
hierarchies
Die Pivot-Hierarchien von PivotTable.
readonly hierarchies: Excel.PivotHierarchyCollection;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.8]
id
ID der PivotTable.
readonly id: string;Eigenschaftswert
string
Hinweise
[API-Satz: ExcelApi 1.5]
layout
Das PivotLayout-Objekt, das das Layout und die visuelle Struktur von PivotTable beschreibt.
readonly layout: Excel.PivotLayout;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.8]
name
Der Name der PivotTable.
name: string;Eigenschaftswert
string
Hinweise
[API-Satz: ExcelApi 1.3]
refreshOnOpen
Gibt an, ob die PivotTable beim Öffnen der Arbeitsmappe aktualisiert wird. Entspricht der Einstellung "Beim Laden aktualisieren" in der Benutzeroberfläche.
refreshOnOpen: boolean;Eigenschaftswert
boolean
Hinweise
[API-Satz: ExcelApi 1.13]
rowHierarchies
Die Pivot-Hierarchien der Zeilen von PivotTable.
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.8]
useCustomSortLists
Gibt an, ob die PivotTable beim Sortieren benutzerdefinierte Listen verwendet.
useCustomSortLists: boolean;Eigenschaftswert
boolean
Hinweise
[API-Satz: ExcelApi 1.9]
worksheet
Das Arbeitsblatt, das die aktuelle PivotTable enthält.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
[API-Satz: ExcelApi 1.3]
Details zur Methode
delete()
Aktualisiert PivotTable
delete(): void;Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.8]
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
[API-Satz: ExcelApi 1.15]
getDataSourceType()
Ruft den Typ der Datenquelle für die PivotTable ab.
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;Gibt zurück
Hinweise
[API-Satz: ExcelApi 1.15]
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 für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
refresh()
Aktualisiert die PivotTable.
refresh(): void;Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.3]
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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Excel.PivotTable Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.PivotTableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.PivotTableData;