Class: Google::Apis::SheetsV4::FilterView

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

A filter view.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FilterView

Returns a new instance of FilterView.



5638
5639
5640
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5638

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. This field is deprecated in favor of filter_specs. Corresponds to the JSON property criteria

Returns:



5590
5591
5592
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5590

def criteria
  @criteria
end

#filter_specs ⇒ Array<Google::Apis::SheetsV4::FilterSpec>

The filter criteria for showing/hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence. Corresponds to the JSON property filterSpecs

Returns:



5597
5598
5599
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5597

def filter_specs
  @filter_specs
end

#filter_view_id ⇒ Fixnum

The ID of the filter view. Corresponds to the JSON property filterViewId

Returns:

  • (Fixnum) 


5602
5603
5604
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5602

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

Returns:

  • (String) 


5608
5609
5610
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5608

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, i.e. 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

Returns:



5625
5626
5627
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5625

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

Returns:



5631
5632
5633
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5631

def sort_specs
  @sort_specs
end

#title ⇒ String

The name of the filter view. Corresponds to the JSON property title

Returns:

  • (String) 


5636
5637
5638
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5636

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5643

def update!(**args)
  @criteria = args[:criteria] if args.key?(:criteria)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @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