Excel.PivotTableScopedCollection class
Stellt eine bereichsbezogene Auflistung von PivotTables dar. Die PivotTables werden basierend auf der Position der oberen linken Ecke der PivotTable sortiert. Sie werden von oben nach unten und dann von links nach rechts sortiert.
- Extends
Hinweise
Eigenschaften
context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
get |
Ruft die Anzahl der PivotTables in der Auflistung ab. |
get |
Ruft die erste PivotTable in der Auflistung ab. Die PivotTables in der Auflistung sind von oben nach unten und von links nach rechts sortiert, sodass die tabelle oben links die erste PivotTable in der Auflistung ist. |
get |
Ruft die erste PivotTable in der Auflistung ab. Die PivotTables in der Auflistung sind von oben nach unten und von links nach rechts sortiert, sodass die tabelle oben links die erste PivotTable in der Auflistung ist. Wenn die Auflistung leer ist, gibt diese Methode ein -Objekt zurück, dessen |
get |
Ruft eine PivotTable anhand des Namens ab. |
get |
Ruft eine PivotTable anhand des Namens ab. Wenn die PivotTable nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
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 " |
toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
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
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.PivotTable[];
Eigenschaftswert
Details zur Methode
getCount()
Ruft die Anzahl der PivotTables in der Auflistung ab.
getCount(): OfficeExtension.ClientResult<number>;
Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getFirst()
Ruft die erste PivotTable in der Auflistung ab. Die PivotTables in der Auflistung sind von oben nach unten und von links nach rechts sortiert, sodass die tabelle oben links die erste PivotTable in der Auflistung ist.
getFirst(): Excel.PivotTable;
Gibt zurück
Hinweise
getFirstOrNullObject()
Ruft die erste PivotTable in der Auflistung ab. Die PivotTables in der Auflistung sind von oben nach unten und von links nach rechts sortiert, sodass die tabelle oben links die erste PivotTable in der Auflistung ist. Wenn die Auflistung leer ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject
-Eigenschaft auf true
festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getFirstOrNullObject(): Excel.PivotTable;
Gibt zurück
Hinweise
getItem(key)
Ruft eine PivotTable anhand des Namens ab.
getItem(key: string): Excel.PivotTable;
Parameter
- key
-
string
Name der abzurufenden PivotTable.
Gibt zurück
Hinweise
getItemOrNullObject(name)
Ruft eine PivotTable anhand des Namens ab. Wenn die PivotTable nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject
-Eigenschaft auf true
festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(name: string): Excel.PivotTable;
Parameter
- name
-
string
Name der abzurufenden PivotTable.
Gibt zurück
Hinweise
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.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;
Parameter
- options
-
Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.PivotTableScopedCollection;
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?: OfficeExtension.LoadOption): Excel.PivotTableScopedCollection;
Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
toJSON()
Überschreibt die JavaScript-Methode toJSON()
, um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()
übergeben wird. (JSON.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.PivotTableScopedCollection
Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PivotTableScopedCollectionData
) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;
Gibt zurück
Office Add-ins