Class: Google::Apis::SheetsV4::RepeatCellRequest

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

Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula =A1 into range B2:C4, B2 would be =A1, B3 would be =A2, B4 would be =A3, C2 would be =B1, C3 would be =B2, C4 would be =B3. To keep the formula's ranges static, use the $ indicator. For example, use the formula =$A$1 to prevent both the row and the column from incrementing.

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

Returns a new instance of RepeatCellRequest



226
227
228
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 226

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

Instance Attribute Details

#cell ⇒ Google::Apis::SheetsV4::CellData

Data about a specific cell. Corresponds to the JSON property cell

Returns:



198
199
200
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 198

def cell
  @cell
end

#fields ⇒ String

The fields that should be updated. At least one field must be specified. The root cell is implied and should not be specified. A single "*" can be used as short-hand for listing every field. Corresponds to the JSON property fields

Returns:

  • (String) 


193
194
195
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 193

def fields
  @fields
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:



224
225
226
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 224

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



231
232
233
234
235
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 231

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