ExcelScript.PivotLabelFilter interface

Paquet:

ExcelScript

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

Remarques

Exemples

/**
 * This script filters items that start with "L" from the "Type" field
 * of the "Farm Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable.
  const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");

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

  // Filter out any types that start with "L" (such as "Lemons" and "Limes").
  const filter: ExcelScript.PivotLabelFilter = {
    condition: ExcelScript.LabelFilterCondition.beginsWith,
    substring: "L",
    exclusive: true
  };

  // Apply the label filter to the field.
  field.applyFilter({ labelFilter: filter });
}

Propriétés

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. Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.
substring	Sous-chaîne utilisée pour les conditions de beginsWithfiltre , endsWithet contains .
upperBound	Limite supérieure de la plage pour la condition de between filtre. Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.

Détails de la propriété

condition

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

condition: LabelFilterCondition;

Valeur de propriété

ExcelScript.LabelFilterCondition

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 propriété

boolean

lowerBound

Limite inférieure de la plage pour la condition de between filtre. Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.

lowerBound?: string;

Valeur de propriété

string

substring

Sous-chaîne utilisée pour les conditions de beginsWithfiltre , endsWithet contains .

substring?: string;

Valeur de propriété

string

upperBound

Limite supérieure de la plage pour la condition de between filtre. Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.

upperBound?: string;

Valeur de propriété

string