Class: Google::Apis::SheetsV4::PivotTable

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 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) ⇒ PivotTable

Returns a new instance of PivotTable



6296
6297
6298
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6296

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

Instance Attribute Details

#columns ⇒ Array<Google::Apis::SheetsV4::PivotGroup>

Each column grouping in the pivot table. Corresponds to the JSON property columns

Returns:



6263
6264
6265
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6263

def columns
  @columns
end

#criteria ⇒ Hash<String,Google::Apis::SheetsV4::PivotFilterCriteria>

An optional mapping of filters per source column offset. The filters will be applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was C10:E15, a key of 0 will have the filter for column C, whereas the key 1 is for column D. Corresponds to the JSON property criteria

Returns:



6247
6248
6249
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6247

def criteria
  @criteria
end

#rows ⇒ Array<Google::Apis::SheetsV4::PivotGroup>

Each row grouping in the pivot table. Corresponds to the JSON property rows

Returns:



6252
6253
6254
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6252

def rows
  @rows
end

#source ⇒ Google::Apis::SheetsV4::GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 0, then: Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id:0 The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as #REF!. Corresponds to the JSON property source

Returns:



6294
6295
6296
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6294

def source
  @source
end

#value_layout ⇒ String

Whether values should be listed horizontally (as columns) or vertically (as rows). Corresponds to the JSON property valueLayout

Returns:

  • (String) 


6258
6259
6260
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6258

def value_layout
  @value_layout
end

#values ⇒ Array<Google::Apis::SheetsV4::PivotValue>

A list of values to include in the pivot table. Corresponds to the JSON property values

Returns:



6268
6269
6270
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6268

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6301
6302
6303
6304
6305
6306
6307
6308
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6301

def update!(**args)
  @criteria = args[:criteria] if args.key?(:criteria)
  @rows = args[:rows] if args.key?(:rows)
  @value_layout = args[:value_layout] if args.key?(:value_layout)
  @columns = args[:columns] if args.key?(:columns)
  @values = args[:values] if args.key?(:values)
  @source = args[:source] if args.key?(:source)
end