Class: Google::Apis::SheetsV4::DeleteRangeRequest
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::DeleteRangeRequest
- 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
Deletes a range of cells, shifting other cells into the deleted area.
Instance Attribute Summary collapse
-
#range ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
-
#shift_dimension ⇒ String
The dimension from which deleted cells will be replaced with.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DeleteRangeRequest
constructor
A new instance of DeleteRangeRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DeleteRangeRequest
Returns a new instance of DeleteRangeRequest
4070 4071 4072 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4070 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
4060 4061 4062 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4060 def range @range end |
#shift_dimension ⇒ String
The dimension from which deleted cells will be replaced with.
If ROWS, existing cells will be shifted upward to
replace the deleted cells. If COLUMNS, existing cells
will be shifted left to replace the deleted cells.
Corresponds to the JSON property shiftDimension
4068 4069 4070 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4068 def shift_dimension @shift_dimension end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4075 4076 4077 4078 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4075 def update!(**args) @range = args[:range] if args.key?(:range) @shift_dimension = args[:shift_dimension] if args.key?(:shift_dimension) end |