Class: Google::Apis::SheetsV4::SourceAndDestination
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::SourceAndDestination
- 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 combination of a source range and how to extend that source.
Instance Attribute Summary collapse
-
#dimension ⇒ String
The dimension that data should be filled into.
-
#fill_length ⇒ Fixnum
The number of rows or columns that data should be filled into.
-
#source ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SourceAndDestination
constructor
A new instance of SourceAndDestination.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SourceAndDestination
Returns a new instance of SourceAndDestination
8152 8153 8154 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8152 def initialize(**args) update!(**args) end |
Instance Attribute Details
#dimension ⇒ String
The dimension that data should be filled into.
Corresponds to the JSON property dimension
8116 8117 8118 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8116 def dimension @dimension end |
#fill_length ⇒ Fixnum
The number of rows or columns that data should be filled into.
Positive numbers expand beyond the last row or last column
of the source. Negative numbers expand before the first row
or first column of the source.
Corresponds to the JSON property fillLength
8124 8125 8126 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8124 def fill_length @fill_length end |
#source ⇒ 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 source
8150 8151 8152 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8150 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8157 8158 8159 8160 8161 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8157 def update!(**args) @dimension = args[:dimension] if args.key?(:dimension) @fill_length = args[:fill_length] if args.key?(:fill_length) @source = args[:source] if args.key?(:source) end |