Representa um slicer, 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 os controles de filtros existentes. Para criar um novo controle de filtros, use Sheet.insertSlicer(range, anchorRowPos, anchorColPos).
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getBackgroundColorObject() | Color | Retorne o Color do plano de fundo do controle de filtros. |
getColumnPosition() | Integer | Retorna a posição da coluna (em relação ao intervalo de dados do controle de filtros) em que o filtro é
aplicado no controle ou null se a posição da coluna não estiver definida. |
getContainerInfo() | ContainerInfo | Recebe informações sobre onde o controle de filtros está posicionado na página. |
getFilterCriteria() | FilterCriteria | Retorna os critérios de filtro do controle ou null se os critérios não estiverem definidos. |
getRange() | Range | Extrai o intervalo de dados ao qual o controle de filtros é aplicado. |
getTitle() | String | Retorna o título do controle de filtros. |
getTitleHorizontalAlignment() | String | Recebe o alinhamento horizontal do título. |
getTitleTextStyle() | TextStyle | Retorna o estilo de texto do título do controle de filtros. |
isAppliedToPivotTables() | Boolean | Retorna se o controle de filtros especificado é aplicado a tabelas dinâmicas. |
remove() | void | Exclui o controle de filtros. |
setApplyToPivotTables(applyToPivotTables) | Slicer | Define se o controle de filtros especificado deve ser aplicado às tabelas dinâmicas na planilha. |
setBackgroundColor(color) | Slicer | Define a cor do plano de fundo do controle de filtros. |
setBackgroundColorObject(color) | Slicer | Define o Color do plano de fundo do controle de filtros. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | Define o índice da coluna e os critérios de filtragem do controle de filtros. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Define a posição em que o controle de filtros aparece na página. |
setRange(rangeApi) | Slicer | Define o intervalo de dados em que o controle de filtros é aplicado. |
setTitle(title) | Slicer | Define o título do controle de filtros. |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | Define o alinhamento horizontal do título no controle de filtros. |
setTitleTextStyle(textStyle) | Slicer | Define o estilo de texto do controle de filtros. |
Documentação detalhada
getBackgroundColorObject()
Retorne o Color do plano de fundo do controle de filtros.
Retorno
Color: a cor do plano de fundo do 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 ou null se a posição da coluna não estiver definida. Precisa ser uma posição indexada de 1 da coluna, semelhante ao filtro.
Retorno
Integer: a posição da coluna do 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
getContainerInfo()
Recebe informações sobre onde o controle de filtros está posicionado na página.
Retorno
ContainerInfo: um objeto que contém a posição do contêiner do 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
getFilterCriteria()
Retorna os critérios de filtro do controle ou null se os critérios não estiverem definidos.
Retorno
FilterCriteria: os critérios de filtro deste 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
getRange()
Extrai o intervalo de dados ao qual o controle de filtros é aplicado.
Retorno
Range: o intervalo do 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
getTitle()
Retorna o título do controle de filtros.
Retorno
String: este controle de filtros 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.
Retorno
String: o alinhamento horizontal do título do 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
getTitleTextStyle()
Retorna o estilo de texto do título do controle de filtros.
Retorno
TextStyle: o estilo de texto do título do 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
isAppliedToPivotTables()
Retorna se o controle de filtros especificado é aplicado a tabelas dinâmicas.
Retorno
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 |
|---|---|---|
applyToPivotTables | Boolean | Especifica se este controle de filtros deve ser aplicado a tabelas dinâmicas. |
Retorno
Slicer: este controle de filtros 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 do plano de fundo.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
color | String | A nova cor de plano de fundo desse controle de filtros na notação CSS (como '#ffffff'). |
Retorno
Slicer: este controle de filtros 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 Color do plano de fundo do controle de filtros. Um valor null redefine a cor
do plano de fundo.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
color | Color | A nova cor de plano de fundo deste controle de filtros. |
Retorno
Slicer: este controle de filtros 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 slicer.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnPosition | Integer | A nova posição da coluna deste controle de filtros. |
filterCriteria | FilterCriteria | Os novos critérios de filtro deste controle de filtros. |
Retorno
Slicer: este controle de filtros 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 da âncora são indexados em 1.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
anchorRowPos | Integer | A parte superior do controle de filtros está ancorada nessa linha. |
anchorColPos | Integer | A parte de cima do controle de filtros está ancorada nesta 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. |
Retorno
Slicer: este controle de filtros 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 |
|---|---|---|
rangeApi | Range | O novo intervalo do controle de filtros. |
Retorno
Slicer: este controle de filtros 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. Se estiver vazio, o título será redefinido para o valor padrão.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
title | String | O novo título deste controle de filtros. |
Retorno
Slicer: este controle de filtros 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 |
|---|---|---|
horizontalAlignment | String | O novo alinhamento horizontal do título do controle de filtros. |
Retorno
Slicer: este controle de filtros 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 de texto do controle de filtros.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
textStyle | TextStyle | O novo estilo de texto do título do controle de filtros. |
Retorno
Slicer: este controle de filtros 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