SheetJS
7d15f35e3e
- build script strips `require` statements - finally every version is pinned (see #740 h/t @the-spyke) - removed colloquialisms in README
8.9 KiB
File Formats
Despite the library name xlsx, it supports numerous spreadsheet file formats:
| Format | Read | Write |
|---|---|---|
| Excel Worksheet/Workbook Formats | :-----: | :-----: |
| Excel 2007+ XML Formats (XLSX/XLSM) | ⭕ | ⭕ |
| Excel 2007+ Binary Format (XLSB BIFF12) | ⭕ | ⭕ |
| Excel 2003-2004 XML Format (XML "SpreadsheetML") | ⭕ | ⭕ |
| Excel 97-2004 (XLS BIFF8) | ⭕ | |
| Excel 5.0/95 (XLS BIFF5) | ⭕ | |
| Excel 4.0 (XLS/XLW BIFF4) | ⭕ | |
| Excel 3.0 (XLS BIFF3) | ⭕ | |
| Excel 2.0/2.1 (XLS BIFF2) | ⭕ | ⭕ |
| Excel Supported Text Formats | :-----: | :-----: |
| Delimiter-Separated Values (CSV/TXT) | ⭕ | ⭕ |
| Data Interchange Format (DIF) | ⭕ | ⭕ |
| Symbolic Link (SYLK/SLK) | ⭕ | ⭕ |
| Lotus Formatted Text (PRN) | ⭕ | ⭕ |
| UTF-16 Unicode Text (TXT) | ⭕ | ⭕ |
| Other Workbook/Worksheet Formats | :-----: | :-----: |
| OpenDocument Spreadsheet (ODS) | ⭕ | ⭕ |
| Flat XML ODF Spreadsheet (FODS) | ⭕ | ⭕ |
| Uniform Office Format Spreadsheet (标文通 UOS1/UOS2) | ⭕ | |
| dBASE II/III/IV / Visual FoxPro (DBF) | ⭕ | |
| Lotus 1-2-3 (WKS/WK1/WK2/WK3/WK4/123) | ⭕ | |
| Quattro Pro Spreadsheet (WQ1/WQ2/WB1/WB2/WB3/QPW) | ⭕ | |
| Other Common Spreadsheet Output Formats | :-----: | :-----: |
| HTML Tables | ⭕ | ⭕ |
Excel 2007+ XML (XLSX/XLSM)
(click to show)
XLSX and XLSM files are ZIP containers containing a series of XML files in accordance with the Open Packaging Conventions (OPC). The XLSM filetype, almost identical to XLSX, is used for files containing macros.
The format is standardized in ECMA-376 and later in ISO/IEC 29500. Excel does not follow the specification, and there are additional documents discussing how Excel deviates from the specification.
Excel 2.0-95 (BIFF2/BIFF3/BIFF4/BIFF5)
(click to show)
BIFF 2/3 XLS are single-sheet streams of binary records. Excel 4 introduced
the concept of a workbook (XLW files) but also had single-sheet XLS format.
The structure is largely similar to the Lotus 1-2-3 file formats. BIFF5/8/12
extended the format in various ways but largely stuck to the same record format.
There is no official specification for any of these formats. Excel 95 can write files in these formats, so record lengths and fields were backsolved by writing in all of the supported formats and comparing files. Excel 2016 can generate BIFF5 files, enabling a full suite of file tests starting from XLSX or BIFF2.
Excel 97-2004 Binary (BIFF8)
(click to show)
BIFF8 exclusively uses the Compound File Binary container format, splitting some content into streams within the file. At its core, it still uses an extended version of the binary record format from older versions of BIFF.
The MS-XLS specification covers the basics of the file format, and other
specifications expand on serialization of features like properties.
Excel 2003-2004 (SpreadsheetML)
(click to show)
Predating XLSX, SpreadsheetML files are simple XML files. There is no official and comprehensive specification, although MS has released whitepapers on the format. Since Excel 2016 can generate SpreadsheetML files, backsolving is pretty straightforward.
Excel 2007+ Binary (XLSB, BIFF12)
(click to show)
Introduced in parallel with XLSX, the XLSB filetype combines BIFF architecture with the content separation and ZIP container of XLSX. For the most part nodes in an XLSX sub-file can be mapped to XLSB records in a corresponding sub-file.
The MS-XLSB specification covers the basics of the file format, and other
specifications expand on serialization of features like properties.
Delimiter-Separated Values (CSV/TXT)
(click to show)
Excel CSV deviates from RFC4180 in a number of important ways. The generated CSV files should generally work in Excel although they may not work in RFC4180 compatible readers. The parser should generally understand Excel CSV. The writer proactively generates cells for formulae if values are unavailable.
Excel TXT uses tab as the delimiter and codepage 1200.
Other Workbook Formats
(click to show)
Support for other formats is generally far XLS/XLSB/XLSX support, due in large part to a lack of publicly available documentation. Test files were produced in the respective apps and compared to their XLS exports to determine structure. The main focus is data extraction.
Lotus 1-2-3 (WKS/WK1/WK2/WK3/WK4/123)
(click to show)
The Lotus formats consist of binary records similar to the BIFF structure. Lotus did release a whitepaper decades ago covering the original WK1 format. Other features were deduced by producing files and comparing to Excel support.
Quattro Pro (WQ1/WQ2/WB1/WB2/WB3/QPW)
(click to show)
The Quattro Pro formats use binary records in the same way as BIFF and Lotus. Some of the newer formats (namely WB3 and QPW) use a CFB enclosure just like BIFF8 XLS.
OpenDocument Spreadsheet (ODS/FODS)
(click to show)
ODS is an XML-in-ZIP format akin to XLSX while FODS is an XML format akin to SpreadsheetML. Both are detailed in the OASIS standard, but tools like LO/OO add undocumented extensions. The parsers and writers do not implement the full standard, instead focusing on parts necessary to extract and store raw data.
Uniform Office Spreadsheet (UOS1/2)
(click to show)
UOS is a very similar format, and it comes in 2 varieties corresponding to ODS and FODS respectively. For the most part, the difference between the formats is in the names of tags and attributes.
Other Single-Worksheet Formats
Many older formats supported only one worksheet:
dBASE and Visual FoxPro (DBF)
(click to show)
DBF is really a typed table format: each column can only hold one data type and each record omits type information. The parser generates a header row and inserts records starting at the second row of the worksheet.
Multi-file extensions like external memos and tables are currently unsupported, limited by the general ability to read arbitrary files in the web browser.
Symbolic Link (SYLK)
(click to show)
There is no real documentation. All knowledge was gathered by saving files in various versions of Excel to deduce the meaning of fields. Notes:
- Plain formulae are stored in the RC form.
- Column widths are rounded to integral characters.
Lotus Formatted Text (PRN)
(click to show)
There is no real documentation, and in fact Excel treats PRN as an output-only file format. Nevertheless we can guess the column widths and reverse-engineer the original layout. Excel's 240-character width limitation is not enforced.
Data Interchange Format (DIF)
(click to show)
There is no unified definition. Visicalc DIF differs from Lotus DIF, and both differ from Excel DIF. Where ambiguous, the parser/writer follows the expected behavior from Excel. In particular, Excel extends DIF in incompatible ways:
- Since Excel automatically converts numbers-as-strings to numbers, numeric
string constants are converted to formulae:
"0.3" -> "=""0.3"" - DIF technically expects numeric cells to hold the raw numeric data, but Excel permits formatted numbers (including dates)
- DIF technically has no support for formulae, but Excel will automatically convert plain formulae. Array formulae are not preserved.
HTML
(click to show)
Excel HTML worksheets include special metadata encoded in styles. For example,
mso-number-format is a localized string containing the number format. Despite
the metadata the output is valid HTML, although it does accept bare & symbols.