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



6304
6305
6306
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6304

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

Instance Attribute Details

#name ⇒ String

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

Returns:

  • (String) 


6271
6272
6273
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6271

def name
  @name
end

#named_range_id ⇒ String

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

Returns:

  • (String) 


6276
6277
6278
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6276

def named_range_id
  @named_range_id
end

#range ⇒ Google::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

Returns:



6302
6303
6304
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6302

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6309
6310
6311
6312
6313
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6309

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