Representa un control de filtro, que se usa para filtrar rangos, gráficos y tablas dinámicas de manera no colaborativa. Esta clase contiene métodos para acceder a los controles de filtro existentes y modificarlos. Para crear un control de filtro nuevo, usa Sheet.insertSlicer(range, anchorRowPos, anchorColPos)
.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getBackgroundColorObject() | Color | Muestra el Color en segundo plano del control de filtro. |
getColumnPosition() | Integer | Muestra la posición de la columna (relativa al rango de datos del control de filtro) en la que se aplica el filtro en el control de filtro, o null si la posición de la columna no está establecida. |
getContainerInfo() | ContainerInfo | Obtiene información sobre la posición del control de filtro en la hoja. |
getFilterCriteria() | FilterCriteria | Muestra los criterios de filtro del control de filtro o null si no se configuraron. |
getRange() | Range | Obtiene el rango de datos en el que se aplica el control de filtro. |
getTitle() | String | Muestra el título del control de filtro. |
getTitleHorizontalAlignment() | String | Obtiene la alineación horizontal del título. |
getTitleTextStyle() | TextStyle | Muestra el estilo de texto del título del control de filtro. |
isAppliedToPivotTables() | Boolean | Muestra si el control de filtro determinado se aplica a las tablas dinámicas. |
remove() | void | Borra el control de filtro. |
setApplyToPivotTables(applyToPivotTables) | Slicer | Establece si un control de filtro determinado debe aplicarse a las tablas dinámicas de la hoja de cálculo. |
setBackgroundColor(color) | Slicer | Establece el color de fondo del control de filtro. |
setBackgroundColorObject(color) | Slicer | Establece el Color en segundo plano del control de filtro. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | Establece el índice de columna y los criterios de filtro del control de filtro. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Establece la posición en la que aparece el control de filtro en la hoja. |
setRange(rangeApi) | Slicer | Establece el rango de datos en el que se aplica el control de filtro. |
setTitle(title) | Slicer | Establece el título del control de filtro. |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | Establece la alineación horizontal del título en el control de filtro. |
setTitleTextStyle(textStyle) | Slicer | Establece el estilo de texto del control de filtro. |
Documentación detallada
getBackgroundColorObject()
Muestra el Color
en segundo plano del control de filtro.
Devolvedor
Color
: Es el color de fondo de este control de filtro. Muestra null
si no se estableció ningún color.
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
getColumnPosition()
Muestra la posición de la columna (relativa al rango de datos del control de filtro) en la que se aplica el filtro en el control de filtro, o null
si la posición de la columna no está establecida. Debería ser una posición 1 indexada de la columna similar al filtro.
Devolvedor
Integer
: Es la posición de la columna de este control de 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
getContainerInfo()
Obtiene información sobre la posición del control de filtro en la hoja.
Devolvedor
ContainerInfo
: Es un objeto que contiene la posición del contenedor del control de 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
getFilterCriteria()
Muestra los criterios de filtro del control de filtro o null
si no se configuraron.
Devolvedor
FilterCriteria
: Son los criterios de filtro de este control de 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 de datos en el que se aplica el control de filtro.
Devolvedor
Range
: Es el rango del control de 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
getTitle()
Muestra el título del control de filtro.
Devolvedor
String
: Este control de filtro se usa para encadenar.
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
getTitleHorizontalAlignment()
Obtiene la alineación horizontal del título.
Devolvedor
String
: Es la alineación horizontal del título de este control de 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
getTitleTextStyle()
Muestra el estilo de texto del título del control de filtro.
Devolvedor
TextStyle
: Es el estilo de texto del título de este control de 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
isAppliedToPivotTables()
Muestra si el control de filtro determinado se aplica a las tablas dinámicas.
Devolvedor
Boolean
: Es true
si se aplica este control de filtro a las tablas dinámicas; de lo contrario, es false
.
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()
Borra el control de 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
setApplyToPivotTables(applyToPivotTables)
Establece si un control de filtro determinado debe aplicarse a las tablas dinámicas de la hoja de cálculo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
applyToPivotTables | Boolean | Especifica si este control de filtro debe aplicarse a las tablas dinámicas. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setBackgroundColor(color)
Establece el color de fondo del control de filtro. Un valor null
restablece el color de fondo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
color | String | El nuevo color de fondo de este control de filtro en la notación CSS (por ejemplo, "#ffffff"). |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setBackgroundColorObject(color)
Establece el Color
en segundo plano del control de filtro. Un valor null
restablece el color de fondo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
color | Color | El nuevo color de fondo de este control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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 el índice de columna y los criterios de filtro del control de filtro. Un valor null
restablece el filtro del control de filtro.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
columnPosition | Integer | Es la nueva posición de columna de este control de filtro. |
filterCriteria | FilterCriteria | Los nuevos criterios de filtro de este control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Establece la posición en la que aparece el control de filtro en la hoja. Los índices de posición de fila y columna de anclaje se indexan con el valor 1.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
anchorRowPos | Integer | La parte superior del control de filtro está anclada en esta fila. |
anchorColPos | Integer | El lado superior del control de filtro está anclado en esta columna. |
offsetX | Integer | Desplazamiento horizontal desde la esquina de la celda en píxeles. |
offsetY | Integer | Desplazamiento vertical desde la esquina de la celda en píxeles. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setRange(rangeApi)
Establece el rango de datos en el que se aplica el control de filtro.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
rangeApi | Range | El nuevo rango de este control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setTitle(title)
Establece el título del control de filtro. Un título vacío restablece el valor predeterminado del título.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
title | String | Es el nuevo título de este control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setTitleHorizontalAlignment(horizontalAlignment)
Establece la alineación horizontal del título en el control de filtro. Un valor null
restablece la alineación.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
horizontalAlignment | String | La nueva alineación horizontal del título de este control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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
setTitleTextStyle(textStyle)
Establece el estilo de texto del control de filtro.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
textStyle | TextStyle | El nuevo estilo de texto del título del control de filtro. |
Devolvedor
Slicer
: Este control de filtro se usa para encadenar.
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