Class DataSourceFormula

Formule DataSource

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

Utilisez cette classe uniquement avec les données connectées à une base de données.

Méthodes

MéthodeType renvoyéBrève description
forceRefreshData()DataSourceFormulaActualise les données de cet objet, quel que soit leur état actuel.
getAnchorCell()RangeRenvoie le Range représentant la cellule où cette formule de source de données est ancrée.
getDataSource()DataSourceRécupère la source de données à laquelle l'objet est associé.
getDisplayValue()StringAffiche la valeur à afficher de la formule de la source de données.
getFormula()StringAffiche la formule de cette formule de source de données.
getStatus()DataExecutionStatusRécupère 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 en cours. Le délai expire après le nombre de secondes indiqué.

Documentation détaillée

forceRefreshData()

Actualise les données de cet objet, quel que soit leur état actuel. Pour en savoir plus, consultez refreshData().

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

Aller-retour

DataSourceFormula : 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 le Range représentant la cellule où cette formule de source de données est ancrée.

Aller-retour

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

Récupère la source de données à laquelle l'objet est associé.

Aller-retour

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

Affiche la valeur à afficher de la formule de la source de données.

Aller-retour

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

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

Aller-retour

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

Récupère l'état d'exécution des données de l'objet.

Aller-retour

DataExecutionStatus : é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.

Lève 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.

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

Aller-retour

DataSourceFormula : 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.

Aller-retour

DataSourceFormula : formule de la 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 en cours. Le délai expire après le nombre de secondes indiqué. Lève une exception si l'exécution n'est pas terminée lors de l'expiration du délai, mais n'annule pas l'exécution des données.

Paramètres

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

Aller-retour

DataExecutionStatus : é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