Class: Google::Apis::SheetsV4::PivotGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PivotGroup

Returns a new instance of PivotGroup



6447
6448
6449
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6447

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#group_rule ⇒ Google::Apis::SheetsV4::PivotGroupRule

An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not. Corresponds to the JSON property groupRule

Returns:



6376
6377
6378
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6376

def group_rule
  @group_rule
end

#label ⇒ String

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 | +--------------+---------+-------+ Corresponds to the JSON property label

Returns:

  • (String) 


6397
6398
6399
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6397

def label
  @label
end

#repeat_headings ⇒ Boolean Also known as: repeat_headings?

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 | +--------------+ Corresponds to the JSON property repeatHeadings

Returns:

  • (Boolean) 


6415
6416
6417
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6415

def repeat_headings
  @repeat_headings
end

#show_totals ⇒ Boolean Also known as: show_totals?

True if the pivot table should include the totals for this grouping. Corresponds to the JSON property showTotals

Returns:

  • (Boolean) 


6421
6422
6423
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6421

def show_totals
  @show_totals
end

#sort_order ⇒ String

The order the values in this group should be sorted. Corresponds to the JSON property sortOrder

Returns:

  • (String) 


6427
6428
6429
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6427

def sort_order
  @sort_order
end

#source_column_offset ⇒ Fixnum

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. Corresponds to the JSON property sourceColumnOffset

Returns:

  • (Fixnum) 


6435
6436
6437
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6435

def source_column_offset
  @source_column_offset
end

#value_bucket ⇒ Google::Apis::SheetsV4::PivotGroupSortValueBucket

Information about which values in a pivot group should be used for sorting. Corresponds to the JSON property valueBucket

Returns:



6440
6441
6442
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6440

def value_bucket
  @value_bucket
end

#value_metadata ⇒ Array<Google::Apis::SheetsV4::PivotGroupValueMetadata>

Metadata about values in the grouping. Corresponds to the JSON property valueMetadata

Returns:



6445
6446
6447
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6445

def value_metadata
  @value_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6452

def update!(**args)
  @group_rule = args[:group_rule] if args.key?(:group_rule)
  @label = args[:label] if args.key?(:label)
  @repeat_headings = args[:repeat_headings] if args.key?(:repeat_headings)
  @show_totals = args[:show_totals] if args.key?(:show_totals)
  @sort_order = args[:sort_order] if args.key?(:sort_order)
  @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset)
  @value_bucket = args[:value_bucket] if args.key?(:value_bucket)
  @value_metadata = args[:value_metadata] if args.key?(:value_metadata)
end