Class: Google::Apis::SheetsV4::PivotTable
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::PivotTable
- 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
-
#columns ⇒ Array<Google::Apis::SheetsV4::PivotGroup>
Each column grouping in the pivot table.
-
#criteria ⇒ Hash<String,Google::Apis::SheetsV4::PivotFilterCriteria>
An optional mapping of filters per source column offset.
-
#rows ⇒ Array<Google::Apis::SheetsV4::PivotGroup>
Each row grouping in the pivot table.
-
#source ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
-
#value_layout ⇒ String
Whether values should be listed horizontally (as columns) or vertically (as rows).
-
#values ⇒ Array<Google::Apis::SheetsV4::PivotValue>
A list of values to include in the pivot table.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PivotTable
constructor
A new instance of PivotTable.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PivotTable
Returns a new instance of PivotTable
6808 6809 6810 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6808 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
6754 6755 6756 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6754 def columns @columns end |
#criteria ⇒ Hash<String,Google::Apis::SheetsV4::PivotFilterCriteria>
An optional mapping of filters per source column offset.
The filters are 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
6764 6765 6766 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6764 def criteria @criteria end |
#rows ⇒ Array<Google::Apis::SheetsV4::PivotGroup>
Each row grouping in the pivot table.
Corresponds to the JSON property rows
6769 6770 6771 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6769 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
6795 6796 6797 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6795 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
6801 6802 6803 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6801 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
6806 6807 6808 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6806 def values @values end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6813 6814 6815 6816 6817 6818 6819 6820 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6813 def update!(**args) @columns = args[:columns] if args.key?(:columns) @criteria = args[:criteria] if args.key?(:criteria) @rows = args[:rows] if args.key?(:rows) @source = args[:source] if args.key?(:source) @value_layout = args[:value_layout] if args.key?(:value_layout) @values = args[:values] if args.key?(:values) end |