Class DataSourceFormula

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 do BigQuery.

Métodos

MétodoTipo de retornoBreve descrição
cancelDataRefresh()DataSourceFormulaCancela a atualização de dados associada a esse objeto, se ela estiver em execução.
forceRefreshData()DataSourceFormulaAtualiza os dados desse objeto, independente do estado atual.
getAnchorCell()RangeRetorna o Range que representa a célula em que essa fórmula de fonte de dados está ancorada.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getDisplayValue()StringRetorna o valor de exibição da fórmula da fonte de dados.
getFormula()StringRetorna a fórmula da fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceFormulaAtualiza os dados do objeto.
setFormula(formula)DataSourceFormulaAtualiza a fórmula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

Documentação detalhada

cancelDataRefresh()

Cancela a atualização de dados associada a esse objeto, se ela 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();

Gera uma exceção 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

forceRefreshData()

Atualiza os dados desse objeto, independente do estado atual. Consulte refreshData() para mais detalhes. Se quiser cancelar uma atualização em andamento desse objeto, consulte cancelDataRefresh().

Gera uma exceção 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 o Range que representa a célula em que essa fórmula de fonte de dados está ancorada.

Retornar

Range: a célula de ancoragem.

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 a que o objeto está vinculado.

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

Recebe 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.

Gera uma exceção se estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método é preferível a 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 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

setFormula(formula)

Atualiza a fórmula.

Parâmetros

NomeTipoDescrição
formulaStringA 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)

Aguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido. Gera uma exceção se a execução não for concluída quando o tempo limite expirar, mas não cancela a execução de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerO tempo de espera para a execução de dados, em segundos. O máximo é 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