elixlsx v0.0.1 Elixlsx.Sheet

Describes a single sheet with a given name. The rows property is a list, each corresponding to a row (from the top), of lists, each corresponding to a column (from the left), of contents.

Content may be - a String.t (unicode), - a number, or - a list [String|number, property_list...]

The property list describes formatting options for that cell. See Font.from_props/1 for a list of options.

Summary

Functions

Set a cell at a given row/column index. Indizes start at 0

Set a cell indexed by excel coordinates

Set the column width for a given column. Column is indexed by name ("A", ...)

Returns a "CSV" representation of the Sheet. This is mainly used for doctests and does not generate valid CSV (yet)

Create a sheet with a sheet name

Types

t :: %Elixlsx.Sheet{col_widths: %{pos_integer => number}, name: String.t, rows: [[any]]}

Functions

set_at(sheet, rowidx, colidx, content, opts \\ [])

Specs

set_at(Elixlsx.Sheet.t, non_neg_integer, non_neg_integer, any, [{:key, any}]) :: Elixlsx.Sheet.t

Set a cell at a given row/column index. Indizes start at 0.

Example

iex> %Elixlsx.Sheet{} |>
...> Elixlsx.Sheet.set_at(0, 2, "Hello World",
...>                bold: true, underline: true) |>
...> Elixlsx.Sheet.to_csv_string
",,Hello World"
set_cell(sheet, index, content, opts \\ [])

Specs

set_cell(Elixlsx.Sheet.t, String.t, any, [{:key, any}]) :: Elixlsx.Sheet.t

Set a cell indexed by excel coordinates.

Example

iex> %Elixlsx.Sheet{} |>
...> Elixlsx.Sheet.set_cell("C1", "Hello World",
...>                bold: true, underline: true) |>
...> Elixlsx.Sheet.to_csv_string
",,Hello World"
set_col_width(sheet, column, width)

Specs

set_col_width(Elixlsx.Sheet.t, String.t, number) :: Elixlsx.Sheet.t

Set the column width for a given column. Column is indexed by name ("A", ...)

to_csv_string(sheet)

Returns a "CSV" representation of the Sheet. This is mainly used for doctests and does not generate valid CSV (yet).

with_name(name)

Specs

with_name(String.t) :: Elixlsx.Sheet.t

Create a sheet with a sheet name.