Excel.PivotTable class

Paquet:

excel

Représente un tableau croisé dynamique Excel. Pour en savoir plus sur le modèle objet de tableau croisé dynamique, consultez Utiliser des tableaux croisés dynamiques à l’aide de l’API JavaScript Excel.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

Propriétés

allowMultipleFiltersPerField	Spécifie si le tableau croisé dynamique autorise l’application de plusieurs filtres croisés dynamiques sur un champ de tableau croisé dynamique donné dans la table.
columnHierarchies	Les hiérarchies de colonne de tableau croisé dynamique.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
dataHierarchies	Les hiérarchies de données de tableau croisé dynamique.
enableDataValueEditing	Spécifie si le tableau croisé dynamique autorise la modification des valeurs du corps des données par l’utilisateur.
filterHierarchies	Les hiérarchies de filtre de tableau croisé dynamique.
hierarchies	Les hiérarchies Pivot de tableau croisé dynamique.
id	ID du tableau croisé dynamique.
layout	Le PivotLayout décrivant la disposition et la structure visuelle de tableau croisé dynamique.
name	Nom du tableau croisé dynamique.
refreshOnOpen	Spécifie si le tableau croisé dynamique s’actualise lorsque le classeur s’ouvre. Correspond au paramètre « Actualiser au chargement » dans l’interface utilisateur.
rowHierarchies	Les hiérarchies de lignes de tableau croisé dynamique.
useCustomSortLists	Spécifie si le tableau croisé dynamique utilise des listes personnalisées lors du tri.
worksheet	Feuille de calcul contenant le tableau croisé dynamique.

Méthodes

delete()	Supprime le tableau croisé dynamique.
getDataSourceString()	Retourne la représentation sous forme de chaîne de la source de données pour le tableau croisé dynamique. Cette méthode prend actuellement en charge les représentations sous forme de chaîne pour les objets de table et de plage. Sinon, elle retourne une chaîne vide.
getDataSourceType()	Obtient le type de la source de données pour le tableau croisé dynamique.
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.
refresh()	Actualise le tableau croisé dynamique.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
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 Excel.PivotTable d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.PivotTableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

allowMultipleFiltersPerField

Spécifie si le tableau croisé dynamique autorise l’application de plusieurs filtres croisés dynamiques sur un champ de tableau croisé dynamique donné dans la table.

allowMultipleFiltersPerField: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

columnHierarchies

Les hiérarchies de colonne de tableau croisé dynamique.

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

Valeur de propriété

Excel.RowColumnPivotHierarchyCollection

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");       

    // Check if the PivotTable already has a column.
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

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

dataHierarchies

Les hiérarchies de données de tableau croisé dynamique.

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

Valeur de propriété

Excel.DataPivotHierarchyCollection

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

enableDataValueEditing

Spécifie si le tableau croisé dynamique autorise la modification des valeurs du corps des données par l’utilisateur.

enableDataValueEditing: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

filterHierarchies

Les hiérarchies de filtre de tableau croisé dynamique.

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

Valeur de propriété

Excel.FilterPivotHierarchyCollection

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-filters-and-summaries.yaml

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // Add the Classification hierarchy to the filter, if it's not already there.
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

hierarchies

Les hiérarchies Pivot de tableau croisé dynamique.

readonly hierarchies: Excel.PivotHierarchyCollection;

Valeur de propriété

Excel.PivotHierarchyCollection

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

id

ID du tableau croisé dynamique.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.5 ]

layout

Le PivotLayout décrivant la disposition et la structure visuelle de tableau croisé dynamique.

readonly layout: Excel.PivotLayout;

Valeur de propriété

Excel.PivotLayout

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 pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.layout.load("layoutType");
    await context.sync();

    // Cycle between the three layout types.
    if (pivotTable.layout.layoutType === "Compact") {
        pivotTable.layout.layoutType = "Outline";
    } else if (pivotTable.layout.layoutType === "Outline") {
        pivotTable.layout.layoutType = "Tabular";
    } else {
        pivotTable.layout.layoutType = "Compact";
    }
    await context.sync();
    console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

name

Nom du tableau croisé dynamique.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

refreshOnOpen

Spécifie si le tableau croisé dynamique s’actualise lorsque le classeur s’ouvre. Correspond au paramètre « Actualiser au chargement » dans l’interface utilisateur.

refreshOnOpen: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.13 ]

rowHierarchies

Les hiérarchies de lignes de tableau croisé dynamique.

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

Valeur de propriété

Excel.RowColumnPivotHierarchyCollection

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

useCustomSortLists

Spécifie si le tableau croisé dynamique utilise des listes personnalisées lors du tri.

useCustomSortLists: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

worksheet

Feuille de calcul contenant le tableau croisé dynamique.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

Détails de la méthode

delete()

Supprime le tableau croisé dynamique.

delete(): void;

Retours

void

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) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

getDataSourceString()

Retourne la représentation sous forme de chaîne de la source de données pour le tableau croisé dynamique. Cette méthode prend actuellement en charge les représentations sous forme de chaîne pour les objets de table et de plage. Sinon, elle retourne une chaîne vide.

getDataSourceString(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

[ Ensemble d’API : ExcelApi 1.15 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

getDataSourceType()

Obtient le type de la source de données pour le tableau croisé dynamique.

getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;

Retours

OfficeExtension.ClientResult<Excel.DataSourceType>

Remarques

[ Ensemble d’API : ExcelApi 1.15 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

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.PivotTableLoadOptions): Excel.PivotTable;

Paramètres

options

Excel.Interfaces.PivotTableLoadOptions

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

Retours

Excel.PivotTable

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

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.PivotTable;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

refresh()

Actualise le tableau croisé dynamique.

refresh(): void;

Retours

void

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();
});

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.PivotTableUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.PivotTable): void;

Paramètres

properties

Excel.PivotTable

Retours

void

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 Excel.PivotTable d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.PivotTableDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.PivotTableData;

Retours

Excel.Interfaces.PivotTableData