Class: Google::Apis::SheetsV4::PivotGroupSortValueBucket

Inherits:

Object

• Object
• Google::Apis::SheetsV4::PivotGroupSortValueBucket

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

Information about which values in a pivot group should be used for sorting.

Instance Attribute Summary

• #buckets ⇒ Array<Google::Apis::SheetsV4::ExtendedValue>

  Determines the bucket from which values are chosen to sort.

• #values_index ⇒ Fixnum

  The offset in the PivotTable.values list which the values in this grouping should be sorted by.

Instance Method Summary

• #initialize(**args) ⇒ PivotGroupSortValueBucket constructor

  A new instance of PivotGroupSortValueBucket.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PivotGroupSortValueBucket

Returns a new instance of PivotGroupSortValueBucket.

# File 'generated/google/apis/sheets_v4/classes.rb', line 2410

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

Instance Attribute Details

#buckets ⇒ Array<Google::Apis::SheetsV4::ExtendedValue>

Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the "Grand Total" over the column groups. If a single value is listed, this would correspond to using the "Total" of that bucket. Corresponds to the JSON property buckets

Returns:

• (Array<Google::Apis::SheetsV4::ExtendedValue>)

# File 'generated/google/apis/sheets_v4/classes.rb', line 2402

def buckets
  @buckets
end

#values_index ⇒ Fixnum

The offset in the PivotTable.values list which the values in this grouping should be sorted by. Corresponds to the JSON property valuesIndex

Returns:

• (Fixnum)

# File 'generated/google/apis/sheets_v4/classes.rb', line 2408

def values_index
  @values_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/sheets_v4/classes.rb', line 2415

def update!(**args)
  @buckets = args[:buckets] if args.key?(:buckets)
  @values_index = args[:values_index] if args.key?(:values_index)
end