📗 SheetJS Community Edition -- Spreadsheet Data Toolkit
Go to file
SheetJS 9c9aad5df3 version bump 0.3.9: general format used by default
(when no format or style is found, use general)

Other whitespace cleanup
2014-01-23 11:14:11 -05:00
bin version bump 0.3.8: more formatting 2014-01-23 01:20:19 -05:00
bits version bump 0.3.9: general format used by default 2014-01-23 11:14:11 -05:00
misc added simple typescript reference file 2013-11-15 05:35:40 -08:00
tests version bump 0.3.7: comments and coverage 2014-01-21 23:58:26 -05:00
.gitignore
.gitmodules updating test_files 2013-12-06 14:24:52 -05:00
.npmignore browser cleanup 2013-11-09 13:21:03 -08:00
.travis.yml version bump 0.3.7: comments and coverage 2014-01-21 23:58:26 -05:00
index.html version bump 0.3.8: more formatting 2014-01-23 01:20:19 -05:00
jszip.js version bump 0.3.2: cleanup 2013-11-06 00:09:23 -08:00
LICENSE 2014 update [ci skip] 2014-01-07 01:23:42 -05:00
Makefile version bump 0.3.7: comments and coverage 2014-01-21 23:58:26 -05:00
package.json version bump 0.3.9: general format used by default 2014-01-23 11:14:11 -05:00
README.md 2014 update [ci skip] 2014-01-07 01:23:42 -05:00
test_files version bump 0.3.0: necessary cleanup 2013-10-30 14:50:34 -07:00
test.js version bump 0.3.9: general format used by default 2014-01-23 11:14:11 -05:00
tests.lst updating test_files submodule 2014-01-15 08:58:55 -05:00
xlsx.js version bump 0.3.9: general format used by default 2014-01-23 11:14:11 -05:00
xlsxworker.js added web workers 2013-11-22 14:58:11 -08:00

xlsx

Currently a parser for XLSX files. Cleanroom implementation from the ISO 29500 Office Open XML specifications.

This has been tested on some very basic XLSX files generated from Excel 2011.

If you need something that is not currently supported, file an issue and attach a sample file. I will get to it :)

Installation

In node:

npm install xlsx

In the browser:

<script lang="javascript" src="/path/to/jszip.js"></script>
<script lang="javascript" src="/path/to/xlsx.js"></script>

Tested Environments

  • Node 0.8.14, 0.10.1
  • IE 6/7/8/9/10 using Base64 mode (IE10 using HTML5 mode)
  • FF 18 using Base64 or HTML5 mode
  • Chrome 24 using Base64 or HTML5 mode

Tests utilize the mocha testing framework. Travis-CI and Sauce Labs links:

Usage

See xlsx2csv.njs in the bin directory for usage in node.

See http://oss.sheetjs.com/js-xlsx/ for a browser example.

Note that IE does not support HTML5 File API, so the base64 mode is provided for testing. On OSX you can get the base64 encoding by running:

$ <target_file.xlsx base64 | pbcopy # the pbcopy puts the content in the clipboard

Notes

.SheetNames is an ordered list of the sheets in the workbook

.Sheets[sheetname] returns a data structure representing the sheet. Each key that does not start with ! corresponds to a cell (using A-1 notation).

.Sheets[sheetname][address].v returns the value of the specified cell and .Sheets[sheetname][address].t returns the type of the cell (constrained to the enumeration ST_CellType as documented in page 4215 of ISO/IEC 29500-1:2012(E) )

Simple usage:

var XLSX = require('xlsx')
var xlsx = XLSX.readFile('test.xlsx');
var sheet_name_list = xlsx.SheetNames;
xlsx.SheetNames.forEach(function(y) {
  for (z in xlsx.Sheets[y]) {
    if(z[0] === '!') continue;
    console.log(y + "!" + z + "=" + JSON.stringify(xlsx.Sheets[y][z].v));
  }
});

For more details:

  • bin/xlsx2csv.njs is a tool for node
  • index.html is the live demo
  • bits/90_utils.js contains the logic for generating CSV and JSON from sheets

Test Files

Test files are housed in another repo.

License

Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 license are reserved by the Original Author.

It is the opinion of the Original Author that this code conforms to the terms of the Microsoft Open Specifications Promise, falling under the same terms as OpenOffice (which is governed by the Apache License v2). Given the vagaries of the promise, the Original Author makes no legal claim that in fact end users are protected from future actions. It is highly recommended that, for commercial uses, you consult a lawyer before proceeding.

XLS Support

XLS is available in my js-xls project.

References

ISO/IEC 29500:2012(E) "Information technology — Document description and processing languages — Office Open XML File Formats"

OSP-covered specifications:

  • [MS-XLSX]: Excel (.xlsx) Extensions to the Office Open XML SpreadsheetML File Format

githalytics.com alpha