google_api_sheets v0.2.0 GoogleApi.Sheets.V4.Model.CellData View Source

Data about a specific cell.

Attributes

  • dataValidation (DataValidationRule): A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule. Defaults to: null.
  • effectiveFormat (CellFormat): The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only. Defaults to: null.
  • effectiveValue (ExtendedValue): The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only. Defaults to: null.
  • formattedValue (String.t): The formatted value of the cell. This is the value as it's shown to the user. This field is read-only. Defaults to: null.
  • hyperlink (String.t): 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.) Defaults to: null.
  • note (String.t): Any note on the cell. Defaults to: null.
  • pivotTable (PivotTable): A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields. Defaults to: null.
  • textFormatRuns ([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 are erased. Defaults to: null.
  • userEnteredFormat (CellFormat): The format the user entered for the cell. When writing, the new format will be merged with the existing format. Defaults to: null.
  • userEnteredValue (ExtendedValue): The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Sheets.V4.Model.CellData{
  dataValidation: GoogleApi.Sheets.V4.Model.DataValidationRule.t(),
  effectiveFormat: GoogleApi.Sheets.V4.Model.CellFormat.t(),
  effectiveValue: GoogleApi.Sheets.V4.Model.ExtendedValue.t(),
  formattedValue: any(),
  hyperlink: any(),
  note: any(),
  pivotTable: GoogleApi.Sheets.V4.Model.PivotTable.t(),
  textFormatRuns: [GoogleApi.Sheets.V4.Model.TextFormatRun.t()],
  userEnteredFormat: GoogleApi.Sheets.V4.Model.CellFormat.t(),
  userEnteredValue: GoogleApi.Sheets.V4.Model.ExtendedValue.t()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.