Share via

ExcelScript.PivotField interface

  • Référence
Paquet:
ExcelScript

Représente le champ de tableau croisé dynamique Excel.

Méthodes

applyFilter(filter)

Définit un ou plusieurs filtres croisés dynamiques actuels du champ et les applique au champ. Si les filtres fournis ne sont pas valides ou ne peuvent pas être appliqués, une exception est levée.
clearAllFilters()

Efface tous les critères de tous les filtres du champ. Cela supprime tout filtrage actif sur le champ.
clearFilter(filterType)

Efface tous les critères existants du filtre du champ du type donné (le cas échéant).
getFilters()

Obtient tous les filtres actuellement appliqués sur le champ.
getId()

ID du champ de tableau croisé dynamique.
getItems()

Renvoie les pivotItems associés au champ de tableau croisé dynamique.
getName()

Nom du champ PivotField.
getPivotItem(name)

Obtient un pivotItem par nom. Si l’objet PivotItem n’existe pas, cette méthode retourne undefined.
getShowAllItems()

Détermine si vous voulez afficher tous les éléments de PivotField.
getSubtotals()

Sous-totaux du champ PivotField.
isFiltered(filterType)

Vérifie s’il existe des filtres appliqués sur le champ.
setName(name)

Nom du champ PivotField.
setShowAllItems(showAllItems)

Détermine si vous voulez afficher tous les éléments de PivotField.
setSubtotals(subtotals)

Sous-totaux du champ PivotField.
sortByLabels(sortBy)

Trie le PivotField. Si une DataPivotHierarchy est spécifiée, le tri sera appliqué en fonction de celle-ci, sinon le tri sera basé sur le PivotField lui-même.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du même DataPivotHierarchy.

Détails de la méthode

applyFilter(filter)

Définit un ou plusieurs filtres croisés dynamiques actuels du champ et les applique au champ. Si les filtres fournis ne sont pas valides ou ne peuvent pas être appliqués, une exception est levée.

applyFilter(filter: PivotFilters): void;

Paramètres

filter
ExcelScript.PivotFilters

Un PivotFilter spécifique configuré ou une interface PivotFilters contenant plusieurs filtres configurés.

Retours

void

Exemples

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}

clearAllFilters()

Efface tous les critères de tous les filtres du champ. Cela supprime tout filtrage actif sur le champ.

clearAllFilters(): void;

Retours

void

clearFilter(filterType)

Efface tous les critères existants du filtre du champ du type donné (le cas échéant).

clearFilter(filterType: PivotFilterType): void;

Paramètres

filterType
ExcelScript.PivotFilterType

Type de filtre sur le champ dont tous les critères doivent être effacés.

Retours

void

Exemples

/**
 * This script gets the "Type" field from the "Farms Sales" PivotTable 
 * and clears the value filter from it.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the "Type" field.
  const typeField = pivot.getHierarchy("Type").getPivotField("Type");

  // Clear the value filter (if there is one) from the field.
  typeField.clearFilter(ExcelScript.PivotFilterType.value);
}

getFilters()

Obtient tous les filtres actuellement appliqués sur le champ.

getFilters(): PivotFilters;

Retours

ExcelScript.PivotFilters

getId()

ID du champ de tableau croisé dynamique.

getId(): string;

Retours

string

getItems()

Renvoie les pivotItems associés au champ de tableau croisé dynamique.

getItems(): PivotItem[];

Retours

ExcelScript.PivotItem[]

getName()

Nom du champ PivotField.

getName(): string;

Retours

string

getPivotItem(name)

Obtient un pivotItem par nom. Si l’objet PivotItem n’existe pas, cette méthode retourne undefined.

getPivotItem(name: string): PivotItem | undefined;

Paramètres

name

string

Nom de l’objet PivotItem à récupérer.

Retours

ExcelScript.PivotItem | undefined

getShowAllItems()

Détermine si vous voulez afficher tous les éléments de PivotField.

getShowAllItems(): boolean;

Retours

boolean

getSubtotals()

Sous-totaux du champ PivotField.

getSubtotals(): Subtotals;

Retours

ExcelScript.Subtotals

isFiltered(filterType)

Vérifie s’il existe des filtres appliqués sur le champ.

isFiltered(filterType?: PivotFilterType): boolean;

Paramètres

filterType
ExcelScript.PivotFilterType

Type de filtre à case activée. Si aucun type n’est fourni, cette méthode case activée si un filtre est appliqué.

Retours

boolean

setName(name)

Nom du champ PivotField.

setName(name: string): void;

Paramètres

name

string

Retours

void

setShowAllItems(showAllItems)

Détermine si vous voulez afficher tous les éléments de PivotField.

setShowAllItems(showAllItems: boolean): void;

Paramètres

showAllItems

boolean

Retours

void

setSubtotals(subtotals)

Sous-totaux du champ PivotField.

setSubtotals(subtotals: Subtotals): void;

Paramètres

subtotals
ExcelScript.Subtotals

Retours

void

sortByLabels(sortBy)

Trie le PivotField. Si une DataPivotHierarchy est spécifiée, le tri sera appliqué en fonction de celle-ci, sinon le tri sera basé sur le PivotField lui-même.

sortByLabels(sortBy: SortBy): void;

Paramètres

sortBy
ExcelScript.SortBy

Spécifie si le tri est effectué dans l’ordre croissant ou décroissant.

Retours

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du même DataPivotHierarchy.

sortByValues(
            sortBy: SortBy,
            valuesHierarchy: DataPivotHierarchy,
            pivotItemScope?: Array<PivotItem | string>
        ): void;

Paramètres

sortBy
ExcelScript.SortBy

Spécifie si le tri est effectué dans l’ordre croissant ou décroissant.

valuesHierarchy
ExcelScript.DataPivotHierarchy

Spécifie la hiérarchie des valeurs sur l’axe des données à utiliser pour le tri.

pivotItemScope

Array<ExcelScript.PivotItem | string>

Éléments à utiliser pour l’étendue du tri. Il s’agit des éléments qui composent la ligne ou la colonne sur laquelle vous souhaitez trier. Si une chaîne est utilisée à la place d’un pivotItem, la chaîne représente l’ID de l’objet PivotItem. S’il n’y a pas d’éléments autres que la hiérarchie de données sur l’axe sur lequel vous souhaitez trier, cela peut être vide.

Retours

void

Exemples

/**
 * This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}