Excel.PivotTableCollection class
Représente une collection de tous les tableaux croisés dynamiques du classeur ou de la feuille de travail.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.3 ]
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(name, source, destination) | Ajoutez un tableau croisé dynamique basé sur les données sources spécifiées et insérez-le dans la cellule supérieure gauche de la plage de destination. |
| get |
Obtient le nombre de tableaux croisés dynamiques de la collection. |
| get |
Obtient un tableau croisé dynamique par nom. |
| get |
Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique 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 |
| refresh |
Actualise tous les tableaux croisés dynamiques de la collection. |
| 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.PivotTable[];Valeur de propriété
Détails de la méthode
add(name, source, destination)
Ajoutez un tableau croisé dynamique basé sur les données sources spécifiées et insérez-le dans la cellule supérieure gauche de la plage de destination.
add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;Paramètres
- name
-
string
Nom du nouveau tableau croisé dynamique.
- source
-
Excel.Range | string | Excel.Table
Données sources pour le nouveau tableau croisé dynamique, il peut s’agir d’une plage (ou d’une adresse de chaîne, y compris le nom de la feuille de calcul) ou d’une table.
- destination
-
Excel.Range | string
Cellule située dans le coin supérieur gauche de la plage de destination du rapport de tableau croisé dynamique (plage de la feuille de calcul destinée à recevoir le rapport obtenu).
Retours
Retourne le tableau croisé dynamique nouvellement inséré.
Remarques
[ Ensemble d’API : ExcelApi 1.8 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);
await context.sync();
});
getCount()
Obtient le nombre de tableaux croisés dynamiques de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(name)
Obtient un tableau croisé dynamique par nom.
getItem(name: string): Excel.PivotTable;Paramètres
- name
-
string
Nom du tableau croisé dynamique à récupérer.
Retours
Remarques
[ Ensemble d’API : ExcelApi 1.3 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml
// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
pivotTable.refresh();
await context.sync();
});
getItemOrNullObject(name)
Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique 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.PivotTable;Paramètres
- name
-
string
Nom du tableau croisé dynamique à 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.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;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.PivotTableCollection;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.PivotTableCollection;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
refreshAll()
Actualise tous les tableaux croisés dynamiques de la collection.
refreshAll(): void;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.PivotTableCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.PivotTableCollectionDataque ) 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.PivotTableCollectionData;Retours
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour