table_rex v0.2.0 TableRex.Table
Defines a struct that represents a table and provides functions for working with it
Summary
Functions
Adds a single row to the table
Adds multiple rows to the table
Removes column meta for all columns, effectively resetting column meta back to the default options across the board
Removes all row data from the table, keeping everything else
Retreives the value of a column meta option at the specified col_index. If no value has been set, default values are returned
Returns a boolean detailing if the passed table has a header row set
Returns a boolean detailing if the passed table has any row data set
Creates a new table
Renders the current table state to string, ready for display via IO.puts/2
or other means
Renders the current table state to string, ready for display via IO.puts/2
or other means
Sets cell level information such as alignment
Sets column level information such as padding and alignment
Sets a list as the optional header row.
Set to nil
or []
to remove an already set header from renders
Sets a string as the optional table title.
Set to nil
or ""
to remove an already set title from renders
Types
t :: %TableRex.Table{columns: term, default_column: term, header_row: term, rows: term, title: term}
Functions
Specs
add_row(TableRex.Table.t, list) :: TableRex.Table.t
Adds a single row to the table.
Specs
add_rows(TableRex.Table.t, list) :: TableRex.Table.t
Adds multiple rows to the table.
Specs
clear_all_column_meta(TableRex.Table.t) :: TableRex.Table.t
Removes column meta for all columns, effectively resetting column meta back to the default options across the board.
Specs
clear_rows(TableRex.Table.t) :: TableRex.Table.t
Removes all row data from the table, keeping everything else.
Specs
get_column_meta(TableRex.Table.t, integer, atom) :: any
Retreives the value of a column meta option at the specified col_index. If no value has been set, default values are returned.
Specs
has_header?(TableRex.Table.t) :: boolean
Returns a boolean detailing if the passed table has a header row set.
Specs
has_rows?(TableRex.Table.t) :: boolean
Returns a boolean detailing if the passed table has any row data set.
Specs
render(TableRex.Table.t, list) :: TableRex.Renderer.render_return
Renders the current table state to string, ready for display via IO.puts/2
or other means.
At least one row must have been added before rendering.
Returns {:ok, rendered_string}
on success and {:error, reason}
on failure.
Specs
render!(TableRex.Table.t, list) ::
String.t |
no_return
Renders the current table state to string, ready for display via IO.puts/2
or other means.
At least one row must have been added before rendering.
Returns the rendered string on success, or raises TableRex.Error
on failure.
Specs
set_cell_meta(TableRex.Table.t, integer, integer, Keyword.t) :: TableRex.Table.t
Sets cell level information such as alignment.
Specs
set_column_meta(TableRex.Table.t, integer | atom, Keyword.t) :: TableRex.Table.t
Sets column level information such as padding and alignment.
Specs
set_header(TableRex.Table.t, list | nil) :: TableRex.Table.t
Sets a list as the optional header row.
Set to nil
or []
to remove an already set header from renders.
Specs
set_title(TableRex.Table.t, String.t | nil) :: TableRex.Table.t
Sets a string as the optional table title.
Set to nil
or ""
to remove an already set title from renders.