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.



5350
5351
5352
# File 'generated/google/apis/sheets_v4/classes.rb', line 5350

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:



5302
5303
5304
# File 'generated/google/apis/sheets_v4/classes.rb', line 5302

def criteria
  @criteria
end

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



5309
5310
5311
# File 'generated/google/apis/sheets_v4/classes.rb', line 5309

def filter_specs
  @filter_specs
end

#filter_view_idFixnum

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

Returns:

  • (Fixnum)


5314
5315
5316
# File 'generated/google/apis/sheets_v4/classes.rb', line 5314

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)


5320
5321
5322
# File 'generated/google/apis/sheets_v4/classes.rb', line 5320

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, 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



5337
5338
5339
# File 'generated/google/apis/sheets_v4/classes.rb', line 5337

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



5343
5344
5345
# File 'generated/google/apis/sheets_v4/classes.rb', line 5343

def sort_specs
  @sort_specs
end

#titleString

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

Returns:

  • (String)


5348
5349
5350
# File 'generated/google/apis/sheets_v4/classes.rb', line 5348

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5355
5356
5357
5358
5359
5360
5361
5362
5363
# File 'generated/google/apis/sheets_v4/classes.rb', line 5355

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