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.

Metodi

MetodoTipo restituitoBreve descrizione
cancelDataRefresh()DataSourceFormulaAnnulla l'aggiornamento dei dati associato a questo 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 di visualizzazione della formula dell'origine dati.
getFormula()StringRestituisce la formula per questa 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()

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

Questo esempio mostra come annullare l'aggiornamento di una 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 abilitare l'esecuzione dei dati per un tipo di origine dati specifico.

Ritorni

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. Per ulteriori dettagli, visita la pagina refreshData(). Se vuoi annullare un aggiornamento attualmente in esecuzione di questo oggetto, vedi cancelDataRefresh().

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

Ritorni

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 Range che rappresenta la cella a cui è ancorata questa formula dell'origine dati.

Ritorni

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.

Ritorni

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 di visualizzazione della formula dell'origine dati.

Ritorni

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 questa formula dell'origine dati.

Ritorni

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

Restituisce lo stato di esecuzione dei dati dell'oggetto.

Ritorni

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 lo stato è error. Utilizza DataSource#updateSpec() per aggiornare la specifica. Questo 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 abilitare l'esecuzione dei dati per un tipo di origine dati specifico.

Ritorni

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.

Ritorni

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 viene completata al momento del timeout, ma non annulla l'esecuzione dei dati.

Parametri

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

Ritorni

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