Class: Google::Apis::SheetsV4::SourceAndDestination
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::SourceAndDestination
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/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.
Constructor Details
#initialize(**args) ⇒ SourceAndDestination
Returns a new instance of SourceAndDestination.
9450 9451 9452 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 9450 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
9424 9425 9426 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 9424 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
9431 9432 9433 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 9431 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, 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 123456, then: Sheet1!A1:A1 == sheet_id:
123456, start_row_index: 0, end_row_index: 1, start_column_index: 0,
end_column_index: 1
Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2,
end_row_index: 4, start_column_index: 0, end_column_index: 2
Sheet1!A:B ==
sheet_id: 123456, start_column_index: 0, end_column_index: 2
Sheet1!A5:B ==
sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index:
2
Sheet1 == sheet_id: 123456
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
9448 9449 9450 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 9448 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9455 9456 9457 9458 9459 |
# File 'lib/google/apis/sheets_v4/classes.rb', line 9455 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 |