本頁面由 Cloud Translation API 翻譯而成。

Class PivotGroup

存取及修改資料透視表分組討論群組。

方法

方法	傳回類型	簡短說明
`addManualGroupingRule(groupName, groupMembers)`	`PivotGroup`	為這個資料透視表元素群組新增手動分組規則。
`areLabelsRepeated()`	`Boolean`	傳回標籤是否重複顯示。
`clearGroupingRule()`	`PivotGroup`	從這個資料透視表元素群組中移除任何分組規則。
`clearSort()`	`PivotGroup`	移除已套用至這個群組的所有排序方式。
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	傳回資料透視表中的資料日期時間分組規則；如果沒有日期時間，則傳回 `null` 已設定分組規則。
`getDimension()`	`Dimension`	傳回這是列或欄群組。
`getGroupLimit()`	`PivotGroupLimit`	傳回資料透視表元素群組的限制。
`getIndex()`	`Integer`	傳回這個資料透視表元素群組的索引 (依目前群組順序排列)。
`getPivotTable()`	`PivotTable`	傳回這個分組所屬的 `PivotTable`。
`getSourceDataColumn()`	`Integer`	傳回這個群組摘要的來源資料欄數量。
`getSourceDataSourceColumn()`	`DataSourceColumn`	傳回資料透視表中用於資料透視表元素的資料來源欄。
`hideRepeatedLabels()`	`PivotGroup`	隱藏這個分組的重複標籤。
`isSortAscending()`	`Boolean`	如果排序是遞增，則傳回 `true`，如果排序順序是`false` 遞減。
`moveToIndex(index)`	`PivotGroup`	將這個群組移至目前列或欄群組清單中的指定位置。
`remove()`	`void`	從表格中移除這個資料透視表元素。
`removeManualGroupingRule(groupName)`	`PivotGroup`	移除包含指定 `groupName` 的手動分組規則。
`resetDisplayName()`	`PivotGroup`	將資料透視表中這個群組的顯示名稱重設為預設值。
`setDateTimeGroupingRule(dateTimeGroupingRuleType)`	`PivotGroup`	為資料透視表元素設定日期時間分組規則。
`setDisplayName(name)`	`PivotGroup`	設定資料透視表中這個群組的顯示名稱。
`setGroupLimit(countLimit)`	`PivotGroup`	設定資料透視表元素群組限制。
`setHistogramGroupingRule(minValue, maxValue, intervalSize)`	`PivotGroup`	為這個資料透視表元素群組設定直方圖分組規則。
`showRepeatedLabels()`	`PivotGroup`	如有多個資料列或資料欄分組，這個方法會顯示此分組的標籤則為後續分組的每個項目
`showTotals(showTotals)`	`PivotGroup`	設定是否在表格中顯示這個資料透視表元素群組的總值。
`sortAscending()`	`PivotGroup`	將排序順序設為遞增。
`sortBy(value, oppositeGroupValues)`	`PivotGroup`	為 `oppositeGroupValues` 中的值按照指定的 `PivotValue` 排序這個群組。
`sortDescending()`	`PivotGroup`	將排序順序設為遞減。
`totalsAreShown()`	`Boolean`	傳回系統目前是否顯示這個資料透視表元素群組的總值。

內容詳盡的說明文件

`addManualGroupingRule(groupName, groupMembers)`

為這個資料透視表元素群組新增手動分組規則。

參數

名稱	類型	說明
`groupName`	`String`	這項分組規則的名稱。
`groupMembers`	`Object[]`	包含在這項分組規則中的值。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`areLabelsRepeated()`

傳回標籤是否重複顯示。

回攻員

Boolean - 標籤重複則為 true；如果沒有，系統會傳回 false。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`clearGroupingRule()`

從這個資料透視表元素群組中移除任何分組規則。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`clearSort()`

移除已套用至這個群組的所有排序方式。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDateTimeGroupingRule()`

傳回資料透視表中的資料日期時間分組規則；如果沒有日期時間，則傳回 null 已設定分組規則。

回攻員

DateTimeGroupingRule：日期時間分組規則，

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDimension()`

傳回這是列或欄群組。

回攻員

Dimension：代表此群組類型的維度

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getGroupLimit()`

傳回資料透視表元素群組的限制。如果沒有資料透視群組限制，則傳回 null 資源。

回攻員

PivotGroupLimit：資料透視表元素群組限制。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getIndex()`

傳回這個資料透視表元素群組的索引 (依目前群組順序排列)。

回攻員

Integer：資料透視表元素群組的索引

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getPivotTable()`

傳回這個分組所屬的 PivotTable。

回攻員

PivotTable：這個群組所屬的資料透視表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSourceDataColumn()`

傳回這個群組摘要的來源資料欄數量。這個索引從 1 開始，如果此群組會將來源資料總結在「A」欄的試算表檔案，這個方法會傳回 1。

回攻員

Integer：來源資料欄編號

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSourceDataSourceColumn()`

傳回資料透視表中用於資料透視表元素的資料來源欄。如果透視資料透視，則傳回 null 資料表並非「{DataSourcePivotTableApi}」。

回攻員

DataSourceColumn：資料透視表元素群組用來運作的資料來源欄。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`hideRepeatedLabels()`

隱藏這個分組的重複標籤。如果標籤已隱藏，搜尋結果即會自動執行。在有多個列或欄分組之前呼叫此方法，並在產生其他則會隱藏重複的標籤

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`isSortAscending()`

如果排序是遞增，則傳回 true，如果排序順序是false 遞減。

回攻員

Boolean — true表示排序順序是遞增。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`moveToIndex(index)`

將這個群組移至目前列或欄群組清單中的指定位置。這些索引是以 0 為基礎舉例來說，如果要將這個群組移到第一個位置方法應使用 0 呼叫。

參數

名稱	類型	說明
`index`	`Integer`	要加入這個分組的索引。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`remove()`

從表格中移除這個資料透視表元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`removeManualGroupingRule(groupName)`

移除包含指定 groupName 的手動分組規則。

參數

名稱	類型	說明
`groupName`	`String`	要移除的分組規則名稱。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`resetDisplayName()`

將資料透視表中這個群組的顯示名稱重設為預設值。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setDateTimeGroupingRule(dateTimeGroupingRuleType)`

為資料透視表元素設定日期時間分組規則。

如要移除規則，請使用 clearGroupingRule()。

參數

名稱	類型	說明
`dateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	要設定的規則類型。

回攻員

PivotGroup - 用於鏈結的資料透視群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setDisplayName(name)`

設定資料透視表中這個群組的顯示名稱。

參數

名稱	類型	說明
`name`	`String`	要設定的顯示名稱。

回攻員

PivotGroup - 鏈結的樞紐分析群組

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setGroupLimit(countLimit)`

設定資料透視表元素群組限制。這項操作僅適用於 DataSourcePivotTable。

參數

名稱	類型	說明
`countLimit`	`Integer`	要設定的資料列或資料欄數量限制。必須為正數。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setHistogramGroupingRule(minValue, maxValue, intervalSize)`

為這個資料透視表元素群組設定直方圖分組規則。直方圖規則會將將來源資料欄轉換為常數大小的值區。minValue 到 maxValue 的所有值都會歸入以下大小的群組：interval。所有低於 minValue 的值都會放在一個值區中，因為所有的值都大於 maxValue。

參數

名稱	類型	說明
`minValue`	`Integer`	項目放入值區的最小值。小於這個值都會合併至單一值區
`maxValue`	`Integer`	放入值區的項目最大值。大於這個數值都會合併至單一值區
`intervalSize`	`Integer`

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`showRepeatedLabels()`

如有多個資料列或資料欄分組，這個方法會顯示此分組的標籤則為後續分組的每個項目如果標籤重複，就會造成免人工管理。如果在有多個列或欄分組之前呼叫這個方法，則在產生多個資料列或資料欄分組時，額外分組會顯示重複的標籤

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`showTotals(showTotals)`

設定是否在表格中顯示這個資料透視表元素群組的總值。

參數

名稱	類型	說明
`showTotals`	`Boolean`	是否顯示總計。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`sortAscending()`

將排序順序設為遞增。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`sortBy(value, oppositeGroupValues)`

為 oppositeGroupValues 中的值按照指定的 PivotValue 排序這個群組。

// Sorts the item group by the "SUM of Quantity" pivot value for the specified salespersons.
var sheet = SpreadsheetApp.getActiveSheet();
var pivotTable = sheet.getPivotTables()[0];
var itemGroup = pivotTable.getRowGroups()[0];
var sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

參數

名稱	類型	說明
`value`	`PivotValue`	要排序的資料透視值。
`oppositeGroupValues`	`Object[]`	相對資料透視表群組的值 (如果將列群組或列群組 (如果排序欄群組時) 用於排序。請注意，這些值會決定分數破壞的優先順序。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`sortDescending()`

將排序順序設為遞減。

回攻員

PivotGroup - 鏈結的樞紐分析群組。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`totalsAreShown()`

傳回系統目前是否顯示這個資料透視表元素群組的總值。

回攻員

Boolean - 如果顯示這個資料透視表群組的總值，則為 true；如果沒有，則會傳回 false。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets