Class FilterCriteriaBuilder

Assemble les critères de filtre à l'aide des paramètres que vous ajoutez au générateur de critères.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
const 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 filtrage.

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.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const 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 : un outil de création de critères de filtre basé sur ces critères de filtre.

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.

Les utilisateurs ont souvent recours à cette méthode 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 et les valeurs de critères afin de créer ou de modifier des critères de filtre, consultez withCriteria(criteria, args).

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

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

Renvois

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

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

Les utilisateurs ont souvent recours à cette méthode 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 utiliser le type et les valeurs de critères afin de créer ou de modifier des critères de filtre, consultez withCriteria(criteria, args).

  Vous pouvez utiliser cette méthode pour n'importe quel type de filtre.

  const ss = SpreadsheetApp.getActiveSheet();
  const 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.
  const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
  console.log(criteriaValues);

  Renvois

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

Renvoie les valeurs que le filtre masque.

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

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

Renvois

String[] : tableau de valeurs que le filtre masque.

Renvoie 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 dans les feuilles Grid, qui sont le type de feuille par défaut. Renvoie null si vous appelez cette méthode pour d'autres types de filtres.

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

Renvois

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

Renvoie 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 dans les feuilles Grid, qui sont le type de feuille par défaut. Renvoie null si vous appelez cette méthode pour d'autres types de filtres.

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

Renvois

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

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.

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

Renvois

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

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 des feuilles Grid, qui sont le type de feuille par défaut.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Génère

Error : si l'une des valeurs est null.

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. Si vous définissez des critères de filtre de couleur d'arrière-plan, tous les critères de filtre de couleur actuels seront supprimés de ce générateur.

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit la couleur de premier plan utilisée comme critère de filtre. Les cellules avec cette couleur de premier plan restent visibles. Si vous définissez des critères de filtre de couleur de premier plan, tous les critères de filtre de couleur actuels seront supprimés de ce générateur.

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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 des 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."
const pivotTable = ss.getPivotTables()[0];
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setVisibleValues(['Northeast', 'Southwest'])
                     .build();
pivotTable.addFilter(2, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Génère

Error : si l'une des valeurs est null.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre.

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

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre.

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

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit des critères de filtre qui affichent les cellules contenant des dates postérieures à la date relative spécifiée. Pour afficher les options de date relative, consultez Enum RelativeDate.

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

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

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit des critères de filtre qui affichent les cellules contenant des dates antérieures à la date relative spécifiée. Pour afficher les options de date relative, consultez Enum RelativeDate.

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

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

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit des 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, consultez Enum RelativeDate.

Vous pouvez utiliser ce critère avec n'importe quel type de filtre. Si vous utilisez ce critère avec des données associées à une base de données, le type de données de la colonne selon laquelle vous filtrez doit être une date. Si les données ne sont pas associées à une base de données, le type de données de la colonne selon laquelle vous filtrez n'a pas besoin d'être une date. Toutefois, si ce n'est pas le cas, vous risquez d'obtenir des résultats inattendus.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates that fall within the past
// month and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualTo(SpreadsheetApp.RelativeDate.PAST_MONTH)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage pour afficher les cellules dont les dates sont égales à 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 ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that shows cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage pour afficher les cellules dont la valeur n'est pas égale à la date spécifiée.

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage pour afficher les cellules dont les dates ne sont pas égales à 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 ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that hides cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateNotEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtre pour afficher les cellules contenant une formule spécifiée (par exemple, =B:B<C:C) qui renvoie la valeur 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();
const 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.
const formula = '=B:B<C:C';
const criteria =
    SpreadsheetApp.newFilterCriteria().whenFormulaSatisfied(formula).build();
filter.setColumnFilterCriteria(1, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that only shows cells with the number
// 10, 20, or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage pour afficher les cellules dont le nombre est supérieur à celui spécifié

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage pour afficher les cellules dont le nombre ne se situe pas entre deux nombres spécifiés et n'est égal à aucun d'eux.

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

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

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that hides cells with the number 10, 20,
// or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberNotEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtrage 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 ce critère avec n'importe quel type de filtre.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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 ce critère avec n'importe quel type de filtre.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that shows cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with text equal to
// "tech."
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextNotEqualTo('tech').build();
dataSheet.addFilter('category', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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.

Vous ne pouvez utiliser ce critère qu'avec des données connectées à une base de données. Par exemple, utilisez ces critères 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.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextNotEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

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

Vous pouvez utiliser ce critère avec n'importe quel type de filtre.

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

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.

Définit les critères de filtre sur une condition booléenne définie par les 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 certains BooleanCriteria ne s'appliquent pas à 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();
const 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."
const filterCriteria = filter.getColumnFilterCriteria(2);
const criteria = SpreadsheetApp.newFilterCriteria()
                     .withCriteria(
                         filterCriteria.getCriteriaType(),
                         filterCriteria.getCriteriaValues(),
                         )
                     .setHiddenValues(['Northwest'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

Paramètres

Renvois

FilterCriteriaBuilder : ce générateur, pour le chaînage.