Class PivotTable

Tabela dinâmica

Acessar e modificar tabelas dinâmicas.

Métodos

MétodoTipo de retornoBreve descrição
addCalculatedPivotValue(name, formula)PivotValueCria um novo valor de pivot na tabela dinâmica calculado com base no formula especificado e no name especificado.
addColumnGroup(sourceDataColumn)PivotGroupDefine um novo grupo de colunas na tabela dinâmica.
addFilter(sourceDataColumn, filterCriteria)PivotFilterCria um novo filtro de tabela dinâmica para a tabela dinâmica.
addPivotValue(sourceDataColumn, summarizeFunction)PivotValueDefine um novo valor de pivot na tabela dinâmica com o summarizeFunction especificado.
addRowGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento de linhas de pivot na tabela dinâmica.
asDataSourcePivotTable()DataSourcePivotTableRetorna a tabela dinâmica como uma tabela dinâmica da fonte de dados se ela estiver vinculada a um DataSource ou null.
getAnchorCell()RangeRetorna a 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()RangeRetorna o intervalo de dados de origem em que a tabela dinâmica é construída.
getValuesDisplayOrientation()DimensionRetorna se os valores são mostrados como linhas ou colunas.
remove()voidExclui essa tabela dinâmica.
setValuesDisplayOrientation(dimension)PivotTableDefine o layout dessa tabela dinâmica para mostrar valores como colunas ou linhas.

Documentação detalhada

addCalculatedPivotValue(name, formula)

Cria um novo valor de pivot na tabela dinâmica calculado com base no formula especificado e no name especificado.

Parâmetros

NomeTipoDescrição
nameStringO nome desse valor de pivote calculado.
formulaStringA fórmula usada para calcular esse valor.

Retornar

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 grupo de colunas na tabela dinâmica. O sourceDataColumn especificado indica a coluna nos dados de origem em que esse agrupamento se baseia.

Parâmetros

NomeTipoDescrição
sourceDataColumnIntegerO número da coluna resumida por este grupo. Esse índice representa o número absoluto da coluna na planilha: 1 representa a coluna "A", 2 representa a coluna B etc.

Retornar

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 o filtro opera.

Parâmetros

NomeTipoDescrição
sourceDataColumnIntegerO número da coluna resumida por este grupo. Esse índice representa o número absoluto da coluna na planilha: 1 representa a coluna "A", 2 representa a coluna B etc.
filterCriteriaFilterCriteriaOs critérios de filtro usados para realizar a filtragem.

Retornar

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 de pivot 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

NomeTipoDescrição
sourceDataColumnIntegerO número da coluna resumida por este grupo. Esse índice representa o número absoluto da coluna na planilha: 1 representa a coluna "A", 2 representa a coluna B etc.
summarizeFunctionPivotTableSummarizeFunction

Retornar

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 de pivot na tabela dinâmica. O sourceDataColumn especificado indica a coluna nos dados de origem em que esse agrupamento se baseia.

Parâmetros

NomeTipoDescrição
sourceDataColumnIntegerO número da coluna resumida por este grupo. Esse índice representa o número absoluto da coluna na planilha: 1 representa a coluna "A", 2 representa a coluna B etc.

Retornar

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

Retorna a tabela dinâmica como uma tabela dinâmica da fonte de dados se ela estiver vinculada a um DataSource ou null.

Retornar

DataSourcePivotTable: uma tabela dinâmica da 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 a Range que representa a célula em que essa tabela dinâmica está ancorada.

Retornar

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

getColumnGroups()

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

Retornar

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.

Retornar

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.

Retornar

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.

Retornar

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.

Retornar

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 mostrados como linhas ou colunas.

Retornar

Dimension: se os valores são mostrados 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 essa tabela dinâmica. Outras operações nessa tabela dinâmica resultam em um 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 mostrar valores como colunas ou linhas.

Parâmetros

NomeTipoDescrição
dimensionDimensionA dimensão que indica como exibir os valores de pivot.

Retornar

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