Class PivotValue

PivotValue

Acesse e modifique 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 dinâmico é exibido na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse valor pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem resumido pelo valor dinâmico.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna de fonte de dados resumida pelo valor dinâmico.
getSummarizedBy()PivotTableSummarizeFunctionRetorna a função de resumo desse 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)PivotValueExibe 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 dinâmico é exibido na tabela.

Retorno

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

getFormula()

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

Retorno

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

getPivotTable()

Retorna o PivotTable ao qual esse valor pertence.

Retorno

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

Retorno

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 de fonte de dados resumida pelo valor dinâmico. Retorna null se a tabela dinâmica não for uma {DataSourcePivotTableApi}.

Retorno

DataSourceColumn: a coluna de fonte de dados de origem resumida pelo valor 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

getSummarizedBy()

Retorna a função de resumo desse grupo.

Retorno

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.

Retorno

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

setFormula(formula)

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

Parâmetros

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

Retorno

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

showAs(displayType)

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

Parâmetros

NomeTipoDescrição
displayTypePivotValueDisplayTypeA maneira de exibir os valores.

Retorno

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

summarizeBy(summarizeFunction)

Define a função de resumo.

Parâmetros

NomeTipoDescrição
summarizeFunctionPivotTableSummarizeFunctionFunção a ser usada para resumir dados na coluna de dados de origem desse valor.

Retorno

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