Excel.PivotValueFilter interface

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

Remarques

Jeu 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 on the values correlated with a row.

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

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

  // Filter to only include rows with more than 500 wholesale crates sold.
  const filter: Excel.PivotValueFilter = {
    condition: Excel.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: "Sum of Crates Sold Wholesale"
  };

  // Apply the value filter to the field.
  field.applyFilter({ valueFilter: 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. Par exemple, si le comparateur est « 50 » et la condition est « supérieur à », toutes les valeurs d’élément infé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 true, le filtre exclut les éléments qui répondent aux critères. La valeur par défaut est false (filtrez 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

Indique si le filtre est destiné aux N éléments supérieurs/inférieurs, aux N pourcentages supérieurs/inférieurs ou aux N éléments supérieurs/inférieurs.

threshold

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

upperBound

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

value

Nom de la « valeur » choisie dans le champ de filtrage.

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 est « 50 » et la condition est « supérieur à », toutes les valeurs d’élément inférieures à 50 seront supprimées par le filtre.

comparator?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.12

condition

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

condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";

Valeur de propriété

Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"

Remarques

Jeu d’API : ExcelApi 1.12

exclusive

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

exclusive?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.12

lowerBound

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

lowerBound?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.12

selectionType

Indique si le filtre est destiné aux N éléments supérieurs/inférieurs, aux N pourcentages supérieurs/inférieurs ou aux N éléments supérieurs/inférieurs.

selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";

Valeur de propriété

Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"

Remarques

Jeu d’API : ExcelApi 1.12

threshold

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

threshold?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.12

upperBound

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

upperBound?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.12

value

Nom de la « valeur » choisie dans le champ de filtrage.

value: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.12