存取及修改現有資料來源公式。如要建立新的資料來源公式,請使用 Range.setFormula(formula)
。
請僅將這個類別用於與 BigQuery 資料庫連結的資料。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
cancel | Data | 如果此物件目前正在執行,則取消與該物件相關聯的資料重新整理作業。 |
force | Data | 無論目前狀態為何,都會重新整理此物件的資料。 |
get | Range | 傳回 Range ,代表此資料來源公式繫結的儲存格。 |
get | Data | 取得物件連結的資料來源。 |
get | String | 傳回資料來源公式的顯示值。 |
get | String | 傳回這個資料來源公式的公式。 |
get | Data | 取得物件的資料執行狀態。 |
refresh | Data | 重新整理物件的資料。 |
set | Data | 更新公式。 |
wait | Data | 等待目前執行作業完成,並在指定秒數後逾時。 |
內容詳盡的說明文件
cancel Data Refresh()
如果目前正在執行,則會取消與此物件相關聯的資料重新整理作業。
以下範例說明如何取消公式重新整理作業。
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
如果未啟用資料來源類型,系統會擲回例外狀況。使用 Spreadsheet
方法,為特定資料來源類型啟用資料執行程序。
回攻員
Data
:資料物件。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
force Refresh Data()
無論目前狀態為何,都會重新整理此物件的資料。詳情請參閱 refresh
。如要取消目前正在執行的此物件重新整理作業,請參閱 cancel
。
如果未啟用資料來源類型,系統會擲回例外狀況。使用 Spreadsheet
方法,為特定資料來源類型啟用資料執行程序。
回攻員
Data
:資料物件。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Anchor Cell()
get Data Source()
取得物件連結的資料來源。
回攻員
Data
:資料來源。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Display Value()
傳回資料來源公式的顯示值。
回攻員
String
:顯示值。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Formula()
傳回這個資料來源公式的公式。
回攻員
String
:公式。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Status()
取得物件的資料執行狀態。
回攻員
Data
:資料執行狀態。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refresh Data()
重新整理物件的資料。
如果目前處於 error
狀態,就會擲回例外狀況。使用 Data
更新規格。建議使用此方法,而非 force
,以免資料來源發生意外編輯。
如果未啟用資料來源類型,系統會擲回例外狀況。使用 Spreadsheet
方法,為特定資料來源類型啟用資料執行程序。
回攻員
Data
:資料物件。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
set Formula(formula)
更新公式。
參數
名稱 | 類型 | 說明 |
---|---|---|
formula | String | 新公式。 |
回攻員
Data
:資料來源公式,用於鏈結。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
wait For Completion(timeoutInSeconds)
等待目前執行作業完成,並在指定秒數後逾時。如果在逾時時未完成執行作業,則會擲回例外狀況,但不會取消資料執行作業。
參數
名稱 | 類型 | 說明 |
---|---|---|
timeout | Integer | 等待資料執行作業的時間 (以秒為單位)。上限為 300 秒。 |
回攻員
Data
:資料執行狀態。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets