Class: Google::Apis::SheetsV4::NamedRange

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 named range.

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

Returns a new instance of NamedRange.


5485
5486
5487
# File 'generated/google/apis/sheets_v4/classes.rb', line 5485

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

Instance Attribute Details

#nameString

The name of the named range. Corresponds to the JSON property name

Returns:

  • (String)

5461
5462
5463
# File 'generated/google/apis/sheets_v4/classes.rb', line 5461

def name
  @name
end

#named_range_idString

The ID of the named range. Corresponds to the JSON property namedRangeId

Returns:

  • (String)

5466
5467
5468
# File 'generated/google/apis/sheets_v4/classes.rb', line 5466

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, 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!. Corresponds to the JSON property range


5483
5484
5485
# File 'generated/google/apis/sheets_v4/classes.rb', line 5483

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5490
5491
5492
5493
5494
# File 'generated/google/apis/sheets_v4/classes.rb', line 5490

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @named_range_id = args[:named_range_id] if args.key?(:named_range_id)
  @range = args[:range] if args.key?(:range)
end