Partager via

ExcelScript.PivotValueFilter interface

Colis:
ExcelScript

Modèle configurable pour un filtre de valeur à appliquer à un champ de tableau croisé dynamique. Définit les condition critères à définir pour que le filtre fonctionne.

Remarques

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

Propriétés

comparator

Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. Le type de comparaison est défini par la condition . Par exemple, si le comparateur a la valeur « 50 » et que la condition est « greaterThan », toutes les valeurs d’élément qui ne sont pas supérieures à 50 seront supprimées par le filtre.
condition

Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires.
exclusive

Si truela valeur est , le filtre exclut les éléments qui répondent aux critères. La valeur par défaut est false (filtre pour inclure les éléments qui répondent aux critères).
lowerBound

Limite inférieure de la plage pour la condition de between filtre.
selectionType

Spécifie si le filtre concerne les N éléments haut/bas, les N pourcentages supérieurs/bas ou les N premiers/bas.
threshold

Nombre seuil « N » d’éléments, pourcentage ou somme à filtrer pour une condition de filtre supérieure/inférieure.
upperBound

Limite supérieure de la plage pour la condition de between filtre.
value

Nom de la « valeur » choisie dans le champ par lequel filtrer.

Détails de la propriété

comparator

Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. Le type de comparaison est défini par la condition . Par exemple, si le comparateur a la valeur « 50 » et que la condition est « greaterThan », toutes les valeurs d’élément qui ne sont pas supérieures à 50 seront supprimées par le filtre.

comparator?: number;

Valeur de la propriété

number

condition

Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires.

condition: ValueFilterCondition;

Valeur de la propriété

ExcelScript.ValueFilterCondition

exclusive

Si truela valeur est , le filtre exclut les éléments qui répondent aux critères. La valeur par défaut est false (filtre pour inclure les éléments qui répondent aux critères).

exclusive?: boolean;

Valeur de la propriété

boolean

lowerBound

Limite inférieure de la plage pour la condition de between filtre.

lowerBound?: number;

Valeur de la propriété

number

selectionType

Spécifie si le filtre concerne les N éléments haut/bas, les N pourcentages supérieurs/bas ou les N premiers/bas.

selectionType?: TopBottomSelectionType;

Valeur de la propriété

ExcelScript.TopBottomSelectionType

threshold

Nombre seuil « N » d’éléments, pourcentage ou somme à filtrer pour une condition de filtre supérieure/inférieure.

threshold?: number;

Valeur de la propriété

number

upperBound

Limite supérieure de la plage pour la condition de between filtre.

upperBound?: number;

Valeur de la propriété

number

value

Nom de la « valeur » choisie dans le champ par lequel filtrer.

value: string;

Valeur de la propriété

string