Esta página foi traduzida pela API Cloud Translation.

Class FilterCriteriaBuilder

Para adicionar critérios a um filtro, faça o seguinte:

Crie o criador de critérios usando SpreadsheetApp.newFilterCriteria().
Adicione configurações ao builder usando os métodos dessa classe.
Use build() para definir os critérios com as configurações especificadas.

Usos comuns

Ocultar valores em uma página

O exemplo a seguir obtém o filtro existente de uma página e adiciona critérios que ocultam as células em coluna C que contêm "hello" ou "mundo". Os critérios desta amostra só podem ser usados com filtros em Grid páginas, o tipo padrão.

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

Mostrar apenas células não vazias

O exemplo a seguir adiciona um filtro a uma página DataSource, que está conectado a um banco de dados, com critérios que exibem apenas as células da coluna coluna que não estejam vazios.

// 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étodos

Método	Tipo de retorno	Breve descrição
`build()`	`FilterCriteria`	Coleta os critérios de filtro usando as configurações adicionadas ao Criador de critérios.
`copy()`	`FilterCriteriaBuilder`	Copia esse critério de filtro e cria um criador de critérios que você pode aplicar a outro filtro.
`getCriteriaType()`	`BooleanCriteria`	Retorna o tipo booleano dos critérios, por exemplo, `CELL_EMPTY`.
`getCriteriaValues()`	`Object[]`	Retorna uma matriz de argumentos para critérios booleanos.
`getHiddenValues()`	`String[]`	Retorna os valores que o filtro oculta.
`getVisibleBackgroundColor()`	`Color`	Retorna a cor do plano de fundo usada como critério de filtro.
`getVisibleForegroundColor()`	`Color`	Retorna a cor do primeiro plano usada como um critério de filtro.
`getVisibleValues()`	`String[]`	Retorna os valores que o filtro da tabela dinâmica mostra.
`setHiddenValues(values)`	`FilterCriteriaBuilder`	Define os valores a serem ocultados.
`setVisibleBackgroundColor(visibleBackgroundColor)`	`FilterCriteriaBuilder`	Define a cor do plano de fundo usada como critério de filtro.
`setVisibleForegroundColor(visibleForegroundColor)`	`FilterCriteriaBuilder`	Define a cor do primeiro plano usada como critério de filtro.
`setVisibleValues(values)`	`FilterCriteriaBuilder`	Define os valores que serão mostrados em uma tabela dinâmica.
`whenCellEmpty()`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar células vazias.
`whenCellNotEmpty()`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células que não estão vazias.
`whenDateAfter(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas posteriores à data especificada.
`whenDateAfter(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas posteriores à data relativa especificada.
`whenDateBefore(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas anteriores à data especificada.
`whenDateBefore(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas anteriores à data relativa especificada.
`whenDateEqualTo(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas iguais à data especificada.
`whenDateEqualTo(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro que mostram as células com datas iguais à data relativa especificada.
`whenDateEqualToAny(dates)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com datas iguais a qualquer uma das datas especificadas.
`whenDateNotEqualTo(date)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar células que não são iguais à data especificada.
`whenDateNotEqualToAny(dates)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com datas que não são iguais a nenhuma das especificadas datas
`whenFormulaSatisfied(formula)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com uma fórmula especificada (como `=B:B<C:C`) que avalia como `true`.
`whenNumberBetween(start, end)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número que esteja entre 2 ou seja um deles números especificados.
`whenNumberEqualTo(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número igual ao número especificado.
`whenNumberEqualToAny(numbers)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número que seja igual a qualquer um dos critérios de filtro especificados números grandes.
`whenNumberGreaterThan(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número maior que o especificado
`whenNumberGreaterThanOrEqualTo(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número maior ou igual ao especificado número
`whenNumberLessThan(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número menor que o especificado.
`whenNumberLessThanOrEqualTo(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número menor ou igual ao especificado número
`whenNumberNotBetween(start, end)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número que não está entre e não é nenhum de 2 números especificados.
`whenNumberNotEqualTo(number)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número que não é igual ao número especificado.
`whenNumberNotEqualToAny(numbers)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com um número diferente de nenhum dos números especificados números grandes.
`whenTextContains(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com o texto que contém o texto especificado.
`whenTextDoesNotContain(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto que não contém o texto especificado.
`whenTextEndsWith(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto que termina com o texto especificado.
`whenTextEqualTo(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto igual ao texto especificado.
`whenTextEqualToAny(texts)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto igual a qualquer parte do texto especificado e a distribuição dos valores dos dados.
`whenTextNotEqualTo(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto diferente do texto especificado.
`whenTextNotEqualToAny(texts)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto diferente de nenhum dos valores especificados e a distribuição dos valores dos dados.
`whenTextStartsWith(text)`	`FilterCriteriaBuilder`	Define os critérios de filtro para mostrar as células com texto que comece com o texto especificado.
`withCriteria(criteria, args)`	`FilterCriteriaBuilder`	Define os critérios de filtro como uma condição booleana definida por valores `BooleanCriteria`, como como `CELL_EMPTY` ou `NUMBER_GREATER_THAN`.

Documentação detalhada

`build()`

Coleta os critérios de filtro usando as configurações adicionadas ao Criador de critérios.

// 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);

Retornar

FilterCriteria: uma representação dos critérios de filtro.

`copy()`

Copia esse critério de filtro e cria um criador de critérios que você pode aplicar a outro filtro.

Você pode usar esse método com qualquer tipo de filtro. Se você estiver usando um filtro de página, poderá copiar os critérios para outra coluna.

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);

Retornar

FilterCriteriaBuilder: um criador de critérios de filtro com base nesses critérios de filtro.

`getCriteriaType()`

Retorna o tipo booleano dos critérios, por exemplo, CELL_EMPTY. Para saber mais sobre os tipos de critérios booleanos, consulte a enumeração BooleanCriteria.

As pessoas costumam usar esse método para adicionar critérios de condição booleanos a um filtro sem substituí-los critérios existentes.

Para receber os argumentos dos critérios, use getCriteriaValues().
Para usar o tipo e os valores dos critérios para criar ou modificar os critérios de filtro, consulte withCriteria(criteria, args):

Você pode usar esse método para qualquer tipo de filtro. Se os critérios de filtro não forem booleanos condição, retorna 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);

Retornar

BooleanCriteria: o tipo de critério booleano ou null se o critério não for booleano condição.

`getCriteriaValues()`

Retorna uma matriz de argumentos para critérios booleanos. Alguns tipos de critérios booleanos não têm e retornam uma matriz vazia, por exemplo, CELL_NOT_EMPTY.

As pessoas costumam usar esse método para adicionar critérios de condição booleanos a um filtro sem substituí-los critérios existentes.

Para receber o tipo de critério booleano, use getCriteriaType().
Para usar o tipo e os valores de critérios para criar ou modificar um critério de filtro, consulte withCriteria(criteria, args):
Você pode usar esse método para qualquer tipo de filtro.
```
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);
```
Retornar

Object[]: uma matriz de argumentos apropriados para o tipo de critério booleano. O número de argumentos e o tipo deles corresponde ao método when...() da classe FilterCriteriaBuilder.

`getHiddenValues()`

Retorna os valores que o filtro oculta.

Usar estes critérios com filtros em Grid páginas, o tipo padrão de página. Retorna null se você chamar esse método para outros tipos de filtros.

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);

Retornar

String[]: uma matriz de valores que o filtro oculta.

`getVisibleBackgroundColor()`

Retorna a cor do plano de fundo usada como critério de filtro. As células com essa cor de plano de fundo permanecem visíveis.

Usar estes critérios com filtros em Grid páginas, o tipo padrão de página. Retorna null se você chamar esse método para outros tipos de filtros.

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);

Retornar

Color: a cor do plano de fundo usada como critério de filtro.

`getVisibleForegroundColor()`

Retorna a cor do primeiro plano usada como um critério de filtro. As células com essa cor de primeiro plano permanecem visíveis.

Usar estes critérios com filtros em Grid páginas, o tipo padrão de página. Retorna null se você chamar esse método para outros tipos de filtros.

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);

Retornar

Color: a cor do primeiro plano usada como critério de filtro.

`getVisibleValues()`

Retorna os valores que o filtro da tabela dinâmica mostra.

Esse critério serve apenas para filtros em tabelas dinâmicas que não estão conectadas a um banco de dados. Retorna uma matriz vazia para outros tipos de filtros.

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);

Retornar

String[]: uma matriz de valores exibidos pelo filtro da tabela dinâmica.

`setHiddenValues(values)`

Define os valores a serem ocultados. Limpa todos os valores visíveis ou ocultos.

Você só pode usar este critério para filtros em Grid páginas, a padrão tipo de planilha.

// 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);

Parâmetros

Nome	Tipo	Descrição
`values`	`String[]`	A lista de valores a serem ocultados.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`setVisibleBackgroundColor(visibleBackgroundColor)`

Define a cor do plano de fundo usada como critério de filtro. As células com essa cor de plano de fundo permanecem visíveis. Definir um critério de filtro de cor de plano de fundo remove todos os critérios de filtro de cor atuais deste builder.

Você só pode usar este critério para filtros em Grid páginas, a padrão tipo de planilha.

// 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);

Parâmetros

Nome	Tipo	Descrição
`visibleBackgroundColor`	`Color`	A cor do plano de fundo a ser definida. A cor precisa estar no estilo RGB cor Esse método não oferece suporte a cores de tema.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`setVisibleForegroundColor(visibleForegroundColor)`

Define a cor do primeiro plano usada como critério de filtro. As células com essa cor de primeiro plano permanecem visíveis. Definir um critério de filtro de cor de primeiro plano remove todos os critérios de filtro de cor atuais deste builder.

Você só pode usar este critério para filtros em Grid páginas, a padrão tipo de planilha.

// 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);

Parâmetros

Nome	Tipo	Descrição
`visibleForegroundColor`	`Color`	A cor do primeiro plano a ser definida. A cor precisa estar no estilo RGB cor Esse método não oferece suporte a cores de tema.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`setVisibleValues(values)`

Define os valores que serão mostrados em uma tabela dinâmica. Limpa todos os valores visíveis ou ocultos.

Esse critério só pode ser usado para filtros em tabelas dinâmicas que não estão conectadas a uma no seu banco de dados.

// 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);

Parâmetros

Nome	Tipo	Descrição
`values`	`String[]`	A lista de valores a serem mostrados.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenCellEmpty()`

Define os critérios de filtro para mostrar células vazias.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenCellNotEmpty()`

Define os critérios de filtro para mostrar as células que não estão vazias.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateAfter(date)`

Define os critérios de filtro que mostram as células com datas posteriores à data especificada.

É possível usar esses critérios com qualquer tipo de filtro. Se você usar esse critério com dados estiver conectada a um banco de dados, o tipo de dados da coluna que você está filtrando precisa ser uma data. Se o dados não estiverem conectados a um banco de dados, o tipo de dados da coluna que você está filtrando não precisa ser uma data, mas se não for, você poderá obter resultados inesperados.

// 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data mais recente a ser ocultada.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateAfter(date)`

Define os critérios de filtro que mostram as células com datas posteriores à data relativa especificada. Para para conferir as opções de data relativa, consulte Enumeração 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A data relativa mais recente.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateBefore(date)`

Define os critérios de filtro que mostram as células com datas anteriores à data especificada.

// 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data mais antiga a ser ocultada.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateBefore(date)`

Define os critérios de filtro que mostram as células com datas anteriores à data relativa especificada. Para conferir as opções de data relativa, consulte Enumeração 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A data relativa mais antiga a ser ocultada.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateEqualTo(date)`

Define os critérios de filtro que mostram as células com datas iguais à data especificada.

// 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data em que os valores das células precisam ser correspondentes.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateEqualTo(date)`

Define os critérios de filtro que mostram as células com datas iguais à data relativa especificada. Para conferir as opções de data relativa, consulte Enumeração 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`RelativeDate`	A data relativa em que os valores das células precisam ser correspondentes.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateEqualToAny(dates)`

Define os critérios de filtro para mostrar as células com datas iguais a qualquer uma das datas especificadas.

Você só pode usar esses critérios com dados conectados a um banco de dados. Por exemplo, use este com filtros em uma página DataSource, uma página conectada a um banco de dados, ou DataSourcePivotTable, uma tabela dinâmica criada com base em uma planilha 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);

Parâmetros

Nome	Tipo	Descrição
`dates`	`Date[]`	As datas a serem exibidas.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateNotEqualTo(date)`

Define os critérios de filtro para mostrar células que não são iguais à data especificada.

O tipo de dados da coluna que você está filtrando precisa ser uma data.

// 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	A data a ser ocultada.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenDateNotEqualToAny(dates)`

Define os critérios de filtro para mostrar as células com datas que não são iguais a nenhuma das especificadas datas

// 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);

Parâmetros

Nome	Tipo	Descrição
`dates`	`Date[]`	As datas a serem ocultadas.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenFormulaSatisfied(formula)`

Define os critérios de filtro para mostrar as células com uma fórmula especificada (como =B:B<C:C) que avalia como true.

Você só pode usar esses critérios para filtrar dados que não estejam conectados a um banco de dados.

// 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);

Parâmetros

Nome	Tipo	Descrição
`formula`	`String`	Uma fórmula personalizada que muda para `true` se a entrada for válida.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberBetween(start, end)`

Define os critérios de filtro para mostrar as células com um número que esteja entre 2 ou seja um deles números especificados.

É possível usar esses critérios com qualquer tipo de filtro. Se você usar esse critério com dados conectado a um banco de dados, o tipo de dados da coluna que você está filtrando precisa ser um número. Se os dados não estiverem conectados a um banco de dados, o tipo de dados da coluna que você está filtrando não precisa ser um número, mas se não for, você poderá obter resultados inesperados.

// 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);

Parâmetros

Nome	Tipo	Descrição
`start`	`Number`	O menor número a ser exibido.
`end`	`Number`	O número mais alto a ser exibido.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberEqualTo(number)`

Define os critérios de filtro para mostrar as células com um número igual ao número especificado.

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O número que será exibido.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberEqualToAny(numbers)`

Define os critérios de filtro para mostrar as células com um número que seja igual a qualquer um dos critérios de filtro especificados números grandes.

// 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);

Parâmetros

Nome	Tipo	Descrição
`numbers`	`Number[]`	Os números que serão exibidos.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberGreaterThan(number)`

Define os critérios de filtro para mostrar as células com um número maior que o especificado

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O número mais alto a ser ocultado.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberGreaterThanOrEqualTo(number)`

Define os critérios de filtro para mostrar as células com um número maior ou igual ao especificado número

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O menor número a ser exibido.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberLessThan(number)`

Define os critérios de filtro para mostrar as células com um número menor que o especificado.

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O número mais baixo a ser ocultado.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberLessThanOrEqualTo(number)`

Define os critérios de filtro para mostrar as células com um número menor ou igual ao especificado número

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O número mais alto a ser exibido.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberNotBetween(start, end)`

Define os critérios de filtro para mostrar as células com um número que não está entre e não é nenhum de 2 números especificados.

// 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);

Parâmetros

Nome	Tipo	Descrição
`start`	`Number`	O menor número ocultado.
`end`	`Number`	O número mais alto a ser ocultado.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberNotEqualTo(number)`

Define os critérios de filtro para mostrar as células com um número que não é igual ao número especificado.

// 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);

Parâmetros

Nome	Tipo	Descrição
`number`	`Number`	O número a ser ocultado.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenNumberNotEqualToAny(numbers)`

Define os critérios de filtro para mostrar as células com um número diferente de nenhum dos números especificados números grandes.

// 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);

Parâmetros

Nome	Tipo	Descrição
`numbers`	`Number[]`	Os números a serem ocultados.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextContains(text)`

Define os critérios de filtro para mostrar as células com texto que contém o texto especificado. O texto não diferencia maiúsculas de minúsculas.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto que a célula deve conter.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextDoesNotContain(text)`

Define os critérios de filtro para mostrar as células com texto que não contém o texto especificado. A o texto não diferencia maiúsculas de minúsculas.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto que a célula não deve conter.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextEndsWith(text)`

Define os critérios de filtro para mostrar as células com texto que termina com o texto especificado. O texto não diferencia maiúsculas de minúsculas.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	Texto que deve conter no final do texto da célula.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextEqualTo(text)`

Define os critérios de filtro para mostrar as células com texto igual ao texto especificado. O texto não diferencia maiúsculas de minúsculas.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto que precisa ser igual ao texto da célula.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextEqualToAny(texts)`

Define os critérios de filtro para mostrar as células com texto igual a qualquer parte do texto especificado e a distribuição dos valores dos dados. O texto não diferencia maiúsculas de minúsculas.

// 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);

Parâmetros

Nome	Tipo	Descrição
`texts`	`String[]`	Os valores de texto que uma célula deve igualar.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextNotEqualTo(text)`

Define os critérios de filtro para mostrar as células com texto diferente do texto especificado. A o texto não diferencia maiúsculas de minúsculas.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto que não pode igualar o texto da célula.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextNotEqualToAny(texts)`

Define os critérios de filtro para mostrar as células com texto diferente de nenhum dos valores especificados e a distribuição dos valores dos dados. O texto não diferencia maiúsculas de minúsculas.

// 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);

Parâmetros

Nome	Tipo	Descrição
`texts`	`String[]`	Os valores de texto que uma célula não pode igualar.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`whenTextStartsWith(text)`

Define os critérios de filtro para mostrar as células com texto que comece com o texto especificado. O texto não diferencia maiúsculas de minúsculas.

É possível usar esses critérios com qualquer tipo de filtro.

// 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);

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	Texto que deve conter no início do texto da célula.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.

`withCriteria(criteria, args)`

Define os critérios de filtro como uma condição booleana definida por valores BooleanCriteria, como como CELL_EMPTY ou NUMBER_GREATER_THAN. Para copiar a condição booleana da critérios existentes, defina os parâmetros para esse método usando getCriteriaType() e getCriteriaValues() em um critérios existentes.

É possível usar esses critérios com qualquer tipo de filtro, mas alguns BooleanCriteria não são aplicável a todos os filtros.

// 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);

Parâmetros

Nome	Tipo	Descrição
`criteria`	`BooleanCriteria`	O tipo de critério booleano.
`args`	`Object[]`	Uma matriz de argumentos apropriados para o tipo de critério. o número de argumentos e os tipos deles correspondem aos métodos `when...()` correspondentes acima.

Retornar

FilterCriteriaBuilder: este builder para encadeamento.