Partager via


ExcelScript.FilterCriteria interface

Représente les critères de filtrage appliqués à une colonne.

Propriétés

color

Chaîne de couleur HTML utilisée pour filtrer des cellules. Utilisé avec cellColor et fontColor le filtrage.

criterion1

Premier critère utilisé pour filtrer des données. Utilisé en tant qu’opérateur dans le cas du custom filtrage. Par exemple, «> 50 » pour les nombres supérieurs à 50 ou « =*s » pour les valeurs se terminant par « s ».

Utilisé comme nombre dans le cas d’éléments/pourcentages supérieurs/inférieurs (par exemple, « 5 » pour les 5 premiers éléments si filterOn est défini sur topItems).

criterion2

Second critère utilisé pour filtrer des données. Utilisé uniquement comme opérateur dans le cas d’un custom filtrage.

dynamicCriteria

Critères dynamiques de l’ensemble ExcelScript.DynamicFilterCriteria à appliquer à cette colonne. Utilisé avec dynamic le filtrage.

filterOn

Propriété utilisée par le filtre pour déterminer si les valeurs doivent rester visibles.

icon

Icône utilisée pour filtrer des cellules. Utilisé avec icon le filtrage.

operator

Opérateur utilisé pour combiner les critères 1 et 2 lors de l’utilisation custom du filtrage.

subField

Propriété utilisée par le filtre pour effectuer un filtre enrichi sur des valeurs riches.

values

Ensemble de valeurs à utiliser dans le cadre du values filtrage.

Détails de la propriété

color

Chaîne de couleur HTML utilisée pour filtrer des cellules. Utilisé avec cellColor et fontColor le filtrage.

color?: string;

Valeur de propriété

string

criterion1

Premier critère utilisé pour filtrer des données. Utilisé en tant qu’opérateur dans le cas du custom filtrage. Par exemple, «> 50 » pour les nombres supérieurs à 50 ou « =*s » pour les valeurs se terminant par « s ».

Utilisé comme nombre dans le cas d’éléments/pourcentages supérieurs/inférieurs (par exemple, « 5 » pour les 5 premiers éléments si filterOn est défini sur topItems).

criterion1?: string;

Valeur de propriété

string

Exemples

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values 
 * (of column C values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the lowest 10 values in column C
  // (index 2, assuming the used range spans from at least A:C).
  const filterCriteria: ExcelScript.FilterCriteria = {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.bottomItems
  };
  currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
}

criterion2

Second critère utilisé pour filtrer des données. Utilisé uniquement comme opérateur dans le cas d’un custom filtrage.

criterion2?: string;

Valeur de propriété

string

dynamicCriteria

Critères dynamiques de l’ensemble ExcelScript.DynamicFilterCriteria à appliquer à cette colonne. Utilisé avec dynamic le filtrage.

dynamicCriteria?: DynamicFilterCriteria;

Valeur de propriété

filterOn

Propriété utilisée par le filtre pour déterminer si les valeurs doivent rester visibles.

filterOn: FilterOn;

Valeur de propriété

icon

Icône utilisée pour filtrer des cellules. Utilisé avec icon le filtrage.

icon?: Icon;

Valeur de propriété

operator

Opérateur utilisé pour combiner les critères 1 et 2 lors de l’utilisation custom du filtrage.

operator?: FilterOperator;

Valeur de propriété

subField

Propriété utilisée par le filtre pour effectuer un filtre enrichi sur des valeurs riches.

subField?: string;

Valeur de propriété

string

values

Ensemble de valeurs à utiliser dans le cadre du values filtrage.

values?: Array<string | FilterDatetime>;

Valeur de propriété

Array<string | ExcelScript.FilterDatetime>