table_rex v0.1.0 TableRex.Table

Defines a struct that represents a table and provides functions for working with it

Summary

Types

t()

Functions

add_row(table, row)

Adds a single row to the table

add_rows(table, rows)

Adds multiple rows to the table

clear_all_column_meta(table)

Removes column meta for all columns, effectively resetting column meta back to the default options across the board

clear_rows(table)

Removes all row data from the table, keeping everything else

get_column_meta(table, col_index, key)

Retreives the value of a column meta option at the specified col_index. If no value has been set, default values are returned

has_header?(table)

Returns a boolean detailing if the passed table has a header row set

has_rows?(table)

Returns a boolean detailing if the passed table has any row data set

new()

Creates a new table

render(table)

render(table, opts)

render(table, renderer, opts)

set_cell_meta(table, col_index, row_index, cell_meta)

Sets cell level information such as alignment

set_column_meta(table, col_index, col_meta)

Sets column level information such as padding and alignment

set_header(table, header_row)

Sets a list as the optional header row. Set to nil or [] to remove an already set header from renders

set_title(table, title)

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

add_row(table, row)

Specs

add_row(TableRex.Table.t, list) :: TableRex.Table.t

Adds a single row to the table.

add_rows(table, rows)

Specs

add_rows(TableRex.Table.t, list) :: TableRex.Table.t

Adds multiple rows to the table.

clear_all_column_meta(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.

clear_rows(table)

Specs

clear_rows(TableRex.Table.t) :: TableRex.Table.t

Removes all row data from the table, keeping everything else.

get_column_meta(table, col_index, key)

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.

has_header?(table)

Specs

has_header?(TableRex.Table.t) :: boolean

Returns a boolean detailing if the passed table has a header row set.

has_rows?(table)

Specs

has_rows?(TableRex.Table.t) :: boolean

Returns a boolean detailing if the passed table has any row data set.

new()

Specs

new :: TableRex.Table.t

Creates a new table.

render(table)

Specs

render(TableRex.Table.t) :: TableRex.Renderer.render_return

render(table, opts)

Specs

render(TableRex.Table.t, module) :: TableRex.Renderer.render_return

render(TableRex.Table.t, list) :: TableRex.Renderer.render_return

render(table, renderer, opts)

Specs

render(TableRex.Table.t, module, list) :: TableRex.Renderer.render_return

set_cell_meta(table, col_index, row_index, cell_meta)

Specs

set_cell_meta(TableRex.Table.t, integer, integer, Keyword.t) :: TableRex.Table.t

Sets cell level information such as alignment.

set_column_meta(table, col_index, col_meta)

Specs

set_column_meta(TableRex.Table.t, integer | atom, Keyword.t) :: TableRex.Table.t

Sets column level information such as padding and alignment.

set_header(table, header_row)

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.

set_title(table, title)

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.