Xlsxir v1.2.0 API Reference

Modules

Extracts and parses data from a .xlsx file to an Erlang Term Storage (ETS) process and provides various functions for accessing the data

Converts an ISO 8601 date format serial number, in char_list format, to a date formatted in Erlang :calendar.date() type format (i.e. {year, month, day})

An Agent process named Index which holds state of an index. Provides functions to create the process, increment the index by 1, retrieve the current index and ultimately kill the process

Holds the SAX event instructions for parsing sharedString data via Xlsxir.SaxParser.parse/2

Holds the SAX event instructions for parsing style data via Xlsxir.SaxParser.parse/2

Holds the SAX event instructions for parsing worksheet data via Xlsxir.SaxParser.parse/2

Provides SAX (Simple API for XML) parsing functionality of the .xlsx file via the Erlsom Erlang library. SAX (Simple API for XML) is an event-driven parsing algorithm for parsing large XML files in chunks, preventing the need to load the entire DOM into memory. Current chunk size is set to 10,000

An Erlang Term Storage (ETS) process named :sharedstrings which holds state for data parsed from sharedStrings.xml. Provides functions to create the process, add and retreive data, and ultimately kill the process

An Erlang Term Storage (ETS) process named :styles which holds state for data parsed from styles.xml. Provides functions to create the process, add and retreive data, and ultimately kill the process. Also includes a temporary Agent process named NumFmtIds which is utilized during the parsing of the styles.xml file to temporarily hold state of each NumFmtId contained within the file

An Agent process named Time which holds state for time elapsed since execution. Provides functions to start and stop the process, with the stop function returning the time elapsed as a list (i.e. [hour, minute, second, microsecond])

Provides validation of accepted file extension types for file path, extracts required .xlsx contents to ./temp and ultimately deletes the ./temp directory and its contents

An Erlang Term Storage (ETS) process named :worksheet which holds state for data parsed from sheet#{n}.xml at index n. Provides functions to create the process, add and retreive data, and ultimately kill the process