Esta página foi traduzida pela API Cloud Translation.

Class DataSourceFormula

(link em inglês)

Acesse e modifique fórmulas de fonte de dados existentes. Para criar uma nova fórmula de fonte de dados, use Range.setFormula(formula).

Use essa classe apenas com os dados que estão conectados a um banco de dados.

Métodos

Método	Tipo de retorno	Breve descrição
`forceRefreshData()`	`DataSourceFormula`	Atualiza os dados deste objeto, independentemente do estado atual.
`getAnchorCell()`	`Range`	Retorna a `Range` que representa a célula em que a fórmula da fonte de dados está ancorada.
`getDataSource()`	`DataSource`	Acessa a fonte de dados vinculada ao objeto.
`getDisplayValue()`	`String`	Retorna o valor de exibição da fórmula da fonte de dados.
`getFormula()`	`String`	Retorna a fórmula dessa fonte de dados.
`getStatus()`	`DataExecutionStatus`	Acessa 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 informado.

Documentação detalhada

`forceRefreshData()`

Atualiza os dados deste objeto, independentemente do estado atual. Consulte refreshData() para ver mais detalhes.

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

Retornar

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

`getAnchorCell()`

Retorna a 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 exigem autorização com um ou mais dos seguintes escopos:

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

`getDataSource()`

Acessa a fonte de dados vinculada ao objeto.

Retornar

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

`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 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 dessa fonte de dados.

Retornar

String: a fórmula.

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

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

Retornar

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.

Lança uma exceção se estiver 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 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)`

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 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 até que a execução atual seja concluída, expirando após o número de segundos informado. Emite uma exceção se a execução não é concluída ao expirar, mas não cancela a execução de dados.

Parâmetros

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

Retornar

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