Excel.PivotValueFilter interface
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
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 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 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 |
| lower |
Limite inférieure de la plage pour la condition de |
| selection |
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. |
| upper |
Limite supérieure de la plage pour la condition de |
| 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 propriété
number
Remarques
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
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
lowerBound
Limite inférieure de la plage pour la condition de between filtre.
lowerBound?: number;Valeur de propriété
number
Remarques
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?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";Valeur de propriété
Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"
Remarques
threshold
Nombre seuil « N » d’éléments, pourcentage ou somme à filtrer pour une condition de filtre supérieure/inférieure.
threshold?: number;Valeur de propriété
number
Remarques
upperBound
Limite supérieure de la plage pour la condition de between filtre.
upperBound?: number;Valeur de propriété
number
Remarques
value
Nom de la « valeur » choisie dans le champ par lequel filtrer.
value: string;Valeur de propriété
string