Class DataSourceChart

DataSourceChart

Auf ein vorhandenes Datenquellendiagramm zugreifen und es ändern

Verwenden Sie diese Klasse nur mit Daten, die mit einer BigQuery-Datenbank verbunden sind.

Methoden

MethodeRückgabetypKurzbeschreibung
cancelDataRefresh()DataSourceChartBricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.
forceRefreshData()DataSourceChartAktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
getDataSource()DataSourceRuft die Datenquelle ab, mit der das Objekt verknüpft ist.
getStatus()DataExecutionStatusRuft den Status der Datenabfrage des Objekts ab.
refreshData()DataSourceChartAktualisiert die Daten des Objekts.
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden tritt eine Zeitüberschreitung auf.

Detaillierte Dokumentation

cancelDataRefresh()

Bricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie eine Formelaktualisierung abbrechen. 

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

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie die Methoden SpreadsheetApp#enable...Execution(), um die Datenabfrage für einen bestimmten Datenquellentyp zu aktivieren.

Rückflug

DataSourceChart : Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

forceRefreshData()

Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. Weitere Informationen finden Sie unter refreshData(). Wenn Sie eine aktuell laufende Aktualisierung dieses Objekts abbrechen möchten, lesen Sie cancelDataRefresh().

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie die Methoden SpreadsheetApp#enable...Execution(), um die Datenabfrage für einen bestimmten Datenquellentyp zu aktivieren.

Rückflug

DataSourceChart : Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getDataSource()

Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.

Rückflug

DataSource : Die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getStatus()

Ruft den Status der Datenabfrage des Objekts ab.

Rückflug

DataExecutionStatus : Der Status der Datenabfrage.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

refreshData()

Aktualisiert die Daten des Objekts.

Löst eine Ausnahme aus, wenn der Status derzeit error ist. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Die Methode wird gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu vermeiden.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie die Methoden SpreadsheetApp#enable...Execution(), um die Datenabfrage für einen bestimmten Datenquellentyp zu aktivieren.

Rückflug

DataSourceChart : Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

waitForCompletion(timeoutInSeconds)

Wartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden tritt eine Zeitüberschreitung auf. Löst eine Ausnahme aus, wenn die Ausführung bei Zeitüberschreitung nicht abgeschlossen ist, bricht die Datenabfrage aber nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Datenabfrage gewartet werden soll. Das Maximum beträgt 300 Sekunden.

Rückflug

DataExecutionStatus : Der Status der Datenabfrage.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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