本頁面由 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()`

傳回資料透視群組運算的資料來源欄。如果資料透視表不是 {DataSourcePivotTableApi}，則會傳回 null。

回攻員

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.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const 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