Esta página foi traduzida pela API Cloud Translation.

Class DataSourcePivotTable

Acessar e modificar a tabela dinâmica de fonte de dados atual. Para criar uma nova tabela dinâmica de fonte de dados, use Range.createDataSourcePivotTable(dataSource).

Use essa classe apenas com dados conectados a um banco de dados.

Métodos

Método	Tipo de retorno	Breve descrição
`addColumnGroup(columnName)`	`PivotGroup`	Adiciona um novo grupo de colunas dinâmicas com base na coluna da fonte de dados especificada.
`addFilter(columnName, filterCriteria)`	`PivotFilter`	Adiciona um novo filtro com base na coluna da fonte de dados especificada com os critérios de filtro especificados.
`addPivotValue(columnName, summarizeFunction)`	`PivotValue`	Adiciona um novo valor dinâmico com base na coluna da fonte de dados especificada com a função de resumo especificada.
`addRowGroup(columnName)`	`PivotGroup`	Adiciona um novo grupo de linhas dinâmicas com base na coluna da fonte de dados especificada.
`asPivotTable()`	`PivotTable`	Retorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.
`cancelDataRefresh()`	`DataSourcePivotTable`	Cancela a atualização de dados associada a esse objeto se ele estiver em execução.
`forceRefreshData()`	`DataSourcePivotTable`	Atualiza os dados desse objeto, independentemente do estado atual.
`getDataSource()`	`DataSource`	Extrai a fonte de dados à qual o objeto está vinculado.
`getStatus()`	`DataExecutionStatus`	Recebe o status de execução de dados do objeto.
`refreshData()`	`DataSourcePivotTable`	Atualiza os dados do objeto.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Aguarda a execução atual, expirando após o número fornecido de segundos.

Documentação detalhada

`addColumnGroup(columnName)`

Adiciona um novo grupo de colunas dinâmicas com base na coluna da fonte de dados especificada.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna de origem de dados no qual o grupo dinâmico se baseia.

Retorno

PivotGroup: o novo grupo 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

`addFilter(columnName, filterCriteria)`

Adiciona um novo filtro com base na coluna da fonte de dados especificada com os critérios de filtro especificados.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna de origem de dados no qual o filtro se baseia.
`filterCriteria`	`FilterCriteria`	Os critérios que o filtro usa.

Retorno

PivotFilter: o novo filtro.

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(columnName, summarizeFunction)`

Adiciona um novo valor dinâmico com base na coluna da fonte de dados especificada com a função de resumo especificada.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna de origem de dados em que o valor dinâmico se baseia.
`summarizeFunction`	`PivotTableSummarizeFunction`	A função de resumo que o valor dinâmico usa.

Retorno

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

`addRowGroup(columnName)`

Adiciona um novo grupo de linhas dinâmicas com base na coluna da fonte de dados especificada.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna de origem de dados no qual o grupo dinâmico se baseia.

Retorno

PivotGroup: o novo grupo 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

`asPivotTable()`

Retorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.

Retorno

PivotTable: 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

`cancelDataRefresh()`

Cancela a atualização de dados associada a esse objeto se ele estiver em execução.

Este exemplo mostra como cancelar uma atualização de fórmula.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Uma exceção é gerada se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte.

Retorno

DataSourcePivotTable: o objeto 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

`forceRefreshData()`

Atualiza os dados desse objeto, independentemente do estado atual. Consulte refreshData() para mais detalhes. Se você quiser cancelar uma atualização desse objeto em execução no momento, consulte cancelDataRefresh().

Uma exceção é gerada se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte.

Retorno

DataSourcePivotTable: o objeto 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

`getDataSource()`

Extrai a fonte de dados à qual o objeto está vinculado.

Retorno

DataSource: é a 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

`getStatus()`

Recebe o status de execução de dados do objeto.

Retorno

DataExecutionStatus: o status da execução 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

`refreshData()`

Atualiza os dados do objeto.

Gera uma exceção se atualmente estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. Esse método tem preferência em relação a forceRefreshData() para evitar edições inesperadas na fonte de dados.

Uma exceção é gerada se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte.

Retorno

DataSourcePivotTable: o objeto 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

`waitForCompletion(timeoutInSeconds)`

Aguarda a execução atual, expirando após o número fornecido de segundos. Gera uma exceção se a execução não for concluída ao atingir o tempo limite, mas não cancelará a execução dos dados.

Parâmetros

Nome	Tipo	Descrição
`timeoutInSeconds`	`Integer`	O tempo de espera pela execução dos dados, em segundos. O máximo é de 300 segundos.

Retorno

DataExecutionStatus: o status da execução 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