存取及修改現有的資料來源公式。如要建立新的資料來源公式,請使用 Range.setFormula(formula)
。
「這個類別」只能搭配連結至資料庫的資料使用。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | 如果這個物件正在執行中,系統會取消相關聯的資料重新整理作業。 |
forceRefreshData() | DataSourceFormula | 重新整理這個物件的資料 (無論目前狀態為何)。 |
getAnchorCell() | Range | 傳回 Range ,代表錨定這個資料來源公式的儲存格。 |
getDataSource() | DataSource | 取得與物件連結的資料來源。 |
getDisplayValue() | String | 傳回資料來源公式的顯示值。 |
getFormula() | String | 傳回這個資料來源公式的公式。 |
getStatus() | DataExecutionStatus | 取得物件的資料執行狀態。 |
refreshData() | DataSourceFormula | 重新整理物件資料。 |
setFormula(formula) | DataSourceFormula | 更新公式。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待目前的執行作業完成,並在指定的秒數後逾時。 |
內容詳盡的說明文件
cancelDataRefresh()
如果這個物件正在執行中,系統會取消相關聯的資料重新整理作業。
以下範例說明如何取消公式重新整理作業。
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
如果未啟用資料來源類型,就會擲回例外狀況。使用
SpreadsheetApp#enable...Execution()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourceFormula
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
重新整理這個物件的資料 (無論目前狀態為何)。請參閱 refreshData()
:
瞭解詳情如要取消這個物件目前正在執行的重新整理作業,請參閱 cancelDataRefresh()
。
如果未啟用資料來源類型,就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourceFormula
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
getDataSource()
取得與物件連結的資料來源。
回攻員
DataSource
:資料來源。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
傳回資料來源公式的顯示值。
回攻員
String
:顯示值,
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormula()
傳回這個資料來源公式的公式。
回攻員
String
:公式。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
取得物件的資料執行狀態。
回攻員
DataExecutionStatus
:資料執行狀態。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
重新整理物件資料。
如果目前處於 error
狀態,就會擲回例外狀況。使用 DataSource#updateSpec()
更新規格。方法是
優先於 forceRefreshData()
,以免資料來源發生非預期的編輯情況。
如果未啟用資料來源類型,就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourceFormula
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFormula(formula)
更新公式。
參數
名稱 | 類型 | 說明 |
---|---|---|
formula | String | 新公式。 |
回攻員
DataSourceFormula
:用於鏈結的資料來源公式。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
等待目前的執行作業完成,並在指定的秒數後逾時。 如果執行作業未完成時,就會擲回例外狀況,但未取消 資料執行方式
參數
名稱 | 類型 | 說明 |
---|---|---|
timeoutInSeconds | Integer | 等待資料執行的時間 (以秒為單位)。上限為 300 個 秒內請求驗證碼。 |
回攻員
DataExecutionStatus
:資料執行狀態。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets