Google Apps Script API
Preparing search index...
google-apps-script-events
GoogleAppsScript
Spreadsheet
PivotGroup
Interface PivotGroup
Access and modify pivot table breakout groups.
interface
PivotGroup
{
addManualGroupingRule
(
groupName
:
string
,
groupMembers
:
any
[]
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
areLabelsRepeated
()
:
boolean
;
clearGroupingRule
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
clearSort
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
getDimension
()
:
GoogleAppsScript
.
Spreadsheet
.
Dimension
;
getIndex
()
:
number
;
getPivotTable
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotTable
;
getSourceDataColumn
()
:
number
;
hideRepeatedLabels
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
isSortAscending
()
:
boolean
;
moveToIndex
(
index
:
number
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
remove
()
:
void
;
removeManualGroupingRule
(
groupName
:
string
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
resetDisplayName
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
setDisplayName
(
name
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
setHistogramGroupingRule
(
minValue
:
number
,
maxValue
:
number
,
intervalSize
:
number
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
showRepeatedLabels
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
showTotals
(
showTotals
:
boolean
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
sortAscending
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
sortBy
(
value
:
GoogleAppsScript
.
Spreadsheet
.
PivotValue
,
oppositeGroupValues
:
any
[]
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
sortDescending
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
;
totalsAreShown
()
:
boolean
;
}
Index
Methods
add
Manual
Grouping
Rule
are
Labels
Repeated
clear
Grouping
Rule
clear
Sort
get
Dimension
get
Index
get
Pivot
Table
get
Source
Data
Column
hide
Repeated
Labels
is
Sort
Ascending
move
To
Index
remove
remove
Manual
Grouping
Rule
reset
Display
Name
set
Display
Name
set
Histogram
Grouping
Rule
show
Repeated
Labels
show
Totals
sort
Ascending
sort
By
sort
Descending
totals
Are
Shown
Methods
add
Manual
Grouping
Rule
addManualGroupingRule
(
groupName
:
string
,
groupMembers
:
any
[]
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
groupName
:
string
groupMembers
:
any
[]
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
are
Labels
Repeated
areLabelsRepeated
()
:
boolean
Returns
boolean
clear
Grouping
Rule
clearGroupingRule
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
clear
Sort
clearSort
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
get
Dimension
getDimension
()
:
GoogleAppsScript
.
Spreadsheet
.
Dimension
Returns
GoogleAppsScript
.
Spreadsheet
.
Dimension
get
Index
getIndex
()
:
number
Returns
number
get
Pivot
Table
getPivotTable
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotTable
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotTable
get
Source
Data
Column
getSourceDataColumn
()
:
number
Returns
number
hide
Repeated
Labels
hideRepeatedLabels
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
is
Sort
Ascending
isSortAscending
()
:
boolean
Returns
boolean
move
To
Index
moveToIndex
(
index
:
number
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
index
:
number
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
remove
remove
()
:
void
Returns
void
remove
Manual
Grouping
Rule
removeManualGroupingRule
(
groupName
:
string
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
groupName
:
string
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
reset
Display
Name
resetDisplayName
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
set
Display
Name
setDisplayName
(
name
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
name
:
string
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
set
Histogram
Grouping
Rule
setHistogramGroupingRule
(
minValue
:
number
,
maxValue
:
number
,
intervalSize
:
number
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
minValue
:
number
maxValue
:
number
intervalSize
:
number
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
show
Repeated
Labels
showRepeatedLabels
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
show
Totals
showTotals
(
showTotals
:
boolean
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
showTotals
:
boolean
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
sort
Ascending
sortAscending
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
sort
By
sortBy
(
value
:
GoogleAppsScript
.
Spreadsheet
.
PivotValue
,
oppositeGroupValues
:
any
[]
,
)
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Parameters
value
:
GoogleAppsScript
.
Spreadsheet
.
PivotValue
oppositeGroupValues
:
any
[]
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
sort
Descending
sortDescending
()
:
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
Returns
GoogleAppsScript
.
Spreadsheet
.
PivotGroup
totals
Are
Shown
totalsAreShown
()
:
boolean
Returns
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Manual
Grouping
Rule
are
Labels
Repeated
clear
Grouping
Rule
clear
Sort
get
Dimension
get
Index
get
Pivot
Table
get
Source
Data
Column
hide
Repeated
Labels
is
Sort
Ascending
move
To
Index
remove
remove
Manual
Grouping
Rule
reset
Display
Name
set
Display
Name
set
Histogram
Grouping
Rule
show
Repeated
Labels
show
Totals
sort
Ascending
sort
By
sort
Descending
totals
Are
Shown
Google Apps Script API
Loading...
Access and modify pivot table breakout groups.