Repository files navigation

Parser and writer for various spreadsheet formats. Pure-JS cleanroom implementation from official specifications and related documents.

NOTE:This project is a fork of the original (and awesome)SheetJS/xlsx project.It is extended to enable cell formats to be read from and written to .xlsx workbooks.The intent is to provide a temporary means of using these features in practice, and ultimately to merge this into the primary project.Report any issues tohttps://github.com/protobi/js-xlsx/issues.

For those contributing to this fork:

• master is the main branch, which follows the original repo to enable a future pull request.
• beta branch is published to npm and bower to make this fork available for use.

Supported read formats:

• Excel 2007+ XML Formats (XLSX/XLSM)
• Excel 2007+ Binary Format (XLSB)
• Excel 2003-2004 XML Format (XML "SpreadsheetML")
• Excel 97-2004 (XLS BIFF8)
• Excel 5.0/95 (XLS BIFF5)
• OpenDocument Spreadsheet (ODS)

Supported write formats:

• XLSX
• CSV (and general DSV)
• JSON and JS objects (various styles)

Demo:http://oss.sheetjs.com/js-xlsx

Source:http://git.io/xlsx

Withnpm:

npm install xlsx-style --save

In the browser:

<scriptlang="javascript"src="dist/xlsx.core.min.js"></script>

Withbower:

bower install js-xlsx-style#beta

CDNjs automatically pulls the latest version and makes all versions available athttp://cdnjs.com/libraries/xlsx

The node version automatically requires modules for additional features. Someof these modules are rather large in size and are only needed in specialcircumstances, so they do not ship with the core. For browser use, they mustbe included directly:

<!-- international support from https://github.com/sheetjs/js-codepage --><scriptsrc="dist/cpexcel.js"></script><!-- ODS support --><scriptsrc="dist/ods.js"></script>

An appropriate version for each dependency is included in the dist/ directory.

The complete single-file version is generated atdist/xlsx.full.min.js

Since xlsx.js uses ES5 functions likeArray#forEach, older browsers requirePolyfills. This repo and the gh-pages branch includea shim

To use the shim, add the shim before the script tag that loads xlsx.js:

<scripttype="text/javascript"src="/path/to/shim.js"></script>

For parsing, the first step is to read the file. This involves acquiring thedata and feeding it into the library. Here are a few common scenarios:

• node readFile:

if(typeofrequire!=='undefined')XLSX=require('xlsx');varworkbook=XLSX.readFile('test.xlsx');/* DO SOMETHING WITH workbook HERE */

• ajax (for a more complete example that works in older browsers, check the demoathttp://oss.sheetjs.com/js-xlsx/ajax.html):

/* set up XMLHttpRequest */varurl="test_files/formula_stress_test_ajax.xlsx";varoReq=newXMLHttpRequest();oReq.open("GET",url,true);oReq.responseType="arraybuffer";oReq.onload=function(e){vararraybuffer=oReq.response;/* convert data to binary string */vardata=newUint8Array(arraybuffer);vararr=newArray();for(vari=0;i!=data.length;++i)arr[i]=String.fromCharCode(data[i]);varbstr=arr.join("");/* Call XLSX */varworkbook=XLSX.read(bstr,{type:"binary"});/* DO SOMETHING WITH workbook HERE */}oReq.send();

• HTML5 drag-and-drop using readAsBinaryString:

/* set up drag-and-drop event */functionhandleDrop(e){e.stopPropagation();e.preventDefault();varfiles=e.dataTransfer.files;vari,f;for(i=0,f=files[i];i!=files.length;++i){varreader=newFileReader();varname=f.name;reader.onload=function(e){vardata=e.target.result;/* if binary string, read with type 'binary' */varworkbook=XLSX.read(data,{type:'binary'});/* DO SOMETHING WITH workbook HERE */};reader.readAsBinaryString(f);}}drop_dom_element.addEventListener('drop',handleDrop,false);

• HTML5 input file element using readAsBinaryString:

functionhandleFile(e){varfiles=e.target.files;vari,f;for(i=0,f=files[i];i!=files.length;++i){varreader=newFileReader();varname=f.name;reader.onload=function(e){vardata=e.target.result;varworkbook=XLSX.read(data,{type:'binary'});/* DO SOMETHING WITH workbook HERE */};reader.readAsBinaryString(f);}}input_dom_element.addEventListener('change',handleFile,false);

The full object format is described later in this README.

This example extracts the value stored in cell A1 from the first worksheet:

varfirst_sheet_name=workbook.SheetNames[0];varaddress_of_cell='A1';/* Get worksheet */varworksheet=workbook.Sheets[first_sheet_name];/* Find desired cell */vardesired_cell=worksheet[address_of_cell];/* Get the value */vardesired_value=desired_cell.v;

This example iterates through every nonempty of every sheet and dumps values:

varsheet_name_list=workbook.SheetNames;sheet_name_list.forEach(function(y){/* iterate through sheets */varworksheet=workbook.Sheets[y];for(zinworksheet){/* all keys that do not begin with "!" correspond to cell addresses */if(z[0]==='!')continue;console.log(y+"!"+z+"="+JSON.stringify(worksheet[z].v));}});

Complete examples:

• http://oss.sheetjs.com/js-xlsx/ HTML5 File API / Base64 Text / Web Workers

Note that older versions of IE does not support HTML5 File API, so the base64mode is provided for testing. On OSX you can get the base64 encoding with:

$<target_file.xlsx base64| pbcopy

• http://oss.sheetjs.com/js-xlsx/ajax.html XMLHttpRequest

• https://github.com/SheetJS/js-xlsx/blob/master/bin/xlsx.njs node

The node version installs a command line toolxlsx which can read spreadsheetfiles and output the contents in various formats. The source is available atxlsx.njs in the bin directory.

Some helper functions inXLSX.utils generate different views of the sheets:

• XLSX.utils.sheet_to_csv generates CSV
• XLSX.utils.sheet_to_json generates an array of objects
• XLSX.utils.sheet_to_formulae generates a list of formulae

For writing, the first step is to generate output data. The helper functionswrite andwriteFile will produce the data in various formats suitable fordissemination. The second step is to actual share the data with the end point.Assumingworkbook is a workbook object:

• nodejs write to file:

/* output format determined by filename */XLSX.writeFile(workbook,'out.xlsx');/* at this point, out.xlsx is a file that you can distribute */

• write to binary string (using FileSaver.js):

/* bookType can be 'xlsx' or 'xlsm' or 'xlsb' */varwopts={bookType:'xlsx',bookSST:false,type:'binary'};varwbout=XLSX.write(workbook,wopts);functions2ab(s){varbuf=newArrayBuffer(s.length);varview=newUint8Array(buf);for(vari=0;i!=s.length;++i)view[i]=s.charCodeAt(i)&0xFF;returnbuf;}/* the saveAs call downloads a file on the local machine */saveAs(newBlob([s2ab(wbout)],{type:""}),"test.xlsx")

Complete examples:

• http://sheetjs.com/demos/writexlsx.html generates a simple file
• http://git.io/WEK88Q writing an array of arrays in nodejs
• http://sheetjs.com/demos/table.html exporting an HTML table

XLSX is the exposed variable in the browser and the exported node variable

XLSX.version is the version of the library (added by the build script).

XLSX.SSF is an embedded version of theformat library.

XLSX.read(data, read_opts) attempts to parsedata.

XLSX.readFile(filename, read_opts) attempts to readfilename and parse.

XLSX.write(wb, write_opts) attempts to write the workbookwb

XLSX.writeFile(wb, filename, write_opts) attempts to writewb tofilename

Utilities are available in theXLSX.utils object:

Exporting:

• sheet_to_json converts a workbook object to an array of JSON objects.
• sheet_to_csv generates delimiter-separated-values output
• sheet_to_formulae generates a list of the formulae (with value fallbacks)

Cell and cell address manipulation:

• format_cell generates the text value for a cell (using number formats)
• {en,de}code_{row,col} convert between 0-indexed rows/cols and A1 forms.
• {en,de}code_cell converts cell addresses
• {en,de}code_range converts cell ranges

js-xlsx conforms to the Common Spreadsheet Format (CSF):

Cell address objects are stored as{c:C, r:R} whereC andR are 0-indexedcolumn and row numbers, respectively. For example, the cell addressB5 isrepresented by the object{c:1, r:4}.

Cell range objects are stored as{s:S, e:E} whereS is the first cell andE is the last cell in the range. The ranges are inclusive. For example, therangeA3:B7 is represented by the object{s:{c:0, r:2}, e:{c:1, r:6}}. Utilsuse the following pattern to walk each of the cells in a range:

for(varR=range.s.r;R<=range.e.r;++R){for(varC=range.s.c;C<=range.e.c;++C){varcell_address={c:C,r:R};}}

Built-in export utilities (such as the CSV exporter) will use thew text if itis available. To change a value, be sure to deletecell.w (or set it toundefined) before attempting to export. The utilities will regenerate thewtext from the number format (cell.z) and the raw value if possible.

Note: The .z attribute is now deprecated. Use the.s attribute to specify cell styles including number formats.To specify a number format, uses.numFmt, e.g.{v: 42145.822, s: { numFmt: "m/dd/yy"}} described below.

The raw value is stored in thev field, interpreted based on thet field.

Typeb is the Boolean type.v is interpreted according to JS truth tables

Typee is the Error type.v holds the number andw holds the common name:

Typen is the Number type. This includes all forms of data that Excel storesas numbers, such as dates/times and Boolean fields. Excel exclusively uses datathat can be fit in an IEEE754 floating point number, just like JS Number, so thev field holds the raw number. Thew field holds formatted text.

Typed is the Date type, generated only when the optioncellDates is passed.Since JSON does not have a natural Date type, parsers are generally expected tostore ISO 8601 Date strings like you would get fromdate.toISOString(). Onthe other hand, writers and exporters should be able to handle date strings andJS Date objects. Note that Excel disregards the timezone modifier and treats alldates in the local timezone. js-xlsx does not correct for this error.

Types is the String type.v should be explicitly stored as a string toavoid possible confusion.

Each key that does not start with! maps to a cell (usingA-1 notation)

worksheet[address] returns the cell object for the specified address.

Special worksheet keys (accessible asworksheet[key], each starting with!):

• ws['!ref']: A-1 based range representing the worksheet range. Functions thatwork with sheets should use this parameter to determine the range. Cells thatare assigned outside of the range are not processed. In particular, whenwriting a worksheet by hand, be sure to update the range. For a longerdiscussion, seehttp://git.io/KIaNKQ

  Functions that handle worksheets should test for the presence of!ref field.If the!ref is omitted or is not a valid range, functions are free to treatthe sheet as empty or attempt to guess the range. The standard utilities thatship with this library treat sheets as empty (for example, the CSV output is anempty string).

  When reading a worksheet with thesheetRows property set, the ref parameterwill use the restricted range. The original range is set atws['!fullref']

• ws['!cols']: array of column properties objects. Column widths are actuallystored in files in a normalized manner, measured in terms of the "MaximumDigit Width" (the largest width of the rendered digits 0-9, in pixels). Whenparsed, the column objects store the pixel width in thewpx field, characterwidth in thewch field, and the maximum digit width in theMDW field.

• ws['!merges']: array of range objects corresponding to the merged cells inthe worksheet. Plaintext utilities are unaware of merge cells. CSV exportwill write all cells in the merge range if they exist, so be sure that onlythe first cell (upper-left) in the range is set.

• ws['!printHeader']: array of row indices for repeating row headers on print, e.g.[1:1] to repeat just the first row.

The following properties are currently used when generating an XLSX file, but not yet parsed:

• ws['!rowBreaks']: array of row break points, e.g.[16,32]
• ws['!colBreaks']: array of col break points, e.g.[8,16]
• ws['!pageSetup']: `{scale: '100', orientation: 'portrait'||'landscape'}

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

wb.Sheets[sheetname] returns an object representing the worksheet.

wb.Props is an object storing the standard properties. The following properties are currently used whengenerating an XLSX file, but not yet parsed:-title-subject-description-keywords-creator

wb.Custprops stores custom properties. Since the XLS standard properties deviate from the XLSXstandard, XLS parsing stores core properties in both places. .

The exportedread andreadFile functions accept an options argument:

• cellFormula option only applies to formats that require extra processing toparse formulae (XLS/XLSB).
• Even ifcellNF is false, formatted text will be generated and saved to.w
• In some cases, sheets may be parsed even ifbookSheets is false.
• bookSheets andbookProps combine to give both sets of information
• Deps will be an empty object ifbookDeps is falsy
• bookFiles behavior depends on file type:
  • keys array (paths in the ZIP) for ZIP-based formats
  • files hash (mapping paths to objects representing the files) for ZIP
  • cfb object for formats using CFB containers
• sheetRows-1 rows will be generated when looking at the JSON object output(since the header row is counted as a row when parsing the data)
• bookVBA merely exposes the raw vba object. It does not parse the data.
• cellDates currently does not convert numerical dates to JS dates.
• Currently only XOR encryption is supported. Unsupported error will be thrownfor files employing other encryption methods.

The defaults are enumerated in bits/84_defaults.js

The exportedwrite andwriteFile functions accept an options argument:

• bookSST is slower and more memory intensive, but has better compatibilitywith older versions of iOS Numbers
• bookType = 'xlsb' is stubbed and far from complete
• The raw data is the only thing guaranteed to be saved. Formulae, formatting,and other niceties may not be serialized (pending CSF standardization)
• cellDates only applies to XLSX output and is not guaranteed to work withthird-party readers. Excel itself does not usually write cells with typedso non-Excel tools may ignore the data or blow up in the presence of dates.
• showGridLines and tabSelected are currently used when generating an XLSX file but not yet parse.
• Props specifies workbook properties

Cell styles are specified by a style object that roughly parallels the OpenXML structure. The style object has fivetop-level attributes:fill,font,numFmt,alignment, andborder.

| Style Attribute | Sub Attributes | Values || :-------------- | :------------- | :------------- | :----- || fill | patternType |"solid" or"none" || | fgColor |COLOR_SPEC| | bgColor |COLOR_SPEC| font | name |"Calibri" // default| | sz |"11" // font size in points| | color |COLOR_SPEC| | bold |true || false| | underline |true || false| | italic |true || false| | strike |true || false| | outline |true || false| | shadow |true || false| | vertAlign |true || false| numFmt | |"0" // integer index to built in formats, see StyleBuilder.SSF property| | |"0.00%" // string matching a built-in format, see StyleBuilder.SSF| | |"0.0%" // string specifying a custom format| | |"0.00%;\\(0.00%\\);\\-;@" // string specifying a custom format, escaping special characters| | |"m/dd/yy" // string a date format using Excel's format notation| alignment | vertical |"bottom"||"center"||"top"| | horizontal |"bottom"||"center"||"top"| | wrapText |true || false| | readingOrder |2 // for right-to-left| | textRotation | Number from0 to180 or255 (default is0)| | |90 is rotated up 90 degrees| | |45 is rotated up 45 degrees| | |135 is rotated down 45 degrees| | |180 is rotated down 180 degrees| | |255 is special, aligned vertically| border | top |{ style: BORDER_STYLE, color: COLOR_SPEC }| | bottom |{ style: BORDER_STYLE, color: COLOR_SPEC }| | left |{ style: BORDER_STYLE, color: COLOR_SPEC }| | right |{ style: BORDER_STYLE, color: COLOR_SPEC }| | diagonal |{ style: BORDER_STYLE, color: COLOR_SPEC }| | diagonalUp |true||false| | diagonalDown |true||false

COLOR_SPEC: Colors forfill,font, andborder are specified as objects, either:

• { auto: 1} specifying automatic values
• { rgb: "FFFFAA00" } specifying a hex ARGB value
• { theme: "1", tint: "-0.25"} specifying an integer index to a theme color and a tint value (default 0)
• { indexed: 64} default value forfill.bgColor

BORDER_STYLE: Border style is a string value which may take on one of the following values:

• thin
• medium
• thick
• dotted
• hair
• dashed
• mediumDashed
• dashDot
• mediumDashDot
• dashDotDot
• mediumDashDotDot
• slantDashDot

Borders for merged areas are specified for each cell within the merged area. So to apply a box border to a merged area of 3x3 cells, border styles would need to be specified for eight different cells:

• left borders for the three cells on the left,
• right borders for the cells on the right
• top borders for the cells on the top
• bottom borders for the cells on the left

• NodeJS 0.8, 0.10 (latest release), 0.11.14 (unstable), io.js
• IE 6/7/8/9/10/11 using Base64 mode (IE10/11 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:

• https://travis-ci.org/SheetJS/js-xlsx for XLSX module in nodejs
• https://travis-ci.org/SheetJS/SheetJS.github.io for XLS* modules
• https://saucelabs.com/u/sheetjs for XLS* modules using Sauce Labs

Test files are housed inanother repo.

Runningmake init will refresh thetest_files submodule and get the files.

make test will run the node-based tests. To run the in-browser tests, clonethe oss.sheetjs.com repo andreplace the xlsx.js file (then fire up the browser and go tostress.html):

$ cp xlsx.js ../SheetJS.github.io$cd ../SheetJS.github.io$ simplehttpserver# or "python -mSimpleHTTPServer" or "serve"$ open -a Chromium.app http://localhost:8000/stress.html

For a much smaller test, runmake test_misc.

Due to the precarious nature of the Open Specifications Promise, it is veryimportant to ensure code is cleanroom. Consult CONTRIBUTING.md

The xlsx.js file is constructed from the files in thebits subdirectory. Thebuild script (runmake) will concatenate the individual bits to produce thescript. Before submitting a contribution, ensure that running make will producethe xlsx.js file exactly. The simplest way to test is to move the script:

$ mv xlsx.js xlsx.new.js$ make$ diff xlsx.js xlsx.new.js

To produce the dist files, runmake dist. The dist files are updated in eachversion release and should not be committed between versions.

Please consult the attached LICENSE file for details. All rights not explicitlygranted 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 ofthe Microsoft Open Specifications Promise, falling under the same terms asOpenOffice (which is governed by the Apache License v2). Given the vagaries ofthe promise, the Original Author makes no legal claim that in fact end users areprotected from future actions. It is highly recommended that, for commercialuses, you consult a lawyer before proceeding.

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

OSP-covered specifications:

• [MS-XLSB]: Excel (.xlsb) Binary File Format
• [MS-XLSX]: Excel (.xlsx) Extensions to the Office Open XML SpreadsheetML File Format
• [MS-OE376]: Office Implementation Information for ECMA-376 Standards Support
• [MS-CFB]: Compound File Binary File Format
• [MS-XLS]: Excel Binary File Format (.xls) Structure Specification
• [MS-ODATA]: Open Data Protocol (OData)
• [MS-OFFCRYPTO]: Office Document Cryptography Structure
• [MS-OLEDS]: Object Linking and Embedding (OLE) Data Structures
• [MS-OLEPS]: Object Linking and Embedding (OLE) Property Set Data Structures
• [MS-OSHARED]: Office Common Data Types and Objects Structures
• [MS-OVBA]: Office VBA File Format Structure
• [MS-CTXLS]: Excel Custom Toolbar Binary File Format
• [MS-XLDM]: Spreadsheet Data Model File Format
• [MS-EXSPXML3]: Excel Calculation Version 2 Web Service XML Schema
• [XLS]: Microsoft Office Excel 97-2007 Binary File Format Specification

Open Document Format for Office Applications Version 1.2 (29 September 2011)