Class Filter

Filtro

Usa esta clase para modificar los filtros existentes en hojas Grid, el tipo predeterminado de hoja. Las hojas de cuadrícula son hojas normales con datos que no están conectados a una base de datos.

Si aún no existe un filtro en la hoja, crea uno con Range.createFilter().

Para usar esta clase, primero debes acceder al filtro de la hoja de cuadrícula con Range.getFilter() o Sheet.getFilter().

Usos comunes

Cómo quitar un filtro

En el siguiente ejemplo, se obtiene el filtro en la hoja activa y se lo quita.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

Obtén el rango al que se aplica el filtro

En el siguiente ejemplo, se obtiene el filtro en la hoja activa y, luego, se usa el método getRange() de esta clase para registrar el rango al que se aplica el filtro.
let ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Métodos

MétodoTipo de datos que se muestraDescripción breve
getColumnFilterCriteria(columnPosition)FilterCriteriaObtiene los criterios de filtro en la columna especificada o null si la columna no tiene criterios de filtro aplicados.
getRange()RangeObtiene el rango al que se aplica este filtro.
remove()voidQuita este filtro.
removeColumnFilterCriteria(columnPosition)FilterQuita los criterios de filtro de la columna especificada.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterEstablece los criterios de filtro en la columna especificada.
sort(columnPosition, ascending)FilterOrdena el rango filtrado por la columna especificada, excluyendo la primera fila (la fila de encabezado) en el rango al que se aplica este filtro.

Documentación detallada

getColumnFilterCriteria(columnPosition)

Obtiene los criterios de filtro en la columna especificada o null si la columna no tiene criterios de filtro aplicados.

Para obtener más detalles sobre los criterios de filtro, encadena este método con métodos de la clase FilterCriteria.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
  // Gets the filter criteria applied to column B of the active sheet
  // and logs the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

Parámetros

NombreTipoDescripción
columnPositionIntegerEs la posición 1 indexada de la columna. Por ejemplo, el índice de la columna B es 2.

Devolvedor

FilterCriteria: Son los criterios del filtro.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Obtiene el rango al que se aplica este filtro.

// Gets the existing filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Devolvedor

Range: Es el rango del filtro. Para obtener el rango en notación A1, encadena este método con Range.getA1Notation().

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Quita este filtro.

// Removes the filter from the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeColumnFilterCriteria(columnPosition)

Quita los criterios de filtro de la columna especificada.

// Removes the filter criteria from column B.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

Parámetros

NombreTipoDescripción
columnPositionIntegerEs la posición 1 indexada de la columna. Por ejemplo, el índice de la columna B es 2.

Devolvedor

Filter: Es el filtro del encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnFilterCriteria(columnPosition, filterCriteria)

Establece los criterios de filtro en la columna especificada. Primero, crea el compilador de criterios de filtro con SpreadsheetApp.newFilterCriteria(). Luego, agrega criterios al compilador con la clase FilterCriteriaBuilder. Después de compilar los criterios, establécelo como el parámetro filterCriteria para este método.

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                             .setHiddenValues(["Hello", "World"])
                             .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

Parámetros

NombreTipoDescripción
columnPositionIntegerEs la posición 1 indexada de la columna. Por ejemplo, el índice de la columna B es 2.
filterCriteriaFilterCriteriaLos criterios de filtro que se establecerán. Si configuras los criterios como null, se quitarán los criterios de filtro de la columna especificada. También puedes usar removeColumnFilterCriteria(columnPosition).

Devolvedor

Filter: Es el filtro del encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

Ordena el rango filtrado por la columna especificada, excluyendo la primera fila (la fila de encabezado) en el rango al que se aplica este filtro.

// Gets the existing filter and sorts it by column B in ascending order.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

Parámetros

NombreTipoDescripción
columnPositionIntegerEs la posición 1 indexada de la columna. Por ejemplo, el índice de la columna B es 2.
ascendingBooleanSi es true, ordena el rango filtrado en orden ascendente; si es false, ordena el rango filtrado en orden descendente.

Devolvedor

Filter: Es el filtro del encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets