Excel.DataPivotHierarchyCollection class

Paquet:

excel

Représente une collection d’éléments DataPivotHierarchy associés au tableau croisé dynamique.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(pivotHierarchy)	Ajoute le PivotHierarchy à l’axe en cours.
getCount()	Obtient le nombre de hiérarchies croisées de la collection.
getItem(name)	Obtient un DataPivotHierarchy par son nom ou son ID.
getItemOrNullObject(name)	Obtient une DataPivotHierarchy par nom. Si dataPivotHierarchy n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
remove(DataPivotHierarchy)	Supprime le PivotHierarchy de l’axe en cours.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.DataPivotHierarchyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.DataPivotHierarchyCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.DataPivotHierarchy[];

Valeur de propriété

Excel.DataPivotHierarchy[]

Détails de la méthode

add(pivotHierarchy)

Ajoute le PivotHierarchy à l’axe en cours.

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

Paramètres

pivotHierarchy

Excel.PivotHierarchy

Retours

Excel.DataPivotHierarchy

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getCount()

Obtient le nombre de hiérarchies croisées de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getItem(name)

Obtient un DataPivotHierarchy par son nom ou son ID.

getItem(name: string): Excel.DataPivotHierarchy;

Paramètres

name

string

Nom de la DataPivotHierarchy à récupérer.

Retours

Excel.DataPivotHierarchy

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getItemOrNullObject(name)

Obtient une DataPivotHierarchy par nom. Si dataPivotHierarchy n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(name: string): Excel.DataPivotHierarchy;

Paramètres

name

string

Nom de la DataPivotHierarchy à récupérer.

Retours

Excel.DataPivotHierarchy

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;

Paramètres

options

Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.DataPivotHierarchyCollection

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.DataPivotHierarchyCollection;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.DataPivotHierarchyCollection

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection;

Paramètres

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.DataPivotHierarchyCollection

remove(DataPivotHierarchy)

Supprime le PivotHierarchy de l’axe en cours.

remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;

Paramètres

DataPivotHierarchy

Excel.DataPivotHierarchy

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.DataPivotHierarchyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.DataPivotHierarchyCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;

Retours

Excel.Interfaces.DataPivotHierarchyCollectionData