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



3474
3475
3476
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3474

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

Instance Attribute Details

#end_column_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3457
3458
3459
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3457

def end_column_index
  @end_column_index
end

#end_row_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3452
3453
3454
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3452

def end_row_index
  @end_row_index
end

#sheet_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3472
3473
3474
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3472

def sheet_id
  @sheet_id
end

#start_column_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3467
3468
3469
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3467

def start_column_index
  @start_column_index
end

#start_row_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3462
3463
3464
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3462

def start_row_index
  @start_row_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3479
3480
3481
3482
3483
3484
3485
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3479

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