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

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.


4832
4833
4834
# File 'generated/google/apis/sheets_v4/classes.rb', line 4832

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)

4810
4811
4812
# File 'generated/google/apis/sheets_v4/classes.rb', line 4810

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)

4815
4816
4817
# File 'generated/google/apis/sheets_v4/classes.rb', line 4815

def end_row_index
  @end_row_index
end

#sheet_idFixnum

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

Returns:

  • (Fixnum)

4820
4821
4822
# File 'generated/google/apis/sheets_v4/classes.rb', line 4820

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)

4825
4826
4827
# File 'generated/google/apis/sheets_v4/classes.rb', line 4825

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)

4830
4831
4832
# File 'generated/google/apis/sheets_v4/classes.rb', line 4830

def start_row_index
  @start_row_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4837
4838
4839
4840
4841
4842
4843
# File 'generated/google/apis/sheets_v4/classes.rb', line 4837

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