Excel.PivotLabelFilter interface

Paquet:
excel

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

Ensemble d’API : ExcelApi 1.12

Utilisateur

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml

await Excel.run(async (context) => {
  // Add a PivotFilter to filter based on the strings of item labels.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

  // Get the "Type" field.
  const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type");

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

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

  await context.sync();
});

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 . Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.
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é

comparator

Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. Le type de comparaison est défini par la condition . Remarque : Une chaîne numérique est traitée comme un nombre lorsqu’elle est comparée à d’autres chaînes numériques.

comparator?: string;

Valeur de propriété

string

Remarques

Ensemble d’API : ExcelApi 1.12

condition

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

condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between";

Valeur de propriété

Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"

Remarques

Ensemble d’API : ExcelApi 1.12

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

Remarques

Ensemble d’API : ExcelApi 1.12

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

Remarques

Ensemble d’API : ExcelApi 1.12

substring

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

substring?: string;

Valeur de propriété

string

Remarques

Ensemble d’API : ExcelApi 1.12

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

Remarques

Ensemble d’API : ExcelApi 1.12