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



5123
5124
5125
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5123

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

Instance Attribute Details

#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) 


5097
5098
5099
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5097

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) 


5103
5104
5105
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5103

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) 


5111
5112
5113
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5111

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:



5116
5117
5118
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5116

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:



5121
5122
5123
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5121

def value_metadata
  @value_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5128
5129
5130
5131
5132
5133
5134
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5128

def update!(**args)
  @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