Cette page a été traduite par l'API Cloud Translation.

Class FilterCriteriaBuilder

Pour ajouter des critères à un filtre, procédez comme suit:

Créez le générateur de critères à l'aide de SpreadsheetApp.newFilterCriteria().
Ajoutez des paramètres au compilateur à l'aide des méthodes de cette classe.
Utilisez build() pour assembler les critères avec les paramètres spécifiés.

Utilisations courantes

Masquer les valeurs sur une feuille

L'exemple suivant récupère le filtre existant d'une feuille et ajoute des critères qui masquent les cellules de la colonne C contenant "hello" ou "world". Les critères de cet exemple ne peuvent être utilisés qu'avec des filtres sur des feuilles Grid, le type de feuille par défaut.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
let criteria = SpreadsheetApp.newFilterCriteria()
                             .setHiddenValues(["hello", "world"])
                             .build();
filter.setColumnFilterCriteria(3, criteria);

Afficher uniquement les cellules non vides

L'exemple suivant ajoute un filtre à une feuille DataSource, une feuille connectée à une base de données, avec des critères qui n'affichent que les cellules de la colonne"Category" qui ne sont pas vides.

// Gets the sheet named "Connected sheet," which is connected to a database.
let sheet = SpreadsheetApp.getActiveSpreadsheet()
                          .getSheetByName("Connected sheet")
                          .asDataSourceSheet();
// Creates criteria that only shows non-empty cells.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenCellNotEmpty()
                             .build();
// Applies the criteria to the column named "Category."
sheet.addFilter("Category", criteria);

Méthodes

Méthode	Type renvoyé	Brève description
`build()`	`FilterCriteria`	Assemblage des critères de filtre à l'aide des paramètres que vous ajoutez à l'outil de création de critères
`copy()`	`FilterCriteriaBuilder`	Copie ces critères de filtre et crée un générateur de critères que vous pouvez appliquer à un autre filtre.
`getCriteriaType()`	`BooleanCriteria`	Renvoie le type booléen du critère (par exemple, `CELL_EMPTY`).
`getCriteriaValues()`	`Object[]`	Renvoie un tableau d'arguments pour les critères booléens.
`getHiddenValues()`	`String[]`	Renvoie les valeurs masquées par le filtre.
`getVisibleBackgroundColor()`	`Color`	Affiche la couleur d'arrière-plan utilisée comme critère de filtre.
`getVisibleForegroundColor()`	`Color`	Affiche la couleur de premier plan utilisée comme critère de filtre.
`getVisibleValues()`	`String[]`	Renvoie les valeurs affichées par le filtre du tableau croisé dynamique.
`setHiddenValues(values)`	`FilterCriteriaBuilder`	Définit les valeurs à masquer.
`setVisibleBackgroundColor(visibleBackgroundColor)`	`FilterCriteriaBuilder`	Définit la couleur d'arrière-plan utilisée comme critère de filtre.
`setVisibleForegroundColor(visibleForegroundColor)`	`FilterCriteriaBuilder`	Définit la couleur de premier plan utilisée comme critère de filtre.
`setVisibleValues(values)`	`FilterCriteriaBuilder`	Définit les valeurs à afficher dans un tableau croisé dynamique.
`whenCellEmpty()`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules vides.
`whenCellNotEmpty()`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules qui ne sont pas vides.
`whenDateAfter(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates sont postérieures à la date spécifiée.
`whenDateAfter(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates sont postérieures à la date relative spécifiée.
`whenDateBefore(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates sont antérieures à la date spécifiée.
`whenDateBefore(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates sont antérieures à la date relative spécifiée.
`whenDateEqualTo(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates correspondent à la date spécifiée.
`whenDateEqualTo(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre qui affichent les cellules dont les dates sont égales à la date relative spécifiée.
`whenDateEqualToAny(dates)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont les dates correspondent à l'une des dates spécifiées.
`whenDateNotEqualTo(date)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont les valeurs ne correspondent pas à la date spécifiée.
`whenDateNotEqualToAny(dates)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont les dates ne correspondent à aucune des dates spécifiées.
`whenFormulaSatisfied(formula)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules avec une formule spécifiée (telle que `=B:B<C:C`) dont le résultat de l'évaluation est `true`.
`whenNumberBetween(start, end)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont un nombre est compris entre deux nombres spécifiés ou correspond à l'un des deux.
`whenNumberEqualTo(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre correspond au nombre spécifié.
`whenNumberEqualToAny(numbers)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre est égal à l'un des nombres spécifiés.
`whenNumberGreaterThan(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre est supérieur au nombre spécifié
`whenNumberGreaterThanOrEqualTo(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre est supérieur ou égal au nombre spécifié.
`whenNumberLessThan(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre est inférieur au nombre spécifié.
`whenNumberLessThanOrEqualTo(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre est inférieur ou égal au nombre spécifié.
`whenNumberNotBetween(start, end)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules contenant un nombre inférieur et ne correspondant à aucun des deux nombres spécifiés.
`whenNumberNotEqualTo(number)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre n'est pas égal au nombre spécifié.
`whenNumberNotEqualToAny(numbers)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le nombre n'est pas égal à l'un des nombres spécifiés.
`whenTextContains(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte contient le texte spécifié.
`whenTextDoesNotContain(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte ne contient pas le texte spécifié.
`whenTextEndsWith(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte se termine par le texte spécifié.
`whenTextEqualTo(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte correspond au texte spécifié.
`whenTextEqualToAny(texts)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte correspond à l'une des valeurs textuelles spécifiées.
`whenTextNotEqualTo(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte n'est pas identique au texte spécifié.
`whenTextNotEqualToAny(texts)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte n'est égal à aucune des valeurs spécifiées.
`whenTextStartsWith(text)`	`FilterCriteriaBuilder`	Définit les critères de filtre pour afficher les cellules dont le texte commence par le texte spécifié.
`withCriteria(criteria, args)`	`FilterCriteriaBuilder`	Définit les critères de filtre sur une condition booléenne définie par des valeurs `BooleanCriteria`, telles que `CELL_EMPTY` ou `NUMBER_GREATER_THAN`.

Documentation détaillée

`build()`

Assemblage des critères de filtre à l'aide des paramètres que vous ajoutez à l'outil de création de critères

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
let criteria = SpreadsheetApp.newFilterCriteria() // Creates a criteria builder.
                             .whenCellNotEmpty() // Adds settings to the builder.
                             .build();          // Assembles the criteria.
filter.setColumnFilterCriteria(2, criteria);

Renvois

FilterCriteria : représentation des critères de filtre.

`copy()`

Copie ces critères de filtre et crée un générateur de critères que vous pouvez appliquer à un autre filtre.

Vous pouvez utiliser cette méthode avec n'importe quel type de filtre. Si vous utilisez un filtre de feuille, vous pouvez copier les critères dans une autre colonne.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
let criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any existing
// criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

Renvois

FilterCriteriaBuilder : outil de création de critères de filtre basé sur ce critère de filtre.

`getCriteriaType()`

Renvoie le type booléen du critère (par exemple, CELL_EMPTY). Pour en savoir plus sur les types de critères booléens, consultez l'énumération BooleanCriteria.

Cette méthode est souvent utilisée pour ajouter des critères de condition booléenne à un filtre sans remplacer les critères existants.

Pour obtenir les arguments des critères, utilisez getCriteriaValues().
Pour utiliser le type de critère et les valeurs de critère afin de créer ou de modifier des critères de filtre, consultez withCriteria(criteria, args).

Vous pouvez utiliser cette méthode pour tout type de filtre. Si les critères de filtre ne sont pas une condition booléenne, renvoie null.

let ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
let filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type object.
let criteriaType = filter.getColumnFilterCriteria(2)
                         .getCriteriaType()
                         .toString();
// Logs the criteria type.
console.log(criteriaType);

Renvois

BooleanCriteria : type de critère booléen, ou null si le critère n'est pas une condition booléenne.

`getCriteriaValues()`

Renvoie un tableau d'arguments pour les critères booléens. Certains types de critères booléens ne comportent pas d'arguments et renvoient un tableau vide, par exemple CELL_NOT_EMPTY.

Cette méthode est souvent utilisée pour ajouter des critères de condition booléenne à un filtre sans remplacer les critères existants.

Pour obtenir le type de critère booléen, utilisez getCriteriaType().
Pour créer ou modifier un critère de filtre à l'aide du type et des valeurs de critère, consultez withCriteria(criteria, args).
Vous pouvez utiliser cette méthode pour tout type de filtre.
```
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Gets the values of the boolean criteria and logs them. For example, if the boolean
// condition is whenNumberGreaterThan(10), then the logged value is 10.
let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
console.log(criteriaValues);
```
Renvois

Object[] : tableau d'arguments adaptés au type de critère booléen. Le nombre d'arguments et leur type correspondent à la méthode when...() correspondante de la classe FilterCriteriaBuilder.

`getHiddenValues()`

Renvoie les valeurs masquées par le filtre.

Utilisez ce critère avec des filtres sur Grid feuilles, le type de feuille par défaut. Renvoie null si vous appelez cette méthode pour d'autres types de filtres.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

Renvois

String[] : tableau de valeurs masquées par le filtre.

`getVisibleBackgroundColor()`

Affiche la couleur d'arrière-plan utilisée comme critère de filtre. Les cellules avec cette couleur d'arrière-plan restent visibles.

Utilisez ce critère avec des filtres sur Grid feuilles, le type de feuille par défaut. Renvoie null si vous appelez cette méthode pour d'autres types de filtres.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Logs the background color that column B is filtered by as a hexadecimal string.
let filter = range.getFilter();
let color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Renvois

Color : couleur d'arrière-plan utilisée comme critère de filtre.

`getVisibleForegroundColor()`

Affiche la couleur de premier plan utilisée comme critère de filtre. Les cellules avec cette couleur de premier plan restent visibles.

Utilisez ce critère avec des filtres sur Grid feuilles, le type de feuille par défaut. Renvoie null si vous appelez cette méthode pour d'autres types de filtres.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Logs the foreground color that column B is filtered by as a hexadecimal string.
let filter = range.getFilter();
let color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Renvois

Color : couleur de premier plan utilisée comme critère de filtre.

`getVisibleValues()`

Renvoie les valeurs affichées par le filtre du tableau croisé dynamique.

Ce critère ne s'applique qu'aux filtres des tableaux croisés dynamiques qui ne sont pas connectés à une base de données. Renvoie un tableau vide pour les autres types de filtres.

let ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its first filter.
pivotTable = ss.getPivotTables()[0];
pivotFilterValues = pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

Renvois

String[] : tableau des valeurs affichées par le filtre du tableau croisé dynamique.

`setHiddenValues(values)`

Définit les valeurs à masquer. Efface toutes les valeurs visibles ou masquées existantes.

Vous ne pouvez utiliser ce critère que pour les filtres sur des feuilles Grid, le type de feuille par défaut.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets the values to hide and applies the criteria to column C.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .setHiddenValues(["Hello", "World"])
                             .build();
filter.setColumnFilterCriteria(3, criteria);

Paramètres

Nom	Type	Description
`values`	`String[]`	Liste des valeurs à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`setVisibleBackgroundColor(visibleBackgroundColor)`

Définit la couleur d'arrière-plan utilisée comme critère de filtre. Les cellules avec cette couleur d'arrière-plan restent visibles. La définition d'un critère de filtre de couleur d'arrière-plan supprime tous les critères de filtre de couleur actuels de ce compilateur.

Vous ne pouvez utiliser ce critère que pour les filtres sur des feuilles Grid, le type de feuille par défaut.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that filters by background color and sets it to column B.
let color = SpreadsheetApp.newColor().setRgbColor("#185ABC").build();
let criteria = SpreadsheetApp.newFilterCriteria()
                             .setVisibleBackgroundColor(color)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`visibleBackgroundColor`	`Color`	Couleur d'arrière-plan à définir. La couleur doit être de type RVB. Cette méthode n'est pas compatible avec les couleurs du thème.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`setVisibleForegroundColor(visibleForegroundColor)`

Définit la couleur de premier plan utilisée comme critère de filtre. Les cellules avec cette couleur de premier plan restent visibles. La définition d'un critère de filtre de couleur de premier plan supprime tous les critères de filtre de couleur actuels de ce compilateur.

Vous ne pouvez utiliser ce critère que pour les filtres sur des feuilles Grid, le type de feuille par défaut.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that filters by foreground color and sets it to column B.
let color = SpreadsheetApp.newColor().setRgbColor("#185ABC").build();
let criteria = SpreadsheetApp.newFilterCriteria()
                             .setVisibleForegroundColor(color)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`visibleForegroundColor`	`Color`	Couleur de premier plan à définir. La couleur doit être de type RVB. Cette méthode n'est pas compatible avec les couleurs du thème.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`setVisibleValues(values)`

Définit les valeurs à afficher dans un tableau croisé dynamique. Efface toutes les valeurs visibles ou masquées existantes.

Vous ne pouvez utiliser ce critère que pour les filtres appliqués aux tableaux croisés dynamiques qui ne sont pas connectés à une base de données.

// Gets the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet and adds a filter to it that
// sets the visible values to "Northeast" and "Southwest."
let pivotTable = ss.getPivotTables()[0];
let criteria = SpreadsheetApp.newFilterCriteria()
                             .setVisibleValues(["Northeast", "Southwest"])
                             .build();
pivotTable.addFilter(2, criteria);

Paramètres

Nom	Type	Description
`values`	`String[]`	Liste des valeurs à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenCellEmpty()`

Définit les critères de filtre pour afficher les cellules vides.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets criteria to column B that only shows empty cells.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenCellEmpty()
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenCellNotEmpty()`

Définit les critères de filtre pour afficher les cellules qui ne sont pas vides.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Sets criteria to column B that only shows cells that aren't empty.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenCellNotEmpty()
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateAfter(date)`

Définit les critères de filtre qui affichent les cellules dont les dates sont postérieures à la date spécifiée.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être une date. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez ne doit pas nécessairement être une date. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates after June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateAfter(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`Date`	Date limite à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateAfter(date)`

Définit les critères de filtre qui affichent les cellules dont les dates sont postérieures à la date relative spécifiée. Pour afficher les options de date relative, reportez-vous à l'énumération RelativeDate.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates after today's date
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.TODAY;
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateAfter(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`RelativeDate`	Date relative la plus récente.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateBefore(date)`

Définit les critères de filtre qui affichent les cellules dont les dates sont antérieures à la date spécifiée.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates before June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateBefore(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`Date`	Date la plus proche à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateBefore(date)`

Définit les critères de filtre qui affichent les cellules dont les dates sont antérieures à la date relative spécifiée. Pour afficher les options de date relative, reportez-vous à l'énumération RelativeDate.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates before today's date
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.TODAY;
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateBefore(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`RelativeDate`	Date relative la plus proche à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateEqualTo(date)`

Définit les critères de filtre qui affichent les cellules dont les dates correspondent à la date spécifiée.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates equal to June 1, 2022
// and sets it to column A.
let date = new Date("June 1, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateEqualTo(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`Date`	Date à laquelle les valeurs des cellules doivent correspondre.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateEqualTo(date)`

Définit les critères de filtre qui affichent les cellules dont les dates sont égales à la date relative spécifiée. Pour afficher les options de date relative, reportez-vous à l'énumération RelativeDate.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Creates criteria that only shows cells with dates that fall within the past month
// and sets it to column A.
let date = SpreadsheetApp.RelativeDate.PAST_MONTH;
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateEqualTo(date)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`date`	`RelativeDate`	Date relative à laquelle les valeurs des cellules doivent correspondre.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateEqualToAny(dates)`

Définit les critères de filtre pour afficher les cellules dont les dates correspondent à l'une des dates spécifiées.

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ce critère avec des filtres sur une feuille DataSource, une feuille connectée à une base de données, ou un DataSourcePivotTable, un tableau croisé dynamique créé à partir d'une feuille DataSource.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that shows cells with any of the below dates.
let date1 = new Date("June 1, 2022");
let date2 = new Date("June 2, 2022");
let date3 = new Date("June 3, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateEqualToAny([date1, date2, date3])
                             .build();
dataSheet.addFilter("date", criteria);

Paramètres

Nom	Type	Description
`dates`	`Date[]`	Dates à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateNotEqualTo(date)`

Définit les critères de filtre pour afficher les cellules dont les valeurs ne correspondent pas à la date spécifiée.

Le type de données de la colonne que vous filtrez doit être une date.

// Gets a pivot table that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Pivot Table Sheet");
let dataPivotTable = ss.getDataSourcePivotTables()[0];
// Creates criteria that only shows cells that don't equal June 16, 2022
// and sets it to the "date" column.
let date = new Date("June 16, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateNotEqualTo(date)
                             .build();
dataPivotTable.addFilter("date", criteria);

Paramètres

Nom	Type	Description
`date`	`Date`	Date à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenDateNotEqualToAny(dates)`

Définit les critères de filtre pour afficher les cellules dont les dates ne correspondent à aucune des dates spécifiées.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that hides cells with any of the below dates.
let date1 = new Date("June 1, 2022");
let date2 = new Date("June 2, 2022");
let date3 = new Date("June 3, 2022");
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenDateNotEqualToAny([date1, date2, date3])
                             .build();
dataSheet.addFilter("date", criteria);

Paramètres

Nom	Type	Description
`dates`	`Date[]`	Dates à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenFormulaSatisfied(formula)`

Définit les critères de filtre pour afficher les cellules avec une formule spécifiée (telle que =B:B<C:C) dont le résultat de l'évaluation est true.

Vous ne pouvez utiliser ce critère que pour filtrer les données qui ne sont pas connectées à une base de données.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows the rows where the value in column B is less than the value in
// column C and sets it to column A.
let formula = "=B:B<C:C";
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenFormulaSatisfied(formula)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`formula`	`String`	Formule personnalisée qui renvoie la valeur `true` si l'entrée est valide.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberBetween(start, end)`

Définit les critères de filtre pour afficher les cellules dont un nombre est compris entre deux nombres spécifiés ou correspond à l'un des deux.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that only shows cells with numbers that fall between 1-25, inclusively,
// and sets it to column A.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberBetween(1, 25)
                             .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Nom	Type	Description
`start`	`Number`	Nombre le plus faible à afficher.
`end`	`Number`	Nombre le plus élevé à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberEqualTo(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre correspond au nombre spécifié.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that only shows cells that are equal to 25 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberEqualTo(25)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Numéro à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberEqualToAny(numbers)`

Définit les critères de filtre pour afficher les cellules dont le nombre est égal à l'un des nombres spécifiés.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that only shows cells with the number 10, 20, or 30.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberEqualToAny([10,20,30])
                             .build();
dataSheet.addFilter("amount", criteria);

Paramètres

Nom	Type	Description
`numbers`	`Number[]`	Nombres à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberGreaterThan(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre est supérieur au nombre spécifié

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells greater than 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberGreaterThan(10)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Nombre le plus élevé à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberGreaterThanOrEqualTo(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre est supérieur ou égal au nombre spécifié.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells greater than or equal to 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberGreaterThanOrEqualTo(10)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Nombre le plus faible à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberLessThan(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre est inférieur au nombre spécifié.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells less than 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberLessThan(10)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Nombre le plus bas à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberLessThanOrEqualTo(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre est inférieur ou égal au nombre spécifié.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells less than or equal to 10 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberLessThanOrEqualTo(10)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Nombre le plus élevé à afficher.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberNotBetween(start, end)`

Définit les critères de filtre pour afficher les cellules contenant un nombre inférieur et ne correspondant à aucun des deux nombres spécifiés.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells with numbers that fall between 1-25, inclusively,
// and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberNotBetween(1, 25)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`start`	`Number`	Le nombre le plus bas est masqué.
`end`	`Number`	Nombre le plus élevé à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberNotEqualTo(number)`

Définit les critères de filtre pour afficher les cellules dont le nombre n'est pas égal au nombre spécifié.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre. Si vous utilisez ces critères avec des données connectées à une base de données, le type de données de la colonne que vous filtrez doit être un nombre. Si les données ne sont pas connectées à une base de données, le type de données de la colonne que vous filtrez n'a pas besoin d'être un nombre. Si ce n'est pas le cas, vous pouvez obtenir des résultats inattendus.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells that are equal to 25 and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberNotEqualTo(25)
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`number`	`Number`	Numéro à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenNumberNotEqualToAny(numbers)`

Définit les critères de filtre pour afficher les cellules dont le nombre n'est pas égal à l'un des nombres spécifiés.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that hides cells with the number 10, 20, or 30.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenNumberNotEqualToAny([10,20,30])
                             .build();
dataSheet.addFilter("amount", criteria);

Paramètres

Nom	Type	Description
`numbers`	`Number[]`	Numéros à masquer.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextContains(text)`

Définit les critères de filtre pour afficher les cellules dont le texte contient le texte spécifié. Le texte n'est pas sensible à la casse.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells that contain "Northwest" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextContains("Northwest")
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte que la cellule doit contenir.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextDoesNotContain(text)`

Définit les critères de filtre pour afficher les cellules dont le texte ne contient pas le texte spécifié. Le texte n'est pas sensible à la casse.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that hides cells that contain "Northwest" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextDoesNotContain("Northwest")
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte que la cellule ne doit pas contenir.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextEndsWith(text)`

Définit les critères de filtre pour afficher les cellules dont le texte se termine par le texte spécifié. Le texte n'est pas sensible à la casse.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that ends with "est" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextEndsWith("est")
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte que la fin du texte de la cellule doit contenir.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextEqualTo(text)`

Définit les critères de filtre pour afficher les cellules dont le texte correspond au texte spécifié. Le texte n'est pas sensible à la casse.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that equals "hello" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextEqualTo("hello")
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte auquel le texte de la cellule doit correspondre.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextEqualToAny(texts)`

Définit les critères de filtre pour afficher les cellules dont le texte correspond à l'une des valeurs textuelles spécifiées. Le texte n'est pas sensible à la casse.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that shows cells with the text "tech" or "business."
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextEqualToAny(["tech","business"])
                             .build();
dataSheet.addFilter("category", criteria);

Paramètres

Nom	Type	Description
`texts`	`String[]`	Valeurs textuelles auxquelles une cellule doit être égale.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextNotEqualTo(text)`

Définit les critères de filtre pour afficher les cellules dont le texte n'est pas identique au texte spécifié. Le texte n'est pas sensible à la casse.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with text equal to "tech."
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextNotEqualTo("tech")
                             .build();
dataSheet.addFilter("category", criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte que le texte de la cellule ne peut pas comporter.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextNotEqualToAny(texts)`

Définit les critères de filtre pour afficher les cellules dont le texte n'est égal à aucune des valeurs spécifiées. Le texte n'est pas sensible à la casse.

// Gets the sheet that's connected to a database.
let ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Data Sheet");
let dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with the text "tech" or "business."
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextNotEqualToAny(["tech","business"])
                             .build();
dataSheet.addFilter("category", criteria);

Paramètres

Nom	Type	Description
`texts`	`String[]`	Valeurs textuelles qu'une cellule ne peut pas égaler.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`whenTextStartsWith(text)`

Définit les critères de filtre pour afficher les cellules dont le texte commence par le texte spécifié. Le texte n'est pas sensible à la casse.

Vous pouvez utiliser ces critères avec n'importe quel type de filtre.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Creates criteria that shows cells with text that starts with "pre" and sets it to column B.
let criteria = SpreadsheetApp.newFilterCriteria()
                             .whenTextStartsWith("pre")
                             .build();
filter.setColumnFilterCriteria(2, criteria);

Paramètres

Nom	Type	Description
`text`	`String`	Texte que le début du texte de la cellule doit contenir.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.

`withCriteria(criteria, args)`

Définit les critères de filtre sur une condition booléenne définie par des valeurs BooleanCriteria, telles que CELL_EMPTY ou NUMBER_GREATER_THAN. Pour copier la condition booléenne à partir de critères existants, définissez les paramètres de cette méthode à l'aide de getCriteriaType() et getCriteriaValues() sur un critère existant.

Vous pouvez utiliser ce critère avec n'importe quel type de filtre, mais certaines BooleanCriteria ne sont pas applicables à tous les filtres.

// Builds a filter criteria that is based on existing boolean conditions from another criteria.
// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Gets the existing boolean conditions applied to Column B and adds criteria to column C that
// has the same boolean conditions and additional criteria that hides the value, "Northwest."
let filter = ss.getFilter();
let filterCriteria = filter.getColumnFilterCriteria(2);
let criteria = SpreadsheetApp.newFilterCriteria()
    .withCriteria(filterCriteria.getCriteriaType(), filterCriteria.getCriteriaValues())
    .setHiddenValues(["Northwest"])
    .build();
filter.setColumnFilterCriteria(3, criteria);

Paramètres

Nom	Type	Description
`criteria`	`BooleanCriteria`	Type de critère booléen.
`args`	`Object[]`	Tableau d'arguments adapté au type de critère. Le nombre d'arguments et leur type correspondent aux méthodes `when...()` correspondantes ci-dessus.

Renvois

FilterCriteriaBuilder : compilateur pour le chaînage.