Acessar e modificar um gráfico de fonte de dados existente.
Use essa classe apenas com dados conectados a um banco de dados do BigQuery.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
cancelDataRefresh() | DataSourceChart | Cancela a atualização de dados associada a esse objeto se ela estiver em execução. |
forceRefreshData() | DataSourceChart | Atualiza os dados desse 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() | DataSourceChart | 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
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. Use os métodos SpreadsheetApp#enable...Execution()
para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
DataSourceChart
: 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 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()
.
Gera 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
DataSourceChart
: 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
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.
Gera uma exceção 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 de dados.
Retornar
DataSourceChart
: 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
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 de 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 exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets