Excel.PivotLayout class

Référence

Paquet:: excel

Représente la disposition visuelle du tableau croisé dynamique.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

autoFormat	Spécifie si la mise en forme est automatiquement mise en forme lorsqu’elle est actualisée ou lorsque les champs sont déplacés.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
enableFieldList	Spécifie si la liste de champs peut être affichée dans l’interface utilisateur.
layoutType	Cette propriété indique le PivotLayoutType de tous les champs sur le tableau croisé dynamique. Si les champs ont des états différents, la valeur sera null.
preserveFormatting	Spécifie si la mise en forme est conservée lorsque le rapport est actualisé ou recalculé par des opérations telles que le tableau croisé dynamique, le tri ou la modification d’éléments de champ de page.
showColumnGrandTotals	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.
showRowGrandTotals	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.
subtotalLocation	Cette propriété indique le `SubtotalLocationType` de tous les champs du tableau croisé dynamique. Si les champs ont des états différents, il s’agit de `null`.

Méthodes

getColumnLabelRange()	Renvoie la plage où les étiquettes de colonnes de tableau croisé dynamique se trouvent.
getDataBodyRange()	Renvoie la plage où les valeurs de données de tableau croisé dynamique se trouvent.
getDataHierarchy(cell)	Obtient DataHierarchy servant à calculer la valeur dans une plage spécifiée dans le tableau croisé dynamique.
getFilterAxisRange()	Renvoie la plage de la zone de filtre de tableau croisé dynamique.
getPivotItems(axis, cell)	Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.
getPivotItems(axisString, cell)	Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.
getRange()	Renvoie la plage sur laquelle le tableau croisé dynamique existe, à l’exception de la zone de filtre.
getRowLabelRange()	Renvoie la plage où les étiquettes de lignes de tableau croisé dynamique se trouvent.
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.
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.
setAutoSortOnCell(cell, sortBy)	Définit le tableau croisé dynamique pour trier automatiquement à l’aide de la cellule spécifiée pour sélectionner automatiquement tous les critères et contexte nécessaires. Cela se comporte de la même manière que d’appliquer un tri automatique de l’interface utilisateur.
setAutoSortOnCell(cell, sortByString)	Définit le tableau croisé dynamique pour trier automatiquement à l’aide de la cellule spécifiée pour sélectionner automatiquement tous les critères et contexte nécessaires. Cela se comporte de la même manière que d’appliquer un tri automatique de l’interface utilisateur.
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.PivotLayout` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Excel.Interfaces.PivotLayoutData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

autoFormat

Spécifie si la mise en forme est automatiquement mise en forme lorsqu’elle est actualisée ou lorsque les champs sont déplacés.

autoFormat: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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

enableFieldList

Spécifie si la liste de champs peut être affichée dans l’interface utilisateur.

enableFieldList: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

layoutType

Cette propriété indique le PivotLayoutType de tous les champs sur le tableau croisé dynamique. Si les champs ont des états différents, la valeur sera null.

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Valeur de propriété

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

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-pivotlayout.yaml

await Excel.run(async (context) => {
  // Change the PivotLayout.type to a new type.
  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);
});

preserveFormatting

Spécifie si la mise en forme est conservée lorsque le rapport est actualisé ou recalculé par des opérations telles que le tableau croisé dynamique, le tri ou la modification d’éléments de champ de page.

preserveFormatting: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

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

await Excel.run(async (context) => {
  // Set whether the PivotTable keeps the established format after it is refreshed and recalculated.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load("preserveFormatting");
  await context.sync();

  let preserveFormattingToSet = !pivotLayout.preserveFormatting;
  console.log(`Preserve the formatting PivotTable after a refresh? - ${preserveFormattingToSet}`);

  pivotLayout.preserveFormatting = preserveFormattingToSet;
  await context.sync();
});

showColumnGrandTotals

Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.

showColumnGrandTotals: boolean;

Valeur de propriété

boolean

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-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

showRowGrandTotals

Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.

showRowGrandTotals: boolean;

Valeur de propriété

boolean

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-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

subtotalLocation

Cette propriété indique le SubtotalLocationType de tous les champs du tableau croisé dynamique. Si les champs ont des états différents, il s’agit de null.

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Valeur de propriété

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Détails de la méthode

getColumnLabelRange()

Renvoie la plage où les étiquettes de colonnes de tableau croisé dynamique se trouvent.

getColumnLabelRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getDataBodyRange()

Renvoie la plage où les valeurs de données de tableau croisé dynamique se trouvent.

getDataBodyRange(): Excel.Range;

Retours

Excel.Range

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

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

    // The layout controls the ranges used by the PivotTable.
    const range = pivotTable.layout.getDataBodyRange();

    // Get all the data hierarchy totals.
    const grandTotalRange = range.getLastRow();
    grandTotalRange.load("address");
    await context.sync();
    
    // Use the wholesale and farm sale totals to make a final sum.
    const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27");
    masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]];
    await context.sync();
});

getDataHierarchy(cell)

Obtient DataHierarchy servant à calculer la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Paramètres

cell: Excel.Range | string

Cellule unique dans le corps de données du tableau croisé dynamique.

Retours

Excel.DataPivotHierarchy

Objet DataPivotHierarchy utilisé pour calculer la valeur dans la cellule spécifiée.

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getFilterAxisRange()

Renvoie la plage de la zone de filtre de tableau croisé dynamique.

getFilterAxisRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getPivotItems(axis, cell)

Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Paramètres

axis: Excel.PivotAxis

Axe à partir duquel obtenir les éléments croisés dynamiques. Doit être « row » ou « column ».

cell: Excel.Range | string

Cellule unique dans le corps des données du tableau croisé dynamique.

Retours

Excel.PivotItemCollection

PivotItemCollection des pivotitems utilisés pour calculer les valeurs de la ligne spécifiée.

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPivotItems(axisString, cell)

Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getPivotItems(axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Paramètres

axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter"

Axe à partir duquel obtenir les éléments croisés dynamiques. Doit être « row » ou « column ».

cell: Excel.Range | string

Cellule unique dans le corps des données du tableau croisé dynamique.

Retours

Excel.PivotItemCollection

PivotItemCollection des pivotitems utilisés pour calculer les valeurs de la ligne spécifiée.

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getRange()

Renvoie la plage sur laquelle le tableau croisé dynamique existe, à l’exception de la zone de filtre.

getRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

getRowLabelRange()

Renvoie la plage où les étiquettes de lignes de tableau croisé dynamique se trouvent.

getRowLabelRange(): Excel.Range;

Retours

Excel.Range

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.PivotLayoutLoadOptions): Excel.PivotLayout;

Paramètres

options: Excel.Interfaces.PivotLayoutLoadOptions

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

Retours

Excel.PivotLayout

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

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

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

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

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.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Excel.Interfaces.PivotLayoutUpdateData

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.PivotLayout): void;

Paramètres

properties: Excel.PivotLayout

Retours

void

setAutoSortOnCell(cell, sortBy)

Définit le tableau croisé dynamique pour trier automatiquement à l’aide de la cellule spécifiée pour sélectionner automatiquement tous les critères et contexte nécessaires. Cela se comporte de la même manière que d’appliquer un tri automatique de l’interface utilisateur.

setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;

Paramètres

cell: Excel.Range | string

Une seule cellule à utiliser pour obtenir les critères à partir de pour appliquer le tri automatique.

sortBy: Excel.SortBy

Direction du genre.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

setAutoSortOnCell(cell, sortByString)

setAutoSortOnCell(cell: Range | string, sortByString: "Ascending" | "Descending"): void;

Paramètres

cell: Excel.Range | string

Une seule cellule à utiliser pour obtenir les critères à partir de pour appliquer le tri automatique.

sortByString: "Ascending" | "Descending"

Direction du genre.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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

toJSON(): Excel.Interfaces.PivotLayoutData;

Retours

Excel.Interfaces.PivotLayoutData

Partager via

Excel.PivotLayout class

Remarques

Propriétés

Méthodes

Détails de la propriété

autoFormat

Valeur de propriété

Remarques

context

Valeur de propriété

enableFieldList

Valeur de propriété

Remarques

layoutType

Valeur de propriété

Remarques

Exemples

preserveFormatting

Valeur de propriété

Remarques

Exemples

showColumnGrandTotals

Valeur de propriété

Remarques

Exemples

showRowGrandTotals

Valeur de propriété

Remarques

Exemples

subtotalLocation

Valeur de propriété

Remarques

Détails de la méthode

getColumnLabelRange()

Retours

Remarques

getDataBodyRange()

Retours

Remarques

Exemples

getDataHierarchy(cell)

Paramètres

Retours

Remarques

getFilterAxisRange()

Retours

Remarques

getPivotItems(axis, cell)

Paramètres

Retours

Remarques

getPivotItems(axisString, cell)

Paramètres

Retours

Remarques

getRange()

Retours

Remarques

getRowLabelRange()

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

set(properties, options)

Paramètres

Retours

set(properties)

Paramètres

Retours

setAutoSortOnCell(cell, sortBy)

Paramètres

Retours