Representa um controle de filtros, que é usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa. Essa classe contém métodos para acessar e modificar segmentadores atuais. Para criar um novo controle de filtros, use Sheet.insertSlicer(range, anchorRowPos, anchorColPos).
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
get | Color|null | Retorna o plano de fundo Color do segmentador. |
get | Integer|null | Retorna a posição da coluna (em relação ao intervalo de dados do controle de filtros) em que o filtro é aplicado no controle de filtros ou null se a posição da coluna não estiver definida. |
get | Container | Recebe informações sobre onde o controle de filtros está posicionado na página. |
get | Filter | Retorna os critérios de filtro do controle de filtros ou null se eles não estiverem definidos. |
get | Range | Recebe o intervalo de dados em que o controle de filtros é aplicado. |
get | String | Retorna o título do controle de filtros. |
get | String | Recebe o alinhamento horizontal do título. |
get | Text | Retorna o estilo de texto do título do segmentador. |
is | Boolean | Retorna se o controle de filtros especificado está aplicado a tabelas dinâmicas. |
remove() | void | Exclui o controle de filtros. |
set | Slicer | Define se o controle de filtros especificado deve ser aplicado às tabelas dinâmicas na planilha. |
set | Slicer | Define a cor do plano de fundo do controle de filtros. |
set | Slicer | Define o plano de fundo Color do controle de filtros. |
set | Slicer | Define o índice da coluna e os critérios de filtragem do controle de filtros. |
set | Slicer | Define a posição em que o controle de filtros aparece na página. |
set | Slicer | Define o intervalo de dados em que o controle de filtros é aplicado. |
set | Slicer | Define o título do controle de filtros. |
set | Slicer | Define o alinhamento horizontal do título no controle de filtros. |
set | Slicer | Define o estilo do texto do controle de filtros. |
Documentação detalhada
getBackgroundColorObject()
Retorna o plano de fundo Color do segmentador.
Retornar
Color|null: a cor de fundo deste controle de filtros. Retorna null se nenhuma cor for definida.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getColumnPosition()
Retorna a posição da coluna (em relação ao intervalo de dados do controle de filtros) em que o filtro é aplicado no controle de filtros ou null se a posição da coluna não estiver definida. Essa deve ser a posição indexada em 1 da coluna, semelhante ao filtro.
Retornar
Integer|null: a posição da coluna deste segmentador.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getContainerInfo()
Recebe informações sobre onde o controle de filtros está posicionado na página.
Retornar
ContainerInfo: um objeto que contém a posição do contêiner do segmentador.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
Retorna os critérios de filtro do controle de filtros ou null se eles não estiverem definidos.
Retornar
FilterCriteria|null: os critérios de filtro da segmentação.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRange()
Recebe o intervalo de dados em que o controle de filtros é aplicado.
Retornar
Range: o intervalo do segmentador.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitle()
Retorna o título do controle de filtros.
Retornar
String: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitleHorizontalAlignment()
Recebe o alinhamento horizontal do título.
Retornar
String: o alinhamento horizontal do título do segmentador.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitleTextStyle()
Retorna o estilo de texto do título do segmentador.
Retornar
TextStyle: o estilo de texto do título do segmentador.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isAppliedToPivotTables()
Retorna se o controle de filtros especificado está aplicado a tabelas dinâmicas.
Retornar
Boolean — true se este controle de filtros for aplicado a tabelas dinâmicas, caso contrário, false.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove()
Exclui o controle de filtros.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setApplyToPivotTables(applyToPivotTables)
Define se o controle de filtros especificado deve ser aplicado às tabelas dinâmicas na planilha.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
apply | Boolean | Especifica se este controle de filtros se aplica a tabelas dinâmicas. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundColor(color)
Define a cor do plano de fundo do controle de filtros. Um valor null redefine a cor de plano de fundo.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
color | String | A nova cor de plano de fundo deste segmentador na notação CSS (como "#ffffff"). |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundColorObject(color)
Define o plano de fundo Color do controle de filtros. Um valor null redefine a cor de fundo.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
color | Color | A nova cor de plano de fundo desse controle de filtros. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setColumnFilterCriteria(columnPosition, filterCriteria)
Define o índice da coluna e os critérios de filtragem do controle de filtros. Um valor null redefine o filtro de segmentação.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
column | Integer | A nova posição da coluna deste segmentador. |
filter | Filter | Os novos critérios de filtro da segmentação. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Define a posição em que o controle de filtros aparece na página. Os índices de posição da linha e da coluna de ancoragem são indexados em 1.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
anchor | Integer | A parte superior do segmentador fica ancorada nessa linha. |
anchor | Integer | A parte de cima do segmentador fica ancorada nessa coluna. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setRange(rangeApi)
Define o intervalo de dados em que o controle de filtros é aplicado.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
range | Range | O novo intervalo para esse controle de filtros. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTitle(title)
Define o título do controle de filtros. Um título vazio redefine o título para o valor padrão.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
title | String | O novo título do controle de filtros. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTitleHorizontalAlignment(horizontalAlignment)
Define o alinhamento horizontal do título no controle de filtros. Um valor null redefine o alinhamento.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
horizontal | String | O novo alinhamento horizontal do título da segmentação. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTitleTextStyle(textStyle)
Define o estilo do texto do controle de filtros.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
text | Text | O novo estilo de texto do título do segmentador. |
Retornar
Slicer: este segmentador, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets