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

Class DataSourceChart

Accédez à un graphique de source de données existant et modifiez-le.

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

Méthodes

Méthode	Type renvoyé	Brève description
`cancelDataRefresh()`	`DataSourceChart`	Annule l'actualisation des données associée à cet objet s'il est en cours d'exécution.
`forceRefreshData()`	`DataSourceChart`	Actualise les données de cet objet, quel que soit l'état actuel.
`getDataSource()`	`DataSource`	Récupère la source de données à laquelle l'objet est associé.
`getStatus()`	`DataExecutionStatus`	Récupère l'état d'exécution des données de l'objet.
`refreshData()`	`DataSourceChart`	Actualise les données de l'objet.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Attend la fin de l'exécution en cours et expire après le nombre de secondes indiqué.

Documentation détaillée

`cancelDataRefresh()`

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

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

La fonction renvoie une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourceChart : 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 l'état actuel. Consultez les refreshData() pour plus de détails. Si vous souhaitez annuler une actualisation en cours de cet objet, consultez cancelDataRefresh().

La fonction renvoie 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

DataSourceChart : 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

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

Renvois

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.

La fonction renvoie une exception si l'état actuel est error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. La méthode est préférable à forceRefreshData() pour éviter des modifications inattendues 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

DataSourceChart : 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

`waitForCompletion(timeoutInSeconds)`

Attend la fin de l'exécution en cours, puis expire après le nombre de secondes indiqué. La fonction renvoie une exception si l'exécution n'est pas terminée à l'expiration du délai, mais n'annule pas la l'exécution des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Temps 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 avec un ou plusieurs des champs d'application suivants :

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