Se usó la API de Cloud Translation para traducir esta página.

Class FilterCriteria

Usa esta clase para obtener información sobre los criterios de los filtros existentes o copiarlos.

Para crear un filtro nuevo, consulta lo siguiente:
- Para las hojas, usa Range.createFilter().
- Para las tablas dinámicas, usa PivotTable.addFilter(sourceDataColumn, filterCriteria).
- Para las hojas conectadas a una base de datos, usa DataSourceSheet.addFilter(columnName, filterCriteria).
- Para las tablas dinámicas conectadas a una base de datos, usa DataSourcePivotTable.addFilter(columnName, filterCriteria).
Para crear los criterios de cualquier tipo de filtro, consulta SpreadsheetApp.newFilterCriteria() y FilterCriteriaBuilder.

Usos comunes

Cómo copiar criterios

En el siguiente ejemplo, se obtiene el filtro que se aplica al rango A1:C20, se obtienen los criterios aplicados a la columna C y se copian los criterios en la columna B.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
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);

Cómo obtener valores ocultos por el filtro

En el siguiente ejemplo, se obtiene el filtro que se aplica al rango determinado y se registran los valores de la columna B que oculta el filtro.

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

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`copy()`	`FilterCriteriaBuilder`	Copia estos criterios de filtro y crea un compilador de criterios que puedes aplicar a otro filtro.
`getCriteriaType()`	`BooleanCriteria`	Muestra el tipo booleano de los criterios, por ejemplo, `CELL_EMPTY`.
`getCriteriaValues()`	`Object[]`	Muestra un array de argumentos para criterios booleanos.
`getHiddenValues()`	`String[]`	Muestra los valores que oculta el filtro.
`getVisibleBackgroundColor()`	`Color`	Muestra el color de fondo que se usa como criterio de filtro.
`getVisibleForegroundColor()`	`Color`	Muestra el color en primer plano que se usa como criterio de filtro.
`getVisibleValues()`	`String[]`	Devuelve los valores que muestra el filtro de la tabla dinámica.

Documentación detallada

`copy()`

Copia estos criterios de filtro y crea un compilador de criterios que puedes aplicar a otro filtro.

Puedes usar este método con cualquier tipo de filtro. Si usas un filtro de hoja, puedes copiar los criterios en otra columna.

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

Volver

FilterCriteriaBuilder: Es un compilador de criterios de filtro basado en este criterio de filtro.

`getCriteriaType()`

Muestra el tipo booleano de los criterios, por ejemplo, CELL_EMPTY. Para obtener información sobre los tipos de criterios booleanos, consulta la enumeración BooleanCriteria.

A menudo, las personas usan este método para agregar criterios de condiciones booleanas a un filtro sin reemplazar los criterios existentes.

Para obtener los argumentos de los criterios, usa getCriteriaValues().
Para usar el tipo de criterios y los valores de criterios para crear o modificar criterios de filtro, consulta FilterCriteriaBuilder.withCriteria(criteria, args).

Puedes usar este método para cualquier tipo de filtro. Si los criterios de filtro no son una condición booleana, se muestra 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);

Volver

BooleanCriteria: Es el tipo de criterio booleano o null si el criterio no es una condición booleana.

`getCriteriaValues()`

Muestra un array de argumentos para criterios booleanos. Algunos tipos de criterios booleanos no tienen argumentos y muestran un array vacío, por ejemplo, CELL_NOT_EMPTY.

A menudo, las personas usan este método para agregar criterios de condiciones booleanas a un filtro sin reemplazar los criterios existentes.

Para obtener el tipo de criterios booleanos, usa getCriteriaType().
Para usar el tipo de criterios y los valores de criterios para crear o modificar un criterio de filtro, consulta FilterCriteriaBuilder.withCriteria(criteria, args).
Puedes usar este método para cualquier tipo de filtro.
```
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);
```
Volver

Object[]: Es un array de argumentos adecuados para el tipo de criterios booleanos. La cantidad de argumentos y su tipo coinciden con el método when...() correspondiente de la clase FilterCriteriaBuilder.

`getHiddenValues()`

Muestra los valores que oculta el filtro.

Usa este criterio con filtros en hojas Grid, el tipo de hoja predeterminado. Muestra null si llamas a este método para otros tipos de filtros.

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

Volver

String[]: Es un array de valores que oculta el filtro.

`getVisibleBackgroundColor()`

Muestra el color de fondo que se usa como criterio de filtro. Las celdas con este color de fondo permanecen visibles.

Usa este criterio con filtros en hojas Grid, el tipo de hoja predeterminado. Muestra null si llamas a este método para otros tipos de filtros.

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

Volver

Color: Es el color de fondo que se usa como criterio de filtro.

`getVisibleForegroundColor()`

Muestra el color en primer plano que se usa como criterio de filtro. Las celdas con este color de primer plano permanecen visibles.

Usa este criterio con filtros en hojas Grid, el tipo de hoja predeterminado. Muestra null si llamas a este método para otros tipos de filtros.

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

Volver

Color: Es el color de primer plano que se usa como criterio de filtro.

`getVisibleValues()`

Devuelve los valores que muestra el filtro de la tabla dinámica.

Este criterio es solo para los filtros de tablas dinámicas que no están conectados a una base de datos. Muestra un array vacío para otros tipos de filtros.

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

Volver

String[]: Es un array de valores que muestra el filtro de la tabla dinámica.