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



3989
3990
3991
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3989

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:



3950
3951
3952
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3950

def data_validation
  @data_validation
end

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

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

Returns:



3945
3946
3947
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3945

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:



3960
3961
3962
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3960

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) 


3979
3980
3981
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3979

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) 


3987
3988
3989
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3987

def hyperlink
  @hyperlink
end

#note ⇒ String

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

Returns:

  • (String) 


3940
3941
3942
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3940

def note
  @note
end

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

A pivot table. Corresponds to the JSON property pivotTable

Returns:



3930
3931
3932
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3930

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:



3972
3973
3974
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3972

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:



3935
3936
3937
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3935

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:



3955
3956
3957
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3955

def user_entered_value
  @user_entered_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3994

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)
  @note = args[:note] if args.key?(:note)
  @effective_format = args[:effective_format] if args.key?(:effective_format)
  @data_validation = args[:data_validation] if args.key?(:data_validation)
  @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value)
  @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