Stay organized with collections Save and categorize content based on your preferences.
PivotGroupAccess and modify pivot table breakout groups.
Detailed documentationaddManualGroupingRule(groupName, groupMembers)
Adds a manual grouping rule for this pivot group.
Parameters Name Type DescriptiongroupName
String
The name of this grouping rule. groupMembers
Object[]
The values that are included in this grouping rule. Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
areLabelsRepeated()
Returns whether labels are displayed as repeated.
ReturnBoolean
— true
if labels are repeated; otherwise returns false
.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
clearGroupingRule()
Removes any grouping rules from this pivot group.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
clearSort()
Removes any sorting applied to this group.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getDateTimeGroupingRule()
Returns the date-time grouping rule on the pivot group, or null
if no date-time grouping rule is set.
DateTimeGroupingRule
— The date-time grouping rule.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getDimension()
Returns whether this is a row or column group.
ReturnDimension
— the dimension representing this group's type
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getGroupLimit()
Returns the pivot group limit on the pivot group. Returns null
if no pivot group limit is set.
PivotGroupLimit
— The pivot group limit.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getIndex()
Returns the index of this pivot group in the current group order.
ReturnInteger
— the pivot group's index
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getPivotTable()
Returns the PivotTable
which this grouping belongs to.
PivotTable
— the pivot table this group belongs to.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getSourceDataColumn()
Returns the number of the source data column this group summarizes. This index is 1-based, if this group summarizes source data in column "A" of the spreadsheet this method returns 1
.
Integer
— the source data column number
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
getSourceDataSourceColumn()
Returns the data source column the pivot group operates on. Returns null
if the pivot table is not a {DataSourcePivotTableApi}.
DataSourceColumn
— The data source column the pivot group operates on.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
hideRepeatedLabels()
Hides repeated labels for this grouping. If labels are already hidden this results in a no-op. If this method is called before there are multiple row or column groupings, when an additional grouping is added repeated labels are hidden.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
isSortAscending()
Returns true
if the sort is ascending, returns false
if the sort order is descending.
Boolean
— true
if the sort order is ascending.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
moveToIndex(index)
Moves this group to the specified position in the current list of row or column groups. These indices are 0-based. For example, if this group should be moved to the first position this method should be called with 0
.
index
Integer
The index to move this grouping to. Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
remove()
Removes this pivot group from the table.
AuthorizationScripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
removeManualGroupingRule(groupName)
Removes the manual grouping rule with the specified groupName
.
groupName
String
The name of the grouping rule to remove. Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
resetDisplayName()
Resets the display name of this group in the pivot table to its default value.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
setDateTimeGroupingRule(dateTimeGroupingRuleType)
Sets the date-time grouping rule on the pivot group.
To remove the rule, use clearGroupingRule()
.
PivotGroup
— The pivot group, for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
setDisplayName(name)
Sets the display name of this group in the pivot table.
Parameters Name Type Descriptionname
String
The display name to set. Return
PivotGroup
— the pivot group for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
setGroupLimit(countLimit)
Sets the pivot group limit on the pivot group. The operation is only supported for DataSourcePivotTable
.
countLimit
Integer
The count limit of rows or columns to set. Must be positive. Return
PivotGroup
— The pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
setHistogramGroupingRule(minValue, maxValue, intervalSize)
Sets a histogram grouping rule for this pivot group. A histogram rule organizes values in a source data column into buckets of a constant size. All values from minValue
to maxValue
are placed into groups of size interval
. All values below minValue
are placed into one bucket, as are all values greater than maxValue
.
minValue
Integer
The minimum value for items to be placed into buckets. Values less than this are combined into a single bucket. maxValue
Integer
The maximum value for items to be placed into buckets. Values greater than this are combined into a single bucket. intervalSize
Integer
Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
showRepeatedLabels()
When there is more than one row or column grouping, this method displays this grouping's label for each entry of the subsequent grouping. If labels are already repeated this results in a no-op. If this method is called before there are multiple row or column groupings, when an additional grouping is added repeated labels are shown.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
showTotals(showTotals)
Sets whether to show total values for this pivot group in the table.
Parameters Name Type DescriptionshowTotals
Boolean
Whether to show totals or not. Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
sortAscending()
Sets the sort order to be ascending.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
sortBy(value, oppositeGroupValues)
Sorts this group by the specified PivotValue
for the values from the oppositeGroupValues
.
// 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']);Parameters Name Type Description
value
PivotValue
The pivot value to sort by. oppositeGroupValues
Object[]
The values of an opposite pivot group (a column group if sorting a row group, or a row group if sorting a column group) that are used to sort. The order of these values determines precedence for tie breaking. Return
PivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
sortDescending()
Sets the sort order to be descending.
ReturnPivotGroup
— the pivot group for chaining.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
totalsAreShown()
Returns whether total values are currently shown for this pivot group.
ReturnBoolean
— true
if total values are displayed for this pivot group; otherwise returns false
.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["This document explains how to use Google Apps Script to work with breakout groups within pivot tables, including accessing, modifying, and sorting them."],["It provides a summary of key methods like `addManualGroupingRule`, `clearGroupingRule`, `getDimension`, `remove`, and others, along with their descriptions."],["Authorization with specific Google API scopes (`spreadsheets.currentonly` or `spreadsheets`) is needed for most of these methods to function correctly."],["Detailed information about each method's parameters, return types, and usage can be found in the full documentation, with additional notes on specific pivot table types and indexing."],["The document also covers methods for managing repeated labels (`addLabel`, `removeLabel`, `repeatHeadings`), sorting (`sortAscending`, `sortBy`, `sortDescending`), and displaying totals (`showTotals`, `totalsAreShown`)."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4