Class PivotFilter

PivotFilter

Acessar e modificar filtros de tabela dinâmica.

Métodos

Método	Tipo de retorno	Breve descrição
getFilterCriteria()	FilterCriteria	Retorna os critérios de filtro para esse filtro dinâmico.
getPivotTable()	PivotTable	Retorna o PivotTable a que esse filtro pertence.
getSourceDataColumn()	Integer	Retorna o número da coluna de dados de origem em que esse filtro opera.
getSourceDataSourceColumn()	DataSourceColumn|null	Retorna a coluna da fonte de dados em que o filtro opera.
remove()	void	Remove esse filtro dinâmico da tabela dinâmica.
setFilterCriteria(filterCriteria)	PivotFilter	Define os critérios de filtro para esse filtro dinâmico.

Documentação detalhada

getFilterCriteria()

Retorna os critérios de filtro para esse filtro dinâmico.

Retornar

FilterCriteria: os critérios de filtro para esse filtro dinâmico.

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

---

getPivotTable()

Retorna a PivotTable a que esse filtro pertence.

Retornar

PivotTable: a tabela dinâmica a que esse filtro pertence.

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

---

getSourceDataColumn()

Retorna o número da coluna de dados de origem em que esse filtro opera. Esses índices são baseados em 1. Por exemplo, se esse filtro se aplica aos dados na coluna A da planilha, esse método retorna "1".

Retornar

Integer: o número da coluna de dados de origem a que esse filtro se aplica.

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

---

getSourceDataSourceColumn()

Retorna a coluna da fonte de dados em que o filtro opera. Retorna null se a tabela dinâmica não for uma {DataSourcePivotTableApi}.

Retornar

DataSourceColumn|null: a coluna da fonte de dados em que o filtro opera.

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()

Remove esse filtro dinâmico da tabela dinâmica.

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

---

setFilterCriteria(filterCriteria)

Define os critérios de filtro para esse filtro dinâmico.

Parâmetros

Nome	Tipo	Descrição
filterCriteria	FilterCriteria	Os critérios de filtro a serem definidos.

Retornar

PivotFilter: o filtro dinâmico 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