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.


1166
1167
1168
# File 'generated/google/apis/sheets_v4/classes.rb', line 1166

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:


1159
1160
1161
# File 'generated/google/apis/sheets_v4/classes.rb', line 1159

def criteria
  @criteria
end

#filter_view_idFixnum

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

Returns:

  • (Fixnum)

1164
1165
1166
# File 'generated/google/apis/sheets_v4/classes.rb', line 1164

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)

1120
1121
1122
# File 'generated/google/apis/sheets_v4/classes.rb', line 1120

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


1152
1153
1154
# File 'generated/google/apis/sheets_v4/classes.rb', line 1152

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


1126
1127
1128
# File 'generated/google/apis/sheets_v4/classes.rb', line 1126

def sort_specs
  @sort_specs
end

#titleString

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

Returns:

  • (String)

1113
1114
1115
# File 'generated/google/apis/sheets_v4/classes.rb', line 1113

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1171
1172
1173
1174
1175
1176
1177
1178
# File 'generated/google/apis/sheets_v4/classes.rb', line 1171

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