Excel.FilterPivotHierarchyCollection class
Représente une collection d’éléments FilterPivotHierarchy associés au tableau croisé dynamique.
- Extends
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(pivot |
Ajoute le PivotHierarchy à l’axe en cours. Si la hiérarchie apparaît ailleurs sur la ligne, colonne ou axe de filtre, celle-ci est supprimée de cet emplacement. |
| get |
Obtient le nombre de hiérarchies croisées de la collection. |
| get |
Obtient un FilterPivotHierarchy par son nom ou son ID. |
| get |
Obtient un FilterPivotHierarchy par nom. Si l’objet FilterPivotHierarchy n’existe pas, cette méthode retourne un objet avec sa |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| remove(filter |
Supprime le PivotHierarchy de l’axe en cours. |
| toJSON() | Remplace la méthode JavaScript |
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.FilterPivotHierarchy[];Valeur de propriété
Détails de la méthode
add(pivotHierarchy)
Ajoute le PivotHierarchy à l’axe en cours. Si la hiérarchie apparaît ailleurs sur la ligne, colonne ou axe de filtre, celle-ci est supprimée de cet emplacement.
add(pivotHierarchy: Excel.PivotHierarchy): Excel.FilterPivotHierarchy;Paramètres
- pivotHierarchy
- Excel.PivotHierarchy
Retours
Remarques
getCount()
Obtient le nombre de hiérarchies croisées de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(name)
Obtient un FilterPivotHierarchy par son nom ou son ID.
getItem(name: string): Excel.FilterPivotHierarchy;Paramètres
- name
-
string
Nom de l’objet FilterPivotHierarchy à récupérer.
Retours
Remarques
getItemOrNullObject(name)
Obtient un FilterPivotHierarchy par nom. Si l’objet FilterPivotHierarchy 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.FilterPivotHierarchy;Paramètres
- name
-
string
Nom de l’objet FilterPivotHierarchy à récupérer.
Retours
Remarques
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.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection;Paramètres
- options
-
Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retours
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.FilterPivotHierarchyCollection;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
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.FilterPivotHierarchyCollection;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
remove(filterPivotHierarchy)
Supprime le PivotHierarchy de l’axe en cours.
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void;Paramètres
- filterPivotHierarchy
- Excel.FilterPivotHierarchy
Retours
void
Remarques
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.FilterPivotHierarchyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.FilterPivotHierarchyCollectionDataque ) 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.FilterPivotHierarchyCollectionData;