Class: Google::Apis::SheetsV4::CellData

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

Data about a specific cell.

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

Returns a new instance of CellData



1202
1203
1204
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1202

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

Instance Attribute Details

#data_validation ⇒ Google::Apis::SheetsV4::DataValidationRule

A data validation rule. Corresponds to the JSON property dataValidation

Returns:



1168
1169
1170
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1168

def data_validation
  @data_validation
end

#effective_format ⇒ Google::Apis::SheetsV4::CellFormat

The format of a cell. Corresponds to the JSON property effectiveFormat

Returns:



1153
1154
1155
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1153

def effective_format
  @effective_format
end

#effective_value ⇒ Google::Apis::SheetsV4::ExtendedValue

The kinds of value that a cell in a spreadsheet can have. Corresponds to the JSON property effectiveValue

Returns:



1173
1174
1175
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1173

def effective_value
  @effective_value
end

#formatted_value ⇒ String

The formatted value of the cell. This is the value as it's shown to the user. This field is read-only. Corresponds to the JSON property formattedValue

Returns:

  • (String) 


1192
1193
1194
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1192

def formatted_value
  @formatted_value
end

#hyperlink ⇒ String

A hyperlink this cell points to, if any. This field is read-only. (To set it, use a =HYPERLINK formula in the userEnteredValue.formulaValue field.) Corresponds to the JSON property hyperlink

Returns:

  • (String) 


1200
1201
1202
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1200

def hyperlink
  @hyperlink
end

#note ⇒ String

Any note on the cell. Corresponds to the JSON property note

Returns:

  • (String) 


1158
1159
1160
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1158

def note
  @note
end

#pivot_table ⇒ Google::Apis::SheetsV4::PivotTable

A pivot table. Corresponds to the JSON property pivotTable

Returns:



1143
1144
1145
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1143

def pivot_table
  @pivot_table
end

#text_format_runs ⇒ Array<Google::Apis::SheetsV4::TextFormatRun>

Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Runs start at specific indexes in the text and continue until the next run. Properties of a run will continue unless explicitly changed in a subsequent run (and properties of the first run will continue the properties of the cell unless explicitly changed). When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs will be erased. Corresponds to the JSON property textFormatRuns

Returns:



1185
1186
1187
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1185

def text_format_runs
  @text_format_runs
end

#user_entered_format ⇒ Google::Apis::SheetsV4::CellFormat

The format of a cell. Corresponds to the JSON property userEnteredFormat

Returns:



1148
1149
1150
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1148

def user_entered_format
  @user_entered_format
end

#user_entered_value ⇒ Google::Apis::SheetsV4::ExtendedValue

The kinds of value that a cell in a spreadsheet can have. Corresponds to the JSON property userEnteredValue

Returns:



1163
1164
1165
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1163

def user_entered_value
  @user_entered_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1207

def update!(**args)
  @pivot_table = args[:pivot_table] if args.key?(:pivot_table)
  @user_entered_format = args[:user_entered_format] if args.key?(:user_entered_format)
  @effective_format = args[:effective_format] if args.key?(:effective_format)
  @note = args[:note] if args.key?(:note)
  @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value)
  @data_validation = args[:data_validation] if args.key?(:data_validation)
  @effective_value = args[:effective_value] if args.key?(:effective_value)
  @text_format_runs = args[:text_format_runs] if args.key?(:text_format_runs)
  @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
  @hyperlink = args[:hyperlink] if args.key?(:hyperlink)
end