Class DataSourceFormula

DataSourceFormula

Accedere alle formule dell'origine dati esistenti e modificarle. Per creare una nuova formula dell'origine dati, utilizza Range.setFormula(formula).

Utilizza questa classe solo con i dati collegati a un database BigQuery.

Metodi

MetodoTipo restituitoBreve descrizione
cancelDataRefresh()DataSourceFormulaAnnulla l'aggiornamento dei dati associato all'oggetto se è attualmente in esecuzione.
forceRefreshData()DataSourceFormulaAggiorna i dati dell'oggetto indipendentemente dallo stato attuale.
getAnchorCell()RangeRestituisce Range che rappresenta la cella a cui è ancorata questa formula dell'origine dati.
getDataSource()DataSourceRecupera l'origine dati a cui è collegato l'oggetto.
getDisplayValue()StringRestituisce il valore visualizzato della formula dell'origine dati.
getFormula()StringRestituisce la formula per la formula dell'origine dati.
getStatus()DataExecutionStatusRestituisce lo stato di esecuzione dei dati dell'oggetto.
refreshData()DataSourceFormulaAggiorna i dati dell'oggetto.
setFormula(formula)DataSourceFormulaAggiorna la formula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato.

Documentazione dettagliata

cancelDataRefresh()

Annullerà l'aggiornamento dei dati associato a questo oggetto se è attualmente in esecuzione.

Questo esempio mostra come annullare un aggiornamento della formula. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

Invio

DataSourceFormula: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

forceRefreshData()

Aggiorna i dati dell'oggetto indipendentemente dallo stato attuale. Vedi refreshData() per ulteriori dettagli. Se vuoi annullare un aggiornamento attualmente in esecuzione di questo oggetto, consulta cancelDataRefresh().

Viene lanciata un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un'origine dati specifica di testo.

Invio

DataSourceFormula: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getAnchorCell()

Restituisce il Range che rappresenta la cella in cui è ancorata la formula dell'origine dati.

Invio

Range: la cella di ancoraggio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSource()

Recupera l'origine dati a cui è collegato l'oggetto.

Invio

DataSource: l'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDisplayValue()

Restituisce il valore visualizzato della formula dell'origine dati.

Invio

String: il valore visualizzato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFormula()

Restituisce la formula per la formula dell'origine dati.

Invio

String: la formula.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getStatus()

Recupera lo stato di esecuzione dei dati dell'oggetto.

Invio

DataExecutionStatus: lo stato di esecuzione dei dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

refreshData()

Aggiorna i dati dell'oggetto.

Genera un'eccezione se attualmente è nello stato error. Utilizza DataSource#updateSpec() per aggiornare la specifica. Il metodo è preferito rispetto a forceRefreshData() per evitare modifiche impreviste all'origine dati.

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un'origine dati specifica di testo.

Invio

DataSourceFormula: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setFormula(formula)

Aggiorna la formula.

Parametri

NomeTipoDescrizione
formulaStringLa nuova formula.

Invio

DataSourceFormula: la formula dell'origine dati per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

waitForCompletion(timeoutInSeconds)

Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. Genera un'eccezione se l'esecuzione non è completata al termine del timeout, ma non annulla l'esecuzione dei dati.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa dell'esecuzione dei dati, in secondi. Il massimo è 300 secondi.

Invio

DataExecutionStatus: lo stato di esecuzione dei dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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