docs.sheetjs.comSheetJS Community Edition

SheetJS js-xlsx Parser and writer for various spreadsheet formats. Pure-JS cleanroom implementation from official specifications, related documents, and test files. Emphasis on parsing and writing robustness, cross-format feature compatibility with a unified JS representation, and ES3/ES5 browser compatibility back to IE6. This is the community version. We also offer a pro version with performance enhancements, additional features like styling, and dedicated support. Pro Version Commercial Support Rendered Documentation In-Browser Demos Source Code Issues and Bug Reports File format support for known spreadsheet data formats: Graph of supported formats (click to show) Browser Test Table of Contents Expand to show Table of Contents Installation JS Ecosystem Demos Optional Modules ECMAScript 5 Compatibility Philosophy Parsing Workbooks Parsing Examples Streaming Read Working with the Workbook Parsing and Writing Examples Writing Workbooks Writing Examples Streaming Write Interface Parsing functions Writing functions Utilities Common Spreadsheet Format General Structures Cell Object Data Types Dates Sheet Objects Worksheet Object Chartsheet Object Macrosheet Object Dialogsheet Object Workbook Object Workbook File Properties Workbook-Level Attributes Defined Names Workbook Views Miscellaneous Workbook Properties Document Features Formulae Column Properties Row Properties Number Formats Hyperlinks Cell Comments Sheet Visibility VBA and Macros Parsing Options Input Type Guessing File Type Writing Options Supported Output Formats Output Type Utility Functions Array of Arrays Input Array of Objects Input HTML Table Input Formulae Output Delimiter-Separated Output UTF-16 Unicode Text HTML Output JSON File Formats Excel 2007+ XML (XLSX/XLSM) Excel 2.0-95 (BIFF2/BIFF3/BIFF4/BIFF5) Excel 97-2004 Binary (BIFF8) Excel 2003-2004 (SpreadsheetML) Excel 2007+ Binary (XLSB, BIFF12) Delimiter-Separated Values (CSV/TXT) Other Workbook Formats Lotus 1-2-3 (WKS/WK1/WK2/WK3/WK4/123) Quattro Pro (WQ1/WQ2/WB1/WB2/WB3/QPW) OpenDocument Spreadsheet (ODS/FODS) Uniform Office Spreadsheet (UOS1/2) Other Single-Worksheet Formats dBASE and Visual FoxPro (DBF) Symbolic Link (SYLK) Lotus Formatted Text (PRN) Data Interchange Format (DIF) HTML Rich Text Format (RTF) Ethercalc Record Format (ETH) Testing Node Browser Tested Environments Test Files Contributing OSX/Linux Windows Tests License References Installation In the browser, just add a script tag: < script lang = " javascript " src = " dist/xlsx.full.min.js " ></ script > CDN Availability (click to show) CDN URL unpkg https://unpkg.com/xlsx/ jsDelivr https://jsdelivr.com/package/npm/xlsx CDNjs http://cdnjs.com/libraries/xlsx packd https://bundle.run/ [email protected] ?name=XLSX unpkg makes the latest version available at: < script src = " https://unpkg.com/xlsx/dist/xlsx.full.min.js " ></ script > With npm : $ npm install xlsx With bower : $ bower install js-xlsx JS Ecosystem Demos The demos directory includes sample projects for: Frameworks and APIs angularjs angular 2 / 4 / 5 / 6 and ionic knockout meteor react and react-native vue 2.x and weex XMLHttpRequest and fetch nodejs server databases and key/value stores typed arrays and math Bundlers and Tooling browserify fusebox parcel requirejs rollup systemjs typescript webpack 2.x Platforms and Integrations electron application nw.js application Chrome / Chromium extensions Adobe ExtendScript Headless Browsers canvas-datagrid Swift JSC and other engines "serverless" functions internet explorer Other examples are included in the showcase . Optional Modules Optional features (click to show) The node version automatically requires modules for additional features. Some of these modules are rather large in size and are only needed in special circumstances, so they do not ship with the core. For browser use, they must be included directly: <!-- international support from js-codepage --> < script src = " dist/cpexcel.js " ></ script > An appropriate version for each dependency is included in the dist/ directory. The complete single-file version is generated at dist/xlsx.full.min.js A slimmer build with XLSX / HTML support is generated at dist/xlsx.mini.min.js Webpack and Browserify builds include optional modules by default. Webpack can be configured to remove support with resolve.alias : /* uncomment the lines below to remove support */ resolve : { alias : { " ./dist/cpexcel.js " : " " } // <-- omit international support } ECMAScript 5 Compatibility Since the library uses functions like Array#forEach , older browsers require shims to provide missing functions . To use the shim, add the shim before the script tag that loads xlsx.js : <!-- add the shim first --> < script type = " text/javascript " src = " shim.min.js " ></ script > <!-- after the shim is referenced, add the library --> < script type = " text/javascript " src = " xlsx.full.min.js " ></ script > The script also includes IE_LoadFile and IE_SaveFile for loading and saving files in Internet Explorer versions 6-9. The xlsx.extendscript.js script bundles the shim in a format suitable for Photoshop and other Adobe products. Philosophy Philosophy (click to show) Prior to SheetJS, APIs for processing spreadsheet files were format-specific. Third-party libraries either supported one format, or they involved a separate set of classes for each supported file type. Even though XLSB was introduced in Excel 2007, nothing outside of SheetJS or Excel supported the format. To promote a format-agnostic view, js-xlsx starts from a pure-JS representation that we call the "Common Spreadsheet Format" . Emphasizing a uniform object representation enables new features like format conversion (reading an XLSX template and saving as XLS) and circumvents the "class trap". By abstracting the complexities of the various formats, tools need not worry about the specific file type! A simple object representation combined with careful coding practices enables use cases in older browsers and in alternative environments like ExtendScript and Web Workers. It is always tempting to use the latest and greatest features, but they tend to require the latest versions of browsers, limiting usability. Utility functions capture common use cases like generating JS objects or HTML. Most simple operations should only require a few lines of code. More complex operations generally should be straightforward to implement. Excel pushes the XLSX format as default starting in Excel 2007. However, there are other formats with more appealing properties. For example, the XLSB format is spiritually similar to XLSX but files often tend up taking less than half the space and open much faster! Even though an XLSX writer is available, other format writers are available so users can take advantage of the unique characteristics of each format. The primary focus of the Community Edition is correct data interchange, focused on extracting data from any compatible data representation and exporting data in various formats suitable for any third party interface. Parsing Workbooks For parsing, the first step is to read the file. This involves acquiring the data and feeding it into the library. Here are a few common scenarios: nodejs read a file (click to show) readFile is only available in server environments. Browsers have no API for reading arbitrary files given a path, so another strategy must be used. if ( typeof require !== ' undefined ' ) XLSX = require ( ' xlsx ' ); var workbook = XLSX . readFile ( ' test.xlsx ' ); /* DO SOMETHING WITH workbook HERE */ Photoshop ExtendScript read a file (click to show) readFile wraps the File logic in Photoshop and other ExtendScript targets. The specified path should be an absolute path: #include " xlsx.extendscript.js " /* Read test.xlsx from the Documents folder */ var workbook = XLSX . readFile ( Folder . myDocuments + ' / ' + ' test.xlsx ' ); /* DO SOMETHING WITH work...