Esta página foi traduzida pela API Cloud Translation.

Class DataSourceFormula

Acessar e modificar fórmulas de fontes de dados atuais. Para criar uma nova fórmula de fonte de dados, use Range.setFormula(formula).

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

Métodos

Método	Tipo de retorno	Breve descrição
`cancelDataRefresh()`	`DataSourceFormula`	Cancela a atualização de dados associada ao objeto se ele estiver em execução no momento.
`forceRefreshData()`	`DataSourceFormula`	Atualiza os dados deste objeto, independentemente do estado atual.
`getAnchorCell()`	`Range`	Retorna o `Range` que representa a célula em que a fórmula da fonte de dados está ancorada.
`getDataSource()`	`DataSource`	Recebe a fonte de dados à qual o objeto está vinculado.
`getDisplayValue()`	`String`	Retorna o valor de exibição da fórmula da fonte de dados.
`getFormula()`	`String`	Retorna a fórmula para essa fórmula de fonte de dados.
`getStatus()`	`DataExecutionStatus`	Recebe o status de execução de dados do objeto.
`refreshData()`	`DataSourceFormula`	Atualiza os dados do objeto.
`setFormula(formula)`	`DataSourceFormula`	Atualiza a fórmula.
`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

`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

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

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

`getAnchorCell()`

Retorna o Range que representa a célula em que a fórmula da fonte de dados está ancorada.

Retornar

Range: a célula âncora.

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

`getDisplayValue()`

Retorna o valor de exibição da fórmula da fonte de dados.

Retornar

String — o valor de exibição.

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

`getFormula()`

Retorna a fórmula para essa fórmula de fonte de dados.

Retornar

String: a fórmula.

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

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

`setFormula(formula)`

Atualiza a fórmula.

Parâmetros

Nome	Tipo	Descrição
`formula`	`String`	A nova fórmula.

Retornar

DataSourceFormula: a fórmula da fonte de dados para encadeamento.

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