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.



5735
5736
5737
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5735

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:



5687
5688
5689
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5687

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:



5694
5695
5696
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5694

def filter_specs
  @filter_specs
end

#filter_view_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5699
5700
5701
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5699

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) 


5705
5706
5707
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5705

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 123456, then: Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id: 123456 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:



5722
5723
5724
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5722

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:



5728
5729
5730
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5728

def sort_specs
  @sort_specs
end

#title ⇒ String

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

Returns:

  • (String) 


5733
5734
5735
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5733

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5740
5741
5742
5743
5744
5745
5746
5747
5748
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 5740

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