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 a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourceFormula | Atualiza os dados desse objeto, independentemente do estado atual. |
getAnchorCell() | Range | Retorna Range que representa a célula em que essa fórmula de fonte de dados está ancorada. |
getDataSource() | DataSource | Extrai 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 a execução atual, expirando após o número fornecido de segundos. |
Documentação detalhada
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
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
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
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 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()
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
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
: 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
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 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