Class DataSourceFormula

DataSourceFormula

Accédez aux formules de source de données existantes et modifiez-les. Pour créer une formule de source de données, utilisez Range.setFormula(formula).

N'utilisez cette classe qu'avec des données connectées à une base de données BigQuery.

Méthodes

MéthodeType renvoyéBrève description
cancelDataRefresh()DataSourceFormulaAnnule l'actualisation des données associée à cet objet si elle est en cours d'exécution.
forceRefreshData()DataSourceFormulaActualise les données de cet objet, quel que soit son état actuel.
getAnchorCell()RangeRenvoie la Range représentant la cellule dans laquelle cette formule de source de données est ancrée.
getDataSource()DataSourceObtient la source de données à laquelle l'objet est lié.
getDisplayValue()StringRenvoie la valeur d'affichage de la formule de source de données.
getFormula()StringRenvoie la formule de cette formule de source de données.
getStatus()DataExecutionStatusObtient l'état d'exécution des données de l'objet.
refreshData()DataSourceFormulaActualise les données de l'objet.
setFormula(formula)DataSourceFormulaMet à jour la formule.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttend la fin de l'exécution actuelle, avec un délai d'attente après le nombre de secondes fourni.

Documentation détaillée

cancelDataRefresh()

Annule l'actualisation des données associée à cet objet si elle est en cours d'exécution.

Cet exemple montre comment annuler l'actualisation d'une formule. 

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

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceFormula : l'objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

forceRefreshData()

Actualise les données de cet objet, quel que soit son état actuel. Pour en savoir plus, consultez refreshData(). Si vous souhaitez annuler une actualisation en cours de cet objet, consultez cancelDataRefresh().

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceFormula : l'objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getAnchorCell()

Renvoie la Range représentant la cellule dans laquelle cette formule de source de données est ancrée.

Renvois

Range : la cellule d'ancrage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getDataSource()

Obtient la source de données à laquelle l'objet est lié.

Renvois

DataSource : la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getDisplayValue()

Renvoie la valeur d'affichage de la formule de source de données.

Renvois

String : la valeur d'affichage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getFormula()

Renvoie la formule de cette formule de source de données.

Renvois

String : la formule.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

getStatus()

Obtient l'état d'exécution des données de l'objet.

Renvois

DataExecutionStatus : l'état d'exécution des données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

refreshData()

Actualise les données de l'objet.

Génère une exception si l'état actuel est error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. Cette méthode est préférable à forceRefreshData() pour éviter toute modification inattendue de la source de données.

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceFormula : l'objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

setFormula(formula)

Met à jour la formule.

Paramètres

NomTypeDescription
formulaStringLa nouvelle formule.

Renvois

DataSourceFormula : la formule de source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

waitForCompletion(timeoutInSeconds)

Attend la fin de l'exécution actuelle, avec un délai d'attente après le nombre de secondes fourni. Génère une exception si l'exécution n'est pas terminée lorsque le délai d'attente est dépassé, mais n'annule pas l'exécution des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerLe délai d'attente pour l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Renvois

DataExecutionStatus : l'état d'exécution des données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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