Auf vorhandene Datenquellenformeln zugreifen und diese ändern. Wenn Sie eine neue Formel für Datenquellen erstellen möchten, verwenden Sie Range.setFormula(formula)
.
Verwenden Sie diese Klasse nur mit Daten, die mit einer Datenbank verbunden sind.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
cancelDataRefresh() | DataSourceFormula | Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird. |
forceRefreshData() | DataSourceFormula | Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. |
getAnchorCell() | Range | Gibt die Range zurück, die die Zelle darstellt, in der die Formel der Datenquelle verankert ist. |
getDataSource() | DataSource | Ruft die Datenquelle ab, mit der das Objekt verknüpft ist. |
getDisplayValue() | String | Gibt den Anzeigewert der Datenquellenformel zurück. |
getFormula() | String | Gibt die Formel für diese Datenquellenformel zurück. |
getStatus() | DataExecutionStatus | Ruft den Datenausführungsstatus des Objekts ab. |
refreshData() | DataSourceFormula | Aktualisiert die Daten des Objekts |
setFormula(formula) | DataSourceFormula | Aktualisiert die Formel. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Wartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt. |
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();
Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit
SpreadsheetApp#enable...Execution()
-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceFormula
: 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. refreshData()
ansehen für
erhalten Sie weitere Informationen. Informationen zum Abbrechen einer aktuell laufenden Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh()
.
Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()
-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceFormula
: 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
getAnchorCell()
Gibt die Range
zurück, die die Zelle darstellt, in der die Formel der Datenquelle verankert ist.
Rückflug
Range
: Die Ankerzelle.
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.
Rückflug
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
getDisplayValue()
Gibt den Anzeigewert der Datenquellenformel zurück.
Rückflug
String
: Der angezeigte Wert.
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
getFormula()
Gibt die Formel für diese Datenquellenformel zurück.
Rückflug
String
: Die Formel.
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.
Rückflug
DataExecutionStatus
: Der 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 sie sich derzeit im Status error
befindet. Verwenden Sie DataSource#updateSpec()
, um die Spezifikation zu aktualisieren. Die Methode ist
gegenüber forceRefreshData()
bevorzugt, um unerwartete Änderungen an der Datenquelle zu vermeiden.
Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()
-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceFormula
: 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
setFormula(formula)
Aktualisiert die Formel.
Parameter
Name | Typ | Beschreibung |
---|---|---|
formula | String | Die neue Formel. |
Rückflug
DataSourceFormula
: Die Formel der Datenquelle zur Verkettung.
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, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt. Löst eine Ausnahme aus, wenn die Ausführung bei einer Zeitüberschreitung nicht abgeschlossen ist, aber bricht den Datenausführung.
Parameter
Name | Typ | Beschreibung |
---|---|---|
timeoutInSeconds | Integer | Die Zeit in Sekunden, die auf die Datenausführung gewartet werden soll. Maximal sind 300 zulässig Sekunden. |
Rückflug
DataExecutionStatus
: Der 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