xlsx_reader v0.1.4 XlsxReader View Source
Opens XLSX workbook and reads its worksheets.
Example
{:ok, package} = XlsxReader.open("test.xlsx")
XlsxReader.sheet_names(package)
# ["Sheet 1", "Sheet 2", "Sheet 3"]
{:ok, rows} = XlsxReader.sheet(package, "Sheet 1")
# [
# ["Date", "Temperature"],
# [~D[2019-11-01], 8.4],
# [~D[2019-11-02], 7.5],
# ...
# ]
Sheet contents
Sheets are loaded on-demand by sheet/3
and sheets/2
.
The sheet contents is returned as a list of lists:
[
["A1", "B1", "C1" | _],
["A2", "B2", "C2" | _],
["A3", "B3", "C3" | _],
| _
]
The behavior of the sheet parser can be customized for each
individual sheet, see sheet/3
.
Link to this section Summary
Types
Error tuple with message describing the cause of the error
List of cell values
List of rows
Sheet name
Source for the XLSX file: file system (:path
) or in-memory (:binary
)
Option to specify the XLSX file source
Functions
Opens an XLSX file located on the file system (default) or from memory.
Loads the sheet with the given name (see sheet_names/1
)
Lists the names of the sheets in the package's workbook
Loads all the sheets in the workbook.
Link to this section Types
Error tuple with message describing the cause of the error
List of cell values
List of rows
Sheet name
Source for the XLSX file: file system (:path
) or in-memory (:binary
)
Option to specify the XLSX file source
Link to this section Functions
open(file, options \\ [])
View Sourceopen(String.t() | binary(), [source_option()]) :: {:ok, XlsxReader.Package.t()} | error()
Opens an XLSX file located on the file system (default) or from memory.
Examples
Opening XLSX file on the file system
{:ok, package} = XlsxReader.open("test.xlsx")
Opening XLSX file from memory
blob = File.read!("test.xlsx")
{:ok, package} = XlsxReader.open(blob, source: :binary)
Options
source
::path
(on the file system, default) or:binary
(in memory)
sheet(package, sheet_name, options \\ [])
View Sourcesheet(XlsxReader.Package.t(), sheet_name(), Keyword.t()) :: {:ok, rows()}
Loads the sheet with the given name (see sheet_names/1
)
Options
sheet_names(package)
View Sourcesheet_names(XlsxReader.Package.t()) :: [sheet_name()]
Lists the names of the sheets in the package's workbook
sheets(package, options \\ [])
View Sourcesheets(XlsxReader.Package.t(), Keyword.t()) :: {:ok, [{sheet_name(), rows()}]} | error()
Loads all the sheets in the workbook.
On success, returns a list of {sheet_name, rows}
pairs.
Options
See sheet/2
.