Class: Google::Apis::SheetsV4::GridRange

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 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!.

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) ⇒ GridRange

Returns a new instance of GridRange



5183
5184
5185
# File 'generated/google/apis/sheets_v4/classes.rb', line 5183

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

Instance Attribute Details

#end_column_indexFixnum

The end column (exclusive) of the range, or not set if unbounded. Corresponds to the JSON property endColumnIndex

Returns:

  • (Fixnum)


5161
5162
5163
# File 'generated/google/apis/sheets_v4/classes.rb', line 5161

def end_column_index
  @end_column_index
end

#end_row_indexFixnum

The end row (exclusive) of the range, or not set if unbounded. Corresponds to the JSON property endRowIndex

Returns:

  • (Fixnum)


5166
5167
5168
# File 'generated/google/apis/sheets_v4/classes.rb', line 5166

def end_row_index
  @end_row_index
end

#sheet_idFixnum

The sheet this range is on. Corresponds to the JSON property sheetId

Returns:

  • (Fixnum)


5171
5172
5173
# File 'generated/google/apis/sheets_v4/classes.rb', line 5171

def sheet_id
  @sheet_id
end

#start_column_indexFixnum

The start column (inclusive) of the range, or not set if unbounded. Corresponds to the JSON property startColumnIndex

Returns:

  • (Fixnum)


5176
5177
5178
# File 'generated/google/apis/sheets_v4/classes.rb', line 5176

def start_column_index
  @start_column_index
end

#start_row_indexFixnum

The start row (inclusive) of the range, or not set if unbounded. Corresponds to the JSON property startRowIndex

Returns:

  • (Fixnum)


5181
5182
5183
# File 'generated/google/apis/sheets_v4/classes.rb', line 5181

def start_row_index
  @start_row_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5188
5189
5190
5191
5192
5193
5194
# File 'generated/google/apis/sheets_v4/classes.rb', line 5188

def update!(**args)
  @end_column_index = args[:end_column_index] if args.key?(:end_column_index)
  @end_row_index = args[:end_row_index] if args.key?(:end_row_index)
  @sheet_id = args[:sheet_id] if args.key?(:sheet_id)
  @start_column_index = args[:start_column_index] if args.key?(:start_column_index)
  @start_row_index = args[:start_row_index] if args.key?(:start_row_index)
end