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
6637 6638 6639 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6637 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
6583 6584 6585 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6583 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
6593 6594 6595 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6593 def criteria @criteria end |
#rows ⇒ Array<Google::Apis::SheetsV4::PivotGroup>
Each row grouping in the pivot table.
Corresponds to the JSON property rows
6598 6599 6600 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6598 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
6624 6625 6626 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6624 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
6630 6631 6632 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6630 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
6635 6636 6637 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6635 def values @values end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6642 6643 6644 6645 6646 6647 6648 6649 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 6642 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 |