table_rex
table_rex
v4.1.0

View Source TableRex.Cell (table_rex v4.1.0)

Defines a struct that represents a single table cell, and helper functions.

A cell stores both the original data and the string-rendered version, this decision was taken as a tradeoff: this way uses more memory to store the table structure but the renderers gain the ability to get direct access to the string-coerced data rather than having to risk repeated coercion or handle their own storage of the computer values.

Fields:

  • raw_value: The un-coerced original value

  • rendered_value: The stringified value for rendering

  • wrapped_lines: A list of 1 or more string values representing the line(s) within the cell to be rendered

  • align:

    • :left: left align text in the cell.
    • :center: center text in the cell.
    • :right: right align text in the cell.
    • nil: align text in cell according to column alignment.

  • color: the ANSI color of the cell.

If creating a Cell manually: raw_value is the only required key to enable that Cell to work well with the rest of TableRex. It should be set to a piece of data that can be rendered to string.

Summary

Types

t()

Functions

height(cell)
to_cell(cell)

Converts the passed value to be a normalised %Cell{} struct.

to_cell(value, opts \\ [])

Types

Link to this type

t()

View Source 
@type t() :: %TableRex.Cell{
  align: term(),
  color: term(),
  raw_value: term(),
  rendered_value: term(),
  wrapped_lines: term()
}

Functions

Link to this function

height(cell)

View Source 
@spec height(t()) :: integer()
Link to this function

to_cell(cell)

View Source 
@spec to_cell(t()) :: t()

Converts the passed value to be a normalised %Cell{} struct.

If a non %Cell{} value is passed, this function returns a new %Cell{} struct with:

  • the rendered_value key set to the stringified binary of the value passed in.
  • the raw_value key set to original data passed in.
  • any other options passed are applied over the normal struct defaults, which allows overriding alignment & color.

If a %Cell{} is passed in with no rendered_value key, then the raw_value key's value is rendered and saved against it, otherwise the Cell is passed through untouched. This is so that advanced use cases which require direct Cell creation and manipulation are not hindered.

Link to this function

to_cell(value, opts \\ [])

View Source 
@spec to_cell(any(), list()) :: t()