Class PivotValue

PivotValue

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

Métodos

Método	Tipo de retorno	Breve descrição
getDisplayType()	PivotValueDisplayType	Retorna o tipo de tela que descreve como esse valor dinâmico é mostrado na tabela.
getFormula()	String	Retorna a fórmula usada para calcular esse valor.
getPivotTable()	PivotTable	Retorna o PivotTable a que esse valor pertence.
getSourceDataColumn()	Integer	Retorna o número da coluna de dados de origem que o valor dinâmico resume.
getSourceDataSourceColumn()	DataSourceColumn|null	Retorna a coluna de fonte de dados que o valor dinâmico resume.
getSummarizedBy()	PivotTableSummarizeFunction	Retorna a função de resumo desse grupo.
remove()	void	Remove esse valor da tabela dinâmica.
setDisplayName(name)	PivotValue	Define o nome de exibição desse valor na tabela dinâmica.
setFormula(formula)	PivotValue	Define a fórmula usada para calcular esse valor.
showAs(displayType)	PivotValue	Mostra esse valor na tabela dinâmica como uma função de outro valor.
summarizeBy(summarizeFunction)	PivotValue	Define a função de resumo.

Documentação detalhada

getDisplayType()

Retorna o tipo de tela que descreve como esse valor dinâmico é mostrado na tabela.

Retornar

PivotValueDisplayType: o tipo de tela desse 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 vai retornar null.

Retornar

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 a PivotTable a que esse valor pertence.

Retornar

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

Retornar

DataSourceColumn|null: a coluna de fonte de dados de origem 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 desse 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()

Remove 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

Nome	Tipo	Descrição
name	String	O nome de exibição a ser definido.

Retornar

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 vai gerar um erro.

Parâmetros

Nome	Tipo	Descrição
formula	String	A fórmula a ser usada para calcular esse valor.

Retornar

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)

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

Parâmetros

Nome	Tipo	Descrição
displayType	PivotValueDisplayType	A maneira de mostrar os valores.

Retornar

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

Nome	Tipo	Descrição
summarizeFunction	PivotTableSummarizeFunction	A função a ser usada para resumir os dados na coluna de dados de origem desse valor.

Retornar

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