google_api_sheets v0.2.0 GoogleApi.Sheets.V4.Model.PivotGroup View Source

A single grouping (either row or column) in a pivot table.

Attributes

  • groupRule (PivotGroupRule): The group rule to apply to this row/column group. Defaults to: null.
  • label (String.t): 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 | +--------------+---------+-------+ Defaults to: null.
  • repeatHeadings (boolean()): True if the headings in this pivot group should be repeated. This is only valid for row groupings and is 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 | +--------------+ Defaults to: null.
  • showTotals (boolean()): True if the pivot table should include the totals for this grouping. Defaults to: null.
  • sortOrder (String.t): The order the values in this group should be sorted. Defaults to: null.

    • Enum - one of [SORT_ORDER_UNSPECIFIED, ASCENDING, DESCENDING]
  • sourceColumnOffset (integer()): 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`. Defaults to: null.
  • valueBucket (PivotGroupSortValueBucket): The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values. Defaults to: null.
  • valueMetadata ([PivotGroupValueMetadata]): Metadata about values in the grouping. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Sheets.V4.Model.PivotGroup{
  groupRule: GoogleApi.Sheets.V4.Model.PivotGroupRule.t(),
  label: any(),
  repeatHeadings: any(),
  showTotals: any(),
  sortOrder: any(),
  sourceColumnOffset: any(),
  valueBucket: GoogleApi.Sheets.V4.Model.PivotGroupSortValueBucket.t(),
  valueMetadata: [GoogleApi.Sheets.V4.Model.PivotGroupValueMetadata.t()]
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.