Class DataSourceChart

DataSourceChart

Vorhandenes Datenquellendiagramm aufrufen und ändern

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

Methoden

MethodeRückgabetypKurzbeschreibung
cancelDataRefresh()DataSourceChartBricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es 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 Datenausführungsstatus 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 wird das Zeitlimit überschritten.

Detaillierte Dokumentation

cancelDataRefresh()

Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es 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();

Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Return

DataSourceChart: Das Datenobjekt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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(). Informationen zum Abbrechen einer aktuellen Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh().

Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Return

DataSourceChart: Das Datenobjekt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Return

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getStatus()

Ruft den Datenausführungsstatus des Objekts ab.

Return

DataExecutionStatus: Status der Datenausführung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 sich derzeit der Status error befindet. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Die Methode wird gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu verhindern.

Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Return

DataSourceChart: Das Datenobjekt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 wird das Zeitlimit überschritten. Löst eine Ausnahme aus, wenn die Ausführung bei Ablauf des Zeitlimits nicht abgeschlossen ist, bricht jedoch die Datenausführung nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Ausführung der Daten gewartet werden soll. Maximal sind 300 Sekunden zulässig.

Return

DataExecutionStatus: Status der Datenausführung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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