Esta página foi traduzida pela API Cloud Translation.

Class DataSourcePivotTable

Acessar e modificar a tabela dinâmica de fontes de dados existentes. 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 de 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 especificados.
`addPivotValue(columnName, summarizeFunction)`	`PivotValue`	Adiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com o resumo especificado função.
`addRowGroup(columnName)`	`PivotGroup`	Adiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada.
`asPivotTable()`	`PivotTable`	Retorna a tabela dinâmica de fonte de dados como um objeto de tabela dinâmica normal.
`cancelDataRefresh()`	`DataSourcePivotTable`	Cancela a atualização de dados associada ao objeto se ele estiver em execução no momento.
`forceRefreshData()`	`DataSourcePivotTable`	Atualiza os dados deste objeto, independentemente do estado atual.
`getDataSource()`	`DataSource`	Recebe 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 até que a execução atual seja concluída, expirando após o número de segundos fornecido.

Documentação detalhada

`addColumnGroup(columnName)`

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

Parâmetros

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

Retornar

PivotGroup: o novo grupo dinâmico.

Autorização

Os scripts que usam esse método precisam de 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 especificados.

Parâmetros

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

Retornar

PivotFilter: o novo filtro.

Autorização

Os scripts que usam esse método precisam de 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 de fonte de dados especificada com o resumo especificado função.

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 usada pelo valor dinâmico.

Retornar

PivotValue: o novo valor dinâmico.

Autorização

Os scripts que usam esse método precisam de 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 de fonte de dados especificada.

Parâmetros

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

Retornar

PivotGroup: o novo grupo dinâmico.

Autorização

Os scripts que usam esse método precisam de 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 de fonte de dados como um objeto de tabela dinâmica normal.

Retornar

PivotTable: a tabela dinâmica.

Autorização

Os scripts que usam esse método precisam de 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 ao objeto se ele estiver em execução no momento.

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

Lança uma exceção se o tipo de fonte de dados não estiver ativado. Usar métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados em uma fonte de dados específica não é válido.

Retornar

DataSourcePivotTable: o objeto de dados.

Autorização

Os scripts que usam esse método precisam de 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 deste 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().

Retornar

DataSourcePivotTable: o objeto de dados.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDataSource()`

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

Retornar

DataSource: a fonte de dados.

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

DataExecutionStatus: o status de execução dos dados.

Autorização

Os scripts que usam esse método precisam de 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 no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método é tem preferência sobre forceRefreshData() para evitar edições inesperadas na fonte de dados.

Retornar

DataSourcePivotTable: o objeto de dados.

Autorização

Os scripts que usam esse método precisam de 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 até que a execução atual seja concluída, expirando após o número de segundos fornecido. Gera uma exceção se a execução não é concluída ao atingir o tempo limite, mas não cancela a 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 é 300 segundos.

Retornar

DataExecutionStatus: o status de execução dos dados.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets