IO.ANSI.Table.Column (IO ANSI Table v0.4.31) View Source
Functions related to the columns of a table.
Link to this section Summary
Functions
Returns the specs
attribute of a header
.
Spreads a width
given an element
and its align attribute
.
Returns a list of column widths capped by maximum width
.
Link to this section Types
Specs
align_attr() :: :left | :center | :right
Specs
align_spec() :: any() | {align_attr(), any()}
Specs
attr() :: align_attr() | sort_attr()
Specs
sort_attr() :: MapSorter.SortSpec.sort_dir()
Specs
sort_spec() :: MapSorter.SortSpec.t()
Specs
Specs
spec() :: align_spec() | sort_spec()
Specs
spread() :: [width()]
Specs
t() :: [String.t()]
Specs
width() :: non_neg_integer()
Link to this section Functions
Specs
align_attrs(IO.ANSI.Table.Spec.t()) :: IO.ANSI.Table.Spec.t()
Specs
column_widths(IO.ANSI.Table.Spec.t()) :: IO.ANSI.Table.Spec.t()
Specs
Returns the specs
attribute of a header
.
Examples
iex> alias IO.ANSI.Table.Column
iex> sort_specs = ["dept", desc: "hired"]
iex> {
...> Column.find_attr("dept" , sort_specs, :asc),
...> Column.find_attr("hired", sort_specs, :asc),
...> Column.find_attr("job" , sort_specs, :asc)
...> }
{:asc, :desc, nil}
Specs
left_margin(IO.ANSI.Table.Spec.t()) :: IO.ANSI.Table.Spec.t()
Specs
sort_attrs(IO.ANSI.Table.Spec.t()) :: IO.ANSI.Table.Spec.t()
Specs
spread(width(), IO.ANSI.Table.Line.elem(), align_attr()) :: spread()
Spreads a width
given an element
and its align attribute
.
Examples
iex> alias IO.ANSI.Table.Column
iex> {
...> Column.spread(7, "name", :left ),
...> Column.spread(7, "name", :center),
...> Column.spread(7, "name", :right )
...> }
{[0, 4, 3], [1, 4, 2], [3, 4, 0]}
iex> alias IO.ANSI.Table.Column
iex> {
...> Column.spread(3, "name", :left ),
...> Column.spread(3, "name", :center),
...> Column.spread(3, "name", :right )
...> }
{[0, 3, 0], [0, 3, 0], [0, 3, 0]}
iex> alias IO.ANSI.Table.Column
iex> {
...> Column.spread(10, "[32m[42mCHEETAH[0m", :left ),
...> Column.spread(10, "[32m[42mCHEETAH[0m", :center),
...> Column.spread(10, "[32m[42mCHEETAH[0m", :right )
...> }
{[0, 21, 3], [1, 21, 2], [3, 21, 0]}
iex> alias IO.ANSI.Table.Column
iex> {
...> Column.spread(7, "[32m[42mCHEETAH[0m", :left ),
...> Column.spread(7, "[32m[42mCHEETAH[0m", :center),
...> Column.spread(7, "[32m[42mCHEETAH[0m", :right )
...> }
{[0, 21, 0], [0, 21, 0], [0, 21, 0]}
Specs
Returns a list of column widths capped by maximum width
.
Examples
iex> alias IO.ANSI.Table.Column
iex> data = [["cat", "wombat", "elk"], ["mongoose", "ant", "gnu"]]
iex> Column.widths(data)
[6, 8]
iex> alias IO.ANSI.Table.Column
iex> data = [["cat", "wombat", "elk"], ["mongoose", "ant", "gnu"]]
iex> Column.widths(data, 7)
[6, 7]
iex> alias IO.ANSI.Table.Column
iex> data = [["[32m[42mCHEETAH[0m", "elk"], ["mongoose", "ant"]]
iex> Column.widths(data)
[7, 8]