ExcelScript.PivotLayout interface

Définit si une ligne vide doit être affichée ou non après chaque élément. Il est défini au niveau global pour le tableau croisé dynamique et appliqué à des champs croisés dynamiques individuels. Cette fonction remplace le paramètre de tous les champs du tableau croisé dynamique par la valeur du display paramètre .

displayBlankLineAfterEachItem(display: boolean): void;

Paramètres

Retourne

Description du texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit des représentations textuelles alternatives des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes malvoyantes ou cognitives qui peuvent ne pas être en mesure de voir ou de comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

getAltTextDescription(): string;

Retourne

Titre du texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit des représentations textuelles alternatives des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes malvoyantes ou cognitives qui peuvent ne pas être en mesure de voir ou de comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

getAltTextTitle(): string;

Retourne

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;

Retourne

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

getBodyAndTotalRange(): Range;

Retourne

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

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

getColumnLabelRange(): Range;

Retourne

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

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

Paramètres

Retourne

Texte qui est automatiquement rempli dans une cellule vide du tableau croisé dynamique si fillEmptyCells == true. Notez que cette valeur persiste si fillEmptyCells est défini sur falseet que la définition de cette valeur ne définit pas cette propriété sur true. Par défaut, il s’agit d’une chaîne vide.

getEmptyCellText(): string;

Retourne

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

getEnableFieldList(): boolean;

Retourne

Spécifie si les cellules vides du tableau croisé dynamique doivent être remplies avec le emptyCellText. La valeur par défaut est false. Notez que la valeur de emptyCellText persiste lorsque cette propriété est définie sur false.

getFillEmptyCells(): boolean;

Retourne

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

getFilterAxisRange(): Range;

Retourne

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;

Retourne

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;

Retourne

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

getRange(): Range;

Retourne

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

getRowLabelRange(): Range;

Retourne

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

getShowColumnGrandTotals(): boolean;

Retourne

Spécifie si le tableau croisé dynamique affiche les en-têtes de champ (légendes de champ et listes déroulantes de filtre).

getShowFieldHeaders(): boolean;

Retourne

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

getShowRowGrandTotals(): boolean;

Retourne

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;

Retourne

Définit le paramètre « répéter toutes les étiquettes d’élément » sur tous les champs du tableau croisé dynamique.

repeatAllItemLabels(repeatLabels: boolean): void;

Paramètres

Retourne

Description du texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit des représentations textuelles alternatives des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes malvoyantes ou cognitives qui peuvent ne pas être en mesure de voir ou de comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

setAltTextDescription(altTextDescription: string): void;

Paramètres

Retourne

Titre du texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit des représentations textuelles alternatives des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes malvoyantes ou cognitives qui peuvent ne pas être en mesure de voir ou de comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

setAltTextTitle(altTextTitle: string): void;

Paramètres

Retourne

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

Retourne

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

Retourne

Texte qui est automatiquement rempli dans une cellule vide du tableau croisé dynamique si fillEmptyCells == true. Notez que cette valeur persiste si fillEmptyCells est défini sur falseet que la définition de cette valeur ne définit pas cette propriété sur true. Par défaut, il s’agit d’une chaîne vide.

setEmptyCellText(emptyCellText: string): void;

Paramètres

Retourne

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

setEnableFieldList(enableFieldList: boolean): void;

Paramètres

Retourne

Spécifie si les cellules vides du tableau croisé dynamique doivent être remplies avec le emptyCellText. La valeur par défaut est false. Notez que la valeur de emptyCellText persiste lorsque cette propriété est définie sur false.

setFillEmptyCells(fillEmptyCells: boolean): void;

Paramètres

Retourne

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

Retourne

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

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

Retourne

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

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Paramètres

Retourne

Spécifie si le tableau croisé dynamique affiche les en-têtes de champ (légendes de champ et listes déroulantes de filtre).

setShowFieldHeaders(showFieldHeaders: boolean): void;

Paramètres

Retourne

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

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Paramètres

Retourne

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

Retourne

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