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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FilterView

Returns a new instance of FilterView



4766
4767
4768
# File 'generated/google/apis/sheets_v4/classes.rb', line 4766

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#criteriaHash<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

Returns:



4715
4716
4717
# File 'generated/google/apis/sheets_v4/classes.rb', line 4715

def criteria
  @criteria
end

#filter_view_idFixnum

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

Returns:

  • (Fixnum)


4720
4721
4722
# File 'generated/google/apis/sheets_v4/classes.rb', line 4720

def filter_view_id
  @filter_view_id
end

#named_range_idString

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)


4727
4728
4729
# File 'generated/google/apis/sheets_v4/classes.rb', line 4727

def named_range_id
  @named_range_id
end

#rangeGoogle::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



4753
4754
4755
# File 'generated/google/apis/sheets_v4/classes.rb', line 4753

def range
  @range
end

#sort_specsArray<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



4759
4760
4761
# File 'generated/google/apis/sheets_v4/classes.rb', line 4759

def sort_specs
  @sort_specs
end

#titleString

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

Returns:

  • (String)


4764
4765
4766
# File 'generated/google/apis/sheets_v4/classes.rb', line 4764

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4771
4772
4773
4774
4775
4776
4777
4778
# File 'generated/google/apis/sheets_v4/classes.rb', line 4771

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