Class PivotValue

Valordepivô

Acessar e modificar grupos de valores em tabelas dinâmicas.

Métodos

MétodoTipo de retornoBreve descrição
getDisplayType()PivotValueDisplayTypeRetorna o tipo de exibição que descreve como esse valor de coluna dinâmica está sendo mostrado na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable a que este valor pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem que o valor dinâmico resume.
getSourceDataSourceColumn()DataSourceColumn|nullRetorna a coluna da fonte de dados que o valor dinâmico resume.
getSummarizedBy()PivotTableSummarizeFunctionRetorna a função de resumo deste grupo.
remove()voidRemova esse valor da tabela dinâmica.
setDisplayName(name)PivotValueDefine o nome de exibição desse valor na tabela dinâmica.
setFormula(formula)PivotValueDefine a fórmula usada para calcular esse valor.
showAs(displayType)PivotValueMostra esse valor na tabela dinâmica como uma função de outro valor.
summarizeBy(summarizeFunction)PivotValueDefine a função de resumo.

Documentação detalhada

getDisplayType()

Retorna o tipo de exibição que descreve como esse valor de coluna dinâmica está sendo mostrado na tabela.

Retornar

PivotValueDisplayType: o tipo de exibição desse valor de coluna 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

getFormula()

Retorna a fórmula usada para calcular esse valor. Se esse valor não for um campo calculado, esse método vai retornar null.

Retornar

String: o valor de pivô 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

getPivotTable()

Retorna o PivotTable a que este valor pertence.

Retornar

PivotTable: a tabela dinâmica a que este valor 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 que o valor dinâmico resume. Esse índice é baseado em 1. Se esse grupo resumir os dados de origem na coluna "A" da planilha, esse método vai retornar 1.

Retornar

Integer: o número da coluna de dados de origem.

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 que o valor dinâmico resume. Retorna null se a tabela dinâmica não for um {DataSourcePivotTableApi}.

Retornar

DataSourceColumn|null: a coluna de origem de dados que o valor dinâmico resume.

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

getSummarizedBy()

Retorna a função de resumo deste grupo.

Retornar

PivotTableSummarizeFunction: a função de resumo do grupo

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

Remova esse valor 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

setDisplayName(name)

Define o nome de exibição desse valor na tabela dinâmica.

Parâmetros

NomeTipoDescrição
nameStringO nome de exibição a ser definido.

Retornar

PivotValue: o valor de pivô 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

setFormula(formula)

Define a fórmula usada para calcular esse valor. Se esse valor não for um campo calculado, esse método vai resultar em um erro.

Parâmetros

NomeTipoDescrição
formulaStringA fórmula usada para calcular esse valor.

Retornar

PivotValue: o valor de pivô 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

showAs(displayType)

Mostra esse valor na tabela dinâmica como uma função de outro valor.

Parâmetros

NomeTipoDescrição
displayTypePivotValueDisplayTypeA maneira de mostrar os valores.

Retornar

PivotValue: o valor de pivô 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

summarizeBy(summarizeFunction)

Define a função de resumo.

Parâmetros

NomeTipoDescrição
summarizeFunctionPivotTableSummarizeFunctionA função a ser usada para resumir os dados na coluna de dados de origem deste valor.

Retornar

PivotValue: o valor de pivô 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