存取及修改現有的資料來源資料透視表。如要建立新的資料來源資料透視表,請使用
Range.createDataSourcePivotTable(dataSource)
。
「這個類別」只能搭配連結至資料庫的資料使用。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
addColumnGroup(columnName) | PivotGroup | 根據指定資料來源欄新增資料透視欄群組。 |
addFilter(columnName, filterCriteria) | PivotFilter | 根據指定資料來源欄,以指定的篩選條件新增篩選器。 |
addPivotValue(columnName, summarizeFunction) | PivotValue | 根據指定的資料來源資料欄新增資料透視值,並加上指定的摘要 函式。 |
addRowGroup(columnName) | PivotGroup | 根據指定資料來源欄新增資料透視列群組。 |
asPivotTable() | PivotTable | 以一般資料透視表物件的形式傳回資料來源資料透視表。 |
cancelDataRefresh() | DataSourcePivotTable | 如果這個物件正在執行中,系統會取消相關聯的資料重新整理作業。 |
forceRefreshData() | DataSourcePivotTable | 重新整理這個物件的資料 (無論目前狀態為何)。 |
getDataSource() | DataSource | 取得與物件連結的資料來源。 |
getStatus() | DataExecutionStatus | 取得物件的資料執行狀態。 |
refreshData() | DataSourcePivotTable | 重新整理物件資料。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待目前的執行作業完成,並在指定的秒數後逾時。 |
內容詳盡的說明文件
addColumnGroup(columnName)
根據指定資料來源欄新增資料透視欄群組。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnName | String | 資料導致資料欄的名稱,資料透視表元素分組依據。 |
回攻員
PivotGroup
:新的資料透視表元素群組。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
根據指定資料來源欄,以指定的篩選條件新增篩選器。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnName | String | 資料資料來源欄的名稱,是篩選器所依據。 |
filterCriteria | FilterCriteria | 篩選器採用的條件。 |
回攻員
PivotFilter
:新的篩選器。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addPivotValue(columnName, summarizeFunction)
根據指定的資料來源資料欄新增資料透視值,並加上指定的摘要 函式。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnName | String | 資料建立新資料欄,做為資料透視值依據的依據。 |
summarizeFunction | PivotTableSummarizeFunction | 資料透視值所用函式的摘要。 |
回攻員
PivotValue
:新的資料透視值。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addRowGroup(columnName)
根據指定資料來源欄新增資料透視列群組。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnName | String | 資料導致資料欄的名稱,資料透視表元素分組依據。 |
回攻員
PivotGroup
:新的資料透視表元素群組。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asPivotTable()
以一般資料透視表物件的形式傳回資料來源資料透視表。
回攻員
PivotTable
- 資料透視表。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
如果這個物件正在執行中,系統會取消相關聯的資料重新整理作業。
以下範例說明如何取消公式重新整理作業。
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
如果未啟用資料來源類型,就會擲回例外狀況。使用
SpreadsheetApp#enable...Execution()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourcePivotTable
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
重新整理這個物件的資料 (無論目前狀態為何)。請參閱 refreshData()
:
瞭解詳情如要取消這個物件目前正在執行的重新整理作業,請參閱 cancelDataRefresh()
。
如果未啟用資料來源類型,就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourcePivotTable
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
取得與物件連結的資料來源。
回攻員
DataSource
:資料來源。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
方法為特定資料來源啟用資料執行程序
類型。
回攻員
DataSourcePivotTable
:資料物件。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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