ExcelScript.PivotLayout interface

Paquet:

ExcelScript

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

Méthodes

getAutoFormat()	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.
getBodyAndTotalRange()	Renvoie la plage où les valeurs de données de tableau croisé dynamique se trouvent.
getColumnLabelRange()	Renvoie la plage où les étiquettes de colonnes 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.
getEnableFieldList()	Spécifie si la liste de champs peut être affichée dans l’interface utilisateur.
getFilterAxisRange()	Renvoie la plage de la zone de filtre de tableau croisé dynamique.
getLayoutType()	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.
getPreserveFormatting()	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.
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.
getShowColumnGrandTotals()	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.
getShowRowGrandTotals()	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.
getSubtotalLocation()	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.
setAutoFormat(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.
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.
setEnableFieldList(enableFieldList)	Spécifie si la liste de champs peut être affichée dans l’interface utilisateur.
setLayoutType(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.
setPreserveFormatting(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.
setShowColumnGrandTotals(showColumnGrandTotals)	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.
setShowRowGrandTotals(showRowGrandTotals)	Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.
setSubtotalLocation(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.

Détails de la méthode

getAutoFormat()

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.

getAutoFormat(): boolean;

Retours

boolean

getBodyAndTotalRange()

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

getBodyAndTotalRange(): Range;

Retours

ExcelScript.Range

Exemples

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

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

getColumnLabelRange(): Range;

Retours

ExcelScript.Range

getDataHierarchy(cell)

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

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

Paramètres

cell

ExcelScript.Range | string

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

Retours

ExcelScript.DataPivotHierarchy

getEnableFieldList()

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

getEnableFieldList(): boolean;

Retours

boolean

getFilterAxisRange()

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

getFilterAxisRange(): Range;

Retours

ExcelScript.Range

getLayoutType()

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.

getLayoutType(): PivotLayoutType;

Retours

ExcelScript.PivotLayoutType

getPreserveFormatting()

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.

getPreserveFormatting(): boolean;

Retours

boolean

getRange()

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

getRange(): Range;

Retours

ExcelScript.Range

getRowLabelRange()

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

getRowLabelRange(): Range;

Retours

ExcelScript.Range

getShowColumnGrandTotals()

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

getShowColumnGrandTotals(): boolean;

Retours

boolean

getShowRowGrandTotals()

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

getShowRowGrandTotals(): boolean;

Retours

boolean

getSubtotalLocation()

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.

getSubtotalLocation(): SubtotalLocationType;

Retours

ExcelScript.SubtotalLocationType

setAutoFormat(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.

setAutoFormat(autoFormat: boolean): void;

Paramètres

autoFormat

boolean

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

Paramètres

cell

ExcelScript.Range | string

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

sortBy

ExcelScript.SortBy

Direction du genre.

Retours

void

setEnableFieldList(enableFieldList)

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

setEnableFieldList(enableFieldList: boolean): void;

Paramètres

enableFieldList

boolean

Retours

void

setLayoutType(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.

setLayoutType(layoutType: PivotLayoutType): void;

Paramètres

layoutType

ExcelScript.PivotLayoutType

Retours

void

Exemples

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

setPreserveFormatting(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.

setPreserveFormatting(preserveFormatting: boolean): void;

Paramètres

preserveFormatting

boolean

Retours

void

setShowColumnGrandTotals(showColumnGrandTotals)

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

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Paramètres

showColumnGrandTotals

boolean

Retours

void

setShowRowGrandTotals(showRowGrandTotals)

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

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Paramètres

showRowGrandTotals

boolean

Retours

void

setSubtotalLocation(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.

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

Paramètres

subtotalLocation

ExcelScript.SubtotalLocationType

Retours

void

Exemples

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}