Freigeben über


Excel.DataPivotHierarchyCollection class

Stellt eine Auflistung von DataPivotHierarchy-Elementen dar, die der PivotTable zugeordnet sind.

Extends

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

add(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu.

getCount()

Ruft die Anzahl der Pivot-Hierarchien in der Sammlung ab.

getItem(name)

Ruft eine DataPivotHierarchy nach seinem Namen oder seiner ID ab.

getItemOrNullObject(name)

Ruft das DataPivotHierarchy-Objekt anhand des Namens ab. Wenn DataPivotHierarchy nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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(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(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.

remove(DataPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

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.DataPivotHierarchyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataPivotHierarchyCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

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.DataPivotHierarchy[];

Eigenschaftswert

Details zur Methode

add(pivotHierarchy)

Fügt der aktuellen Achse das PivotHierarchy-Objekt hinzu.

add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;

Parameter

pivotHierarchy
Excel.PivotHierarchy

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.8 ]

getCount()

Ruft die Anzahl der Pivot-Hierarchien in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.8 ]

getItem(name)

Ruft eine DataPivotHierarchy nach seinem Namen oder seiner ID ab.

getItem(name: string): Excel.DataPivotHierarchy;

Parameter

name

string

Name der abzurufenden DataPivotHierarchy.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.8 ]

getItemOrNullObject(name)

Ruft das DataPivotHierarchy-Objekt anhand des Namens ab. Wenn DataPivotHierarchy nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(name: string): Excel.DataPivotHierarchy;

Parameter

name

string

Name der abzurufenden DataPivotHierarchy.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;

Parameter

options

Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & 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.DataPivotHierarchyCollection;

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.DataPivotHierarchyCollection;

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

remove(DataPivotHierarchy)

Entfernt das PivotHierarchy-Objekt von der aktuellen Achse.

remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;

Parameter

DataPivotHierarchy
Excel.DataPivotHierarchy

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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.DataPivotHierarchyCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataPivotHierarchyCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;

Gibt zurück