Class: Google::Apis::SheetsV4::FilterView
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::FilterView
- 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 filter view.
Instance Attribute Summary collapse
-
#criteria ⇒ Hash<String,Google::Apis::SheetsV4::FilterCriteria>
The criteria for showing/hiding values per column.
-
#filter_view_id ⇒ Fixnum
The ID of the filter view.
-
#named_range_id ⇒ String
The named range this filter view is backed by, if any.
-
#range ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
-
#sort_specs ⇒ Array<Google::Apis::SheetsV4::SortSpec>
The sort order per column.
-
#title ⇒ String
The name of the filter view.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FilterView
constructor
A new instance of FilterView.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ FilterView
Returns a new instance of FilterView.
5514 5515 5516 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5514 def initialize(**args) update!(**args) end |
Instance Attribute Details
#criteria ⇒ Hash<String,Google::Apis::SheetsV4::FilterCriteria>
The criteria for showing/hiding values per column.
The map's key is the column index, and the value is the criteria for
that column.
Corresponds to the JSON property criteria
5463 5464 5465 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5463 def criteria @criteria end |
#filter_view_id ⇒ Fixnum
The ID of the filter view.
Corresponds to the JSON property filterViewId
5468 5469 5470 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5468 def filter_view_id @filter_view_id end |
#named_range_id ⇒ String
The named range this filter view is backed by, if any.
When writing, only one of range or named_range_id
may be set.
Corresponds to the JSON property namedRangeId
5475 5476 5477 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5475 def named_range_id @named_range_id end |
#range ⇒ 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 range
5501 5502 5503 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5501 def range @range end |
#sort_specs ⇒ Array<Google::Apis::SheetsV4::SortSpec>
The sort order per column. Later specifications are used when values
are equal in the earlier specifications.
Corresponds to the JSON property sortSpecs
5507 5508 5509 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5507 def sort_specs @sort_specs end |
#title ⇒ String
The name of the filter view.
Corresponds to the JSON property title
5512 5513 5514 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5512 def title @title end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5519 5520 5521 5522 5523 5524 5525 5526 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5519 def update!(**args) @criteria = args[:criteria] if args.key?(:criteria) @filter_view_id = args[:filter_view_id] if args.key?(:filter_view_id) @named_range_id = args[:named_range_id] if args.key?(:named_range_id) @range = args[:range] if args.key?(:range) @sort_specs = args[:sort_specs] if args.key?(:sort_specs) @title = args[:title] if args.key?(:title) end |