Esta página foi traduzida pela API Cloud Translation.

Class PivotTable

Acessar e modificar tabelas dinâmicas.

Métodos

Método	Tipo de retorno	Breve descrição
`addCalculatedPivotValue(name, formula)`	`PivotValue`	Cria um novo valor dinâmico na tabela dinâmica calculado a partir do `formula` especificado com o `name` especificado.
`addColumnGroup(sourceDataColumn)`	`PivotGroup`	Define um novo agrupamento de colunas na tabela dinâmica.
`addFilter(sourceDataColumn, filterCriteria)`	`PivotFilter`	Cria um novo filtro de tabela dinâmica para a tabela dinâmica.
`addPivotValue(sourceDataColumn, summarizeFunction)`	`PivotValue`	Define um novo valor dinâmico na tabela dinâmica com o `summarizeFunction` especificado.
`addRowGroup(sourceDataColumn)`	`PivotGroup`	Define um novo agrupamento de linhas dinâmicas na tabela dinâmica.
`asDataSourcePivotTable()`	`DataSourcePivotTable`	Retornará a tabela dinâmica como tabela dinâmica de fonte de dados se estiver vinculada a uma `DataSource`. Caso contrário, retornará `null`.
`getAnchorCell()`	`Range`	Retorna o `Range` que representa a célula em que essa tabela dinâmica está ancorada.
`getColumnGroups()`	`PivotGroup[]`	Retorna uma lista ordenada dos grupos de colunas nesta tabela dinâmica.
`getFilters()`	`PivotFilter[]`	Retorna uma lista ordenada dos filtros nesta tabela dinâmica.
`getPivotValues()`	`PivotValue[]`	Retorna uma lista ordenada dos valores dinâmicos nesta tabela dinâmica.
`getRowGroups()`	`PivotGroup[]`	Retorna uma lista ordenada dos grupos de linhas nesta tabela dinâmica.
`getSourceDataRange()`	`Range`	Retorna o intervalo de dados de origem em que a tabela dinâmica é construída.
`getValuesDisplayOrientation()`	`Dimension`	Retorna se os valores são exibidos como linhas ou colunas.
`remove()`	`void`	Exclui esta tabela dinâmica.
`setValuesDisplayOrientation(dimension)`	`PivotTable`	Define o layout dessa tabela dinâmica para exibir valores como colunas ou linhas.

Documentação detalhada

`addCalculatedPivotValue(name, formula)`

Cria um novo valor dinâmico na tabela dinâmica calculado a partir do formula especificado com o name especificado.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome deste valor dinâmico calculado.
`formula`	`String`	A fórmula usada para calcular esse valor.

Retorno

PivotValue: o PivotValue recém-criado

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

`addColumnGroup(sourceDataColumn)`

Define um novo agrupamento de colunas na tabela dinâmica. O sourceDataColumn especificado indica a coluna nos dados de origem em que o agrupamento é baseado.

Parâmetros

Nome	Tipo	Descrição
`sourceDataColumn`	`Integer`	O número da coluna que este grupo resume. Esse índice representa o número absoluto da coluna na planilha; `1` representa a coluna "A", `2` representa a coluna B etc.

Retorno

PivotGroup: o PivotGroup recém-criado

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

`addFilter(sourceDataColumn, filterCriteria)`

Cria um novo filtro de tabela dinâmica para a tabela dinâmica. O sourceDataColumn especificado indica a coluna nos dados de origem em que esse filtro opera.

Parâmetros

Nome	Tipo	Descrição
`sourceDataColumn`	`Integer`	O número da coluna que este grupo resume. Esse índice representa o número absoluto da coluna na planilha; `1` representa a coluna "A", `2` representa a coluna B etc.
`filterCriteria`	`FilterCriteria`	Os critérios de filtro usados para executar a filtragem.

Retorno

PivotFilter: o PivotFilter recém-criado

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

`addPivotValue(sourceDataColumn, summarizeFunction)`

Define um novo valor dinâmico na tabela dinâmica com o summarizeFunction especificado. O sourceDataColumn especificado indica a coluna nos dados de origem em que esse valor se baseia.

Parâmetros

Nome	Tipo	Descrição
`sourceDataColumn`	`Integer`	O número da coluna que este grupo resume. Esse índice representa o número absoluto da coluna na planilha; `1` representa a coluna "A", `2` representa a coluna B etc.
`summarizeFunction`	`PivotTableSummarizeFunction`

Retorno

PivotValue: o PivotValue recém-criado

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

`addRowGroup(sourceDataColumn)`

Define um novo agrupamento de linhas dinâmicas na tabela dinâmica. O sourceDataColumn especificado indica a coluna nos dados de origem em que o agrupamento é baseado.

Parâmetros

Nome	Tipo	Descrição
`sourceDataColumn`	`Integer`	O número da coluna que este grupo resume. Esse índice representa o número absoluto da coluna na planilha; `1` representa a coluna "A", `2` representa a coluna B etc.

Retorno

PivotGroup: o PivotGroup recém-criado

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

`asDataSourcePivotTable()`

Retornará a tabela dinâmica como tabela dinâmica de fonte de dados se estiver vinculada a uma DataSource. Caso contrário, retornará null.

Retorno

DataSourcePivotTable: uma tabela dinâmica de fonte de dados.

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

`getAnchorCell()`

Retorna o Range que representa a célula em que essa tabela dinâmica está ancorada.

Retorno

Range: célula âncora desta 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

`getColumnGroups()`

Retorna uma lista ordenada dos grupos de colunas nesta tabela dinâmica.

Retorno

PivotGroup[]: os grupos de colunas nesta 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

`getFilters()`

Retorna uma lista ordenada dos filtros nesta tabela dinâmica.

Retorno

PivotFilter[]: os filtros desta 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

`getPivotValues()`

Retorna uma lista ordenada dos valores dinâmicos nesta tabela dinâmica.

Retorno

PivotValue[]: os valores dinâmicos nesta 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

`getRowGroups()`

Retorna uma lista ordenada dos grupos de linhas nesta tabela dinâmica.

Retorno

PivotGroup[]: os grupos de linhas nesta 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

`getSourceDataRange()`

Retorna o intervalo de dados de origem em que a tabela dinâmica é construída.

Retorno

Range: o intervalo de dados de origem desta 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

`getValuesDisplayOrientation()`

Retorna se os valores são exibidos como linhas ou colunas.

Retorno

Dimension: se os valores são exibidos como linhas ou colunas.

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 esta tabela dinâmica. Outras operações nessa tabela dinâmica resultam em erro.

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

`setValuesDisplayOrientation(dimension)`

Define o layout dessa tabela dinâmica para exibir valores como colunas ou linhas.

Parâmetros

Nome	Tipo	Descrição
`dimension`	`Dimension`	A dimensão que indica como exibir valores dinâmicos.

Retorno

PivotTable: a tabela dinâmica 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