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



2153
2154
2155
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2153

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:



2096
2097
2098
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2096

def data_validation
  @data_validation
end

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

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

Returns:



2146
2147
2148
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2146

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:



2106
2107
2108
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2106

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) 


2125
2126
2127
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2125

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.) Corresponds to the JSON property hyperlink

Returns:

  • (String) 


2131
2132
2133
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2131

def hyperlink
  @hyperlink
end

#note ⇒ String

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

Returns:

  • (String) 


2151
2152
2153
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2151

def note
  @note
end

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

A pivot table. Corresponds to the JSON property pivotTable

Returns:



2136
2137
2138
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2136

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:



2118
2119
2120
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2118

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:



2141
2142
2143
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2141

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:



2101
2102
2103
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2101

def user_entered_value
  @user_entered_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2158

def update!(**args)
  @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)
  @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)
end