Class: Google::Apis::SheetsV4::ValueRange
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::ValueRange
- 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
Data within a range of the spreadsheet.
Instance Attribute Summary collapse
-
#major_dimension ⇒ String
The major dimension of the values.
-
#range ⇒ String
The range the values cover, in A1 notation.
-
#values ⇒ Array<Array<Object>>
The data that was read or to be written.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ValueRange
constructor
A new instance of ValueRange.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ValueRange
Returns a new instance of ValueRange.
11546 11547 11548 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 11546 def initialize(**args) update!(**args) end |
Instance Attribute Details
#major_dimension ⇒ String
The major dimension of the values.
For output, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4
,
then requesting range=A1:B2,majorDimension=ROWS
will return
[[1,2],[3,4]]
,
whereas requesting range=A1:B2,majorDimension=COLUMNS
will return
[[1,3],[2,4]]
.
For input, with range=A1:B2,majorDimension=ROWS
then [[1,2],[3,4]]
will set A1=1,B1=2,A2=3,B2=4
. With range=A1:B2,majorDimension=COLUMNS
then [[1,2],[3,4]]
will set A1=1,B1=3,A2=2,B2=4
.
When writing, if this field is not set, it defaults to ROWS.
Corresponds to the JSON property majorDimension
11523 11524 11525 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 11523 def major_dimension @major_dimension end |
#range ⇒ String
The range the values cover, in A1 notation.
For output, this range indicates the entire requested range,
even though the values will exclude trailing rows and columns.
When appending values, this field represents the range to search for a
table, after which values will be appended.
Corresponds to the JSON property range
11532 11533 11534 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 11532 def range @range end |
#values ⇒ Array<Array<Object>>
The data that was read or to be written. This is an array of arrays,
the outer array representing all the data and each inner array
representing a major dimension. Each item in the inner array
corresponds with one cell.
For output, empty trailing rows and columns will not be included.
For input, supported value types are: bool, string, and double.
Null values will be skipped.
To set a cell to an empty value, set the string value to an empty string.
Corresponds to the JSON property values
11544 11545 11546 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 11544 def values @values end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11551 11552 11553 11554 11555 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 11551 def update!(**args) @major_dimension = args[:major_dimension] if args.key?(:major_dimension) @range = args[:range] if args.key?(:range) @values = args[:values] if args.key?(:values) end |