Acessar e modificar as fórmulas da fonte de dados atual Para criar uma nova fórmula da 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 |
|---|---|---|
forceRefreshData() | DataSourceFormula | Atualiza os dados desse objeto, independentemente do estado atual. |
getAnchorCell() | Range | Retorna o Range que representa a célula em que essa fórmula de 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 dessa 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
forceRefreshData()
Atualiza os dados desse objeto, independentemente do estado atual. Consulte refreshData() para
mais detalhes.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() a fim de ativar a execução de dados para um tipo específico de fonte.
Retorno
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 o Range que representa a célula em que essa fórmula de fonte de dados está ancorada.
Retorno
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()
Recebe 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
getDisplayValue()
Retorna o valor de exibição da fórmula da fonte de dados.
Retorno
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 fórmula de fonte de dados.
Retorno
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()
Recebe o status de execução de dados do objeto.
Retorno
DataExecutionStatus — status de execução dos 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 estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método tem preferência em relação a forceRefreshData() para evitar edições inesperadas na fonte de dados.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() a fim de ativar a execução de dados para um tipo específico de fonte.
Retorno
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. |
Retorno
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 fornecido. Gera uma exceção quando a execução não é concluída quando o tempo limite é atingido, mas não cancela 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 — status de execução dos 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