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



6389
6390
6391
# File 'generated/google/apis/sheets_v4/classes.rb', line 6389

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

Instance Attribute Details

#data_validationGoogle::Apis::SheetsV4::DataValidationRule

A data validation rule. Corresponds to the JSON property dataValidation



6355
6356
6357
# File 'generated/google/apis/sheets_v4/classes.rb', line 6355

def data_validation
  @data_validation
end

#effective_formatGoogle::Apis::SheetsV4::CellFormat

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



6340
6341
6342
# File 'generated/google/apis/sheets_v4/classes.rb', line 6340

def effective_format
  @effective_format
end

#effective_valueGoogle::Apis::SheetsV4::ExtendedValue

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



6360
6361
6362
# File 'generated/google/apis/sheets_v4/classes.rb', line 6360

def effective_value
  @effective_value
end

#formatted_valueString

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)


6379
6380
6381
# File 'generated/google/apis/sheets_v4/classes.rb', line 6379

def formatted_value
  @formatted_value
end

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)


6387
6388
6389
# File 'generated/google/apis/sheets_v4/classes.rb', line 6387

def hyperlink
  @hyperlink
end

#noteString

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

Returns:

  • (String)


6345
6346
6347
# File 'generated/google/apis/sheets_v4/classes.rb', line 6345

def note
  @note
end

#pivot_tableGoogle::Apis::SheetsV4::PivotTable

A pivot table. Corresponds to the JSON property pivotTable



6330
6331
6332
# File 'generated/google/apis/sheets_v4/classes.rb', line 6330

def pivot_table
  @pivot_table
end

#text_format_runsArray<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



6372
6373
6374
# File 'generated/google/apis/sheets_v4/classes.rb', line 6372

def text_format_runs
  @text_format_runs
end

#user_entered_formatGoogle::Apis::SheetsV4::CellFormat

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



6335
6336
6337
# File 'generated/google/apis/sheets_v4/classes.rb', line 6335

def user_entered_format
  @user_entered_format
end

#user_entered_valueGoogle::Apis::SheetsV4::ExtendedValue

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



6350
6351
6352
# File 'generated/google/apis/sheets_v4/classes.rb', line 6350

def user_entered_value
  @user_entered_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
# File 'generated/google/apis/sheets_v4/classes.rb', line 6394

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