Cette page a été traduite par l'API Cloud Translation.

Class DataSourceFormula

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

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

Méthodes

Méthode	Type renvoyé	Brève description
`cancelDataRefresh()`	`DataSourceFormula`	Annule l'actualisation des données associées à cet objet s'il est en cours d'exécution.
`forceRefreshData()`	`DataSourceFormula`	Actualise les données de cet objet, quel que soit l'état actuel.
`getAnchorCell()`	`Range`	Renvoie la valeur `Range` représentant la cellule dans laquelle la formule de cette source de données est ancrée.
`getDataSource()`	`DataSource`	Récupère la source de données à laquelle l'objet est associé.
`getDisplayValue()`	`String`	Renvoie la valeur d'affichage de la formule de la source de données.
`getFormula()`	`String`	Affiche la formule de cette source de données.
`getStatus()`	`DataExecutionStatus`	Récupère l'état d'exécution des données de l'objet.
`refreshData()`	`DataSourceFormula`	Actualise les données de l'objet.
`setFormula(formula)`	`DataSourceFormula`	Met à jour la formule.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Attend la fin de l'exécution en cours, qui expire après le nombre de secondes spécifié.

Documentation détaillée

`cancelDataRefresh()`

Annule l'actualisation des données associées à cet objet s'il 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();

Une exception est générée 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 des données pour un type de source de données spécifique.

Renvois

DataSourceFormula : objet de données

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'état actuel. Pour en savoir plus, consultez refreshData(). Si vous souhaitez annuler une actualisation en cours de cet objet, consultez cancelDataRefresh().

Renvois

DataSourceFormula : objet de données

Autorisation

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

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

`getAnchorCell()`

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

Renvois

Range : cellule d'ancrage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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é.

Renvois

DataSource : source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 la source de données.

Renvois

String : valeur d'affichage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 source de données.

Renvois

String : formule.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 les modifications inattendues de la source de données.

Renvois

DataSourceFormula : objet de données

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

Nom	Type	Description
`formula`	`String`	Nouvelle formule.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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, qui expire après le nombre de secondes spécifié. Elle génère une exception si l'exécution n'est pas terminée lorsque le délai a expiré, mais n'annule pas l'exécution des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Délai d'attente de l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Renvois

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

Autorisation

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

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