Class DataSourceFormula
Stay organized with collections
Save and categorize content based on your preferences.
DataSourceFormula
Access and modify existing data source formulas. To create a new data source formula, use
Range.setFormula(formula)
.
Only use this class with data that's connected to a database.
Detailed documentation
cancelDataRefresh()
Cancels the data refresh associated with this object if it's currently running.
This example shows how to cancel a formula refresh.
const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();
Throws an exception if the data source type is not enabled. Use
SpreadsheetApp#enable...Execution()
methods to enable data execution for specific data source
type.
Return
DataSourceFormula
— The data object.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Refreshes the data of this object regardless of the current state. See
refreshData()
for
more details. If you want to cancel a currently running refresh of this object, see
cancelDataRefresh()
.
Throws an exception if the data source type is not enabled. Use
SpreadsheetApp#enable...Execution()
methods to enable data execution for specific data source
type.
Return
DataSourceFormula
— The data object.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
Returns the
Range
representing the cell where this data source formula is anchored.
Return
Range
— The anchor cell.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Gets the data source the object is linked to.
Return
DataSource
— The data source.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
Returns the display value of the data source formula.
Return
String
— The display value.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Gets the data execution status of the object.
Return
DataExecutionStatus
— The data execution status.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Refreshes the data of the object.
Throws an exception if currently in
error
state. Use
DataSource#updateSpec()
to update the specification. The method is
preferred over
forceRefreshData()
to prevent unexpected edits on data source.
Throws an exception if the data source type is not enabled. Use
SpreadsheetApp#enable...Execution()
methods to enable data execution for specific data source
type.
Return
DataSourceFormula
— The data object.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Waits until the current execution completes, timing out after the provided number of seconds.
Throws an exception if the execution is not completed when timing out, but does not cancel the
data execution.
Parameters
Name
| Type
| Description
|
timeoutInSeconds
| Integer
| The time to wait for data execution, in seconds. The maximum is 300
seconds.
|
Return
DataExecutionStatus
— The data execution status.
Authorization
Scripts that use this method require authorization with one or more of the following
scopes
:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-30 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]