Esta página foi traduzida pela API Cloud Translation.

Class Slicer

Representa um slicer, usado para filtrar intervalos, gráficos e tabelas dinâmicas de forma não colaborativa. Essa classe contém métodos para acessar e modificar os controles de filtros atuais. 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 segundo plano `Color` do controle de filtros.
`getColumnPosition()`	`Integer`	Retorna a posição da coluna (relativa 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.
`getContainerInfo()`	`ContainerInfo`	Recebe informações sobre onde o controle de filtros está posicionado na página.
`getFilterCriteria()`	`FilterCriteria`	Retorna o critério do filtro do controle de filtros ou `null` se os critérios de filtro não estiverem definidos.
`getRange()`	`Range`	Recebe 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 fornecido é aplicado a tabelas dinâmicas.
`remove()`	`void`	Exclui o controle de filtros.
`setApplyToPivotTables(applyToPivotTables)`	`Slicer`	Define se o controle de qualidade específico deve ser aplicado a tabelas dinâmicas na planilha.
`setBackgroundColor(color)`	`Slicer`	Define a cor do plano de fundo do controle de filtros.
`setBackgroundColorObject(color)`	`Slicer`	Define o segundo plano `Color` do controle de filtros.
`setColumnFilterCriteria(columnPosition, filterCriteria)`	`Slicer`	Define o índice de colunas 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 é exibido 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.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`getBackgroundColor()`	`String`	Retorna a cor de fundo do controle de filtros na notação CSS (como '#ffffff').

Documentação detalhada

`getBackgroundColorObject()`

Retorne o segundo plano Color do controle de filtros.

Retornar

Color: a cor de fundo deste controle de filtros. Retornará null se nenhuma cor estiver 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 (relativa 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. Precisa ser uma posição indexada da coluna de uma coluna semelhante ao filtro.

Retornar

Integer: a posição da coluna desse 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.

Retornar

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 o critério do filtro do controle de filtros ou null se os critérios de filtro não estiverem definidos.

Retornar

FilterCriteria: os critérios de filtro desse 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()`

Recebe o intervalo de dados ao qual o controle de filtros é aplicado.

Retornar

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.

Retornar

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.

Retornar

String: o alinhamento horizontal do título desse 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.

Retornar

TextStyle: o estilo de texto deste 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 fornecido é 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 qualidade específico deve ser aplicado a tabelas dinâmicas na planilha.

Parâmetros

Nome	Tipo	Descrição
`applyToPivotTables`	`Boolean`	Especifica se esse controle de filtros será aplicado a tabelas dinâmicas.

Retornar

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 do plano de fundo do controle de filtros na notação CSS (como '#ffffff').

Retornar

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 segundo plano Color 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 do plano de fundo desse controle de filtros.

Retornar

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 de colunas e os critérios de filtragem do controle de filtros. Um valor null redefine o filtro de controle de filtros.

Parâmetros

Nome	Tipo	Descrição
`columnPosition`	`Integer`	É a nova posição da coluna desse controle de filtros.
`filterCriteria`	`FilterCriteria`	Os novos critérios de filtro deste controle de filtros.

Retornar

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 é exibido na página. Os índices de posição da linha e da coluna de âncora são indexados com 1.

Parâmetros

Nome	Tipo	Descrição
`anchorRowPos`	`Integer`	A lateral superior do controle deslizante é ancorada nessa linha.
`anchorColPos`	`Integer`	A lateral superior do controle está fixada 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 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 para este controle de filtros.

Retornar

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. 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 deste controle de filtros.

Retornar

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 desse título do controle de filtros.

Retornar

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.

Retornar

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

Métodos obsoletos

`getBackgroundColor()`

Obsoleto. Substituído por getBackgroundColorObject()

Retorna a cor de fundo do controle de filtros na notação CSS (como '#ffffff').

Retornar

String: a cor de fundo deste controle de filtros. Retornará null se nenhuma cor estiver 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