Class: Google::Apis::SheetsV4::BasicFilter

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

The default filter associated with a sheet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BasicFilter

Returns a new instance of BasicFilter.



1397
1398
1399
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1397

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:



1365
1366
1367
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1365

def criteria
  @criteria
end

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

The filter criteria 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:



1372
1373
1374
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1372

def filter_specs
  @filter_specs
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:



1389
1390
1391
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1389

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:



1395
1396
1397
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1395

def sort_specs
  @sort_specs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1402
1403
1404
1405
1406
1407
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 1402

def update!(**args)
  @criteria = args[:criteria] if args.key?(:criteria)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @range = args[:range] if args.key?(:range)
  @sort_specs = args[:sort_specs] if args.key?(:sort_specs)
end