Excel.PivotItemCollection class
Représente une collection de tous les pivotItems associés à leur champ de tableau croisé dynamique parent.
- 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
get |
Obtient le nombre de PivotItems dans la collection. |
get |
Obtient un objet PivotItem par son nom ou son ID. |
get |
Obtient un pivotItem par nom. Si l’objet PivotItem 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 |
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.PivotItem[];
Valeur de propriété
Détails de la méthode
getCount()
Obtient le nombre de PivotItems dans la collection.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(name)
Obtient un objet PivotItem par son nom ou son ID.
getItem(name: string): Excel.PivotItem;
Paramètres
- name
-
string
Nom de l’objet PivotItem à récupérer.
Retours
Remarques
getItemOrNullObject(name)
Obtient un pivotItem par nom. Si l’objet PivotItem 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.PivotItem;
Paramètres
- name
-
string
Nom de l’objet PivotItem à 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.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection;
Paramètres
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.PivotItemCollection;
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.PivotItemCollection;
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
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.PivotItemCollection
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.PivotItemCollectionData
que ) 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.PivotItemCollectionData;