Class PivotFilter

PivotFilter

Acessar e modificar filtros da tabela dinâmica.

Métodos

MétodoTipo de retornoBreve descrição
getFilterCriteria()FilterCriteriaRetorna os critérios de filtro para este filtro dinâmico.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse filtro pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem em que esse filtro opera.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna de fonte de dados em que o filtro opera.
remove()voidRemove esse filtro dinâmico da tabela dinâmica.
setFilterCriteria(filterCriteria)PivotFilterDefine os critérios de filtro para este filtro dinâmico.

Documentação detalhada

getFilterCriteria()

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

Retorno

FilterCriteria: os critérios de filtro deste 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 o PivotTable ao qual esse filtro pertence.

Retorno

PivotTable: a tabela dinâmica a que este 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 aplicar a dados na coluna A da planilha, o método retornará "1".

Retorno

Integer: o número da coluna de dados de origem a que este 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 de fonte de dados em que o filtro opera. Retorna null se a tabela dinâmica não é uma {DataSourcePivotTableApi}.

Retorno

DataSourceColumn: a coluna de 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 este filtro dinâmico.

Parâmetros

NomeTipoDescrição
filterCriteriaFilterCriteriaOs critérios de filtro a serem definidos.

Retorno

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