PivotGroup (Google Sheets API v4 (Rev. 501) 1.22.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.PivotGroup

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class PivotGroup
extends com.google.api.client.json.GenericJson
```
A single grouping (either row or column) in a pivot table.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PivotGroup()

Constructors
Constructor and Description
`PivotGroup()`

Method Summary

Methods
Modifier and Type	Method and Description
`PivotGroup`	`clone()`
`PivotGroupRule`	`getGroupRule()` The group rule to apply to this row/column group.
`java.lang.String`	`getLabel()` The labels to use for the row/column groups which can be customized.
`java.lang.Boolean`	`getRepeatHeadings()` True if the headings in this pivot group should be repeated.
`java.lang.Boolean`	`getShowTotals()` True if the pivot table should include the totals for this grouping.
`java.lang.String`	`getSortOrder()` The order the values in this group should be sorted.
`java.lang.Integer`	`getSourceColumnOffset()` The column offset of the source range that this grouping is based on.
`PivotGroupSortValueBucket`	`getValueBucket()` The bucket of the opposite pivot group to sort by.
`java.util.List<PivotGroupValueMetadata>`	`getValueMetadata()` Metadata about values in the grouping.
`PivotGroup`	`set(java.lang.String fieldName, java.lang.Object value)`
`PivotGroup`	`setGroupRule(PivotGroupRule groupRule)` The group rule to apply to this row/column group.
`PivotGroup`	`setLabel(java.lang.String label)` The labels to use for the row/column groups which can be customized.
`PivotGroup`	`setRepeatHeadings(java.lang.Boolean repeatHeadings)` True if the headings in this pivot group should be repeated.
`PivotGroup`	`setShowTotals(java.lang.Boolean showTotals)` True if the pivot table should include the totals for this grouping.
`PivotGroup`	`setSortOrder(java.lang.String sortOrder)` The order the values in this group should be sorted.
`PivotGroup`	`setSourceColumnOffset(java.lang.Integer sourceColumnOffset)` The column offset of the source range that this grouping is based on.
`PivotGroup`	`setValueBucket(PivotGroupSortValueBucket valueBucket)` The bucket of the opposite pivot group to sort by.
`PivotGroup`	`setValueMetadata(java.util.List<PivotGroupValueMetadata> valueMetadata)` Metadata about values in the grouping.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PivotGroup
```
public PivotGroup()
```
- Method Detail
  - getGroupRule
```
public PivotGroupRule getGroupRule()
```
    The group rule to apply to this row/column group.
    
    Returns:
    value or null for none
  - setGroupRule
```
public PivotGroup setGroupRule(PivotGroupRule groupRule)
```
    The group rule to apply to this row/column group.
    
    Parameters:
    groupRule - groupRule or null for none
  - getLabel
```
public java.lang.String getLabel()
```
    The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+
    
    Returns:
    value or null for none
  - setLabel
```
public PivotGroup setLabel(java.lang.String label)
```
    The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+
    
    Parameters:
    label - label or null for none
  - getRepeatHeadings
```
public java.lang.Boolean getRepeatHeadings()
```
    True if the headings in this pivot group should be repeated. This is only valid for row groupings and will be ignored by columns. By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+
    
    Returns:
    value or null for none
  - setRepeatHeadings
```
public PivotGroup setRepeatHeadings(java.lang.Boolean repeatHeadings)
```
    True if the headings in this pivot group should be repeated. This is only valid for row groupings and will be ignored by columns. By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+
    
    Parameters:
    repeatHeadings - repeatHeadings or null for none
  - getShowTotals
```
public java.lang.Boolean getShowTotals()
```
    True if the pivot table should include the totals for this grouping.
    
    Returns:
    value or null for none
  - setShowTotals
```
public PivotGroup setShowTotals(java.lang.Boolean showTotals)
```
    True if the pivot table should include the totals for this grouping.
    
    Parameters:
    showTotals - showTotals or null for none
  - getSortOrder
```
public java.lang.String getSortOrder()
```
    The order the values in this group should be sorted.
    
    Returns:
    value or null for none
  - setSortOrder
```
public PivotGroup setSortOrder(java.lang.String sortOrder)
```
    The order the values in this group should be sorted.
    
    Parameters:
    sortOrder - sortOrder or null for none
  - getSourceColumnOffset
```
public java.lang.Integer getSourceColumnOffset()
```
    The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
    
    Returns:
    value or null for none
  - setSourceColumnOffset
```
public PivotGroup setSourceColumnOffset(java.lang.Integer sourceColumnOffset)
```
    The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
    
    Parameters:
    sourceColumnOffset - sourceColumnOffset or null for none
  - getValueBucket
```
public PivotGroupSortValueBucket getValueBucket()
```
    The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
    
    Returns:
    value or null for none
  - setValueBucket
```
public PivotGroup setValueBucket(PivotGroupSortValueBucket valueBucket)
```
    The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
    
    Parameters:
    valueBucket - valueBucket or null for none
  - getValueMetadata
```
public java.util.List<PivotGroupValueMetadata> getValueMetadata()
```
    Metadata about values in the grouping.
    
    Returns:
    value or null for none
  - setValueMetadata
```
public PivotGroup setValueMetadata(java.util.List<PivotGroupValueMetadata> valueMetadata)
```
    Metadata about values in the grouping.
    
    Parameters:
    valueMetadata - valueMetadata or null for none
  - set
```
public PivotGroup set(java.lang.String fieldName,
             java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public PivotGroup clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Sheets API v4 (revision 501)

Class PivotGroup

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

PivotGroup

Method Detail

getGroupRule

setGroupRule

getLabel

setLabel

getRepeatHeadings

setRepeatHeadings

getShowTotals

setShowTotals

getSortOrder

setSortOrder

getSourceColumnOffset

setSourceColumnOffset

getValueBucket

setValueBucket

getValueMetadata

setValueMetadata

set

clone