JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 41700
  • Score
    100M100P100Q11234F
  • License Apache-2.0

(one day) a full-featured XLS parser and writer. For now, primitive parser

Package Exports

  • xlsjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (xlsjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

xls

Currently a parser for XLS files. Cleanroom implementation from the Microsoft Open Specifications.

This has been tested on some basic XLS files generated from Excel 2011 (using compatibility mode).

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

Installation

In the browser:

<script src="xls.js"></script>

In node:

require('xlsjs').readFile('file');

The command-line utility xls2csv shows how to generate a CSV from an XLS.

Usage

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

See bin/xls2csv for a node example.

Notes

CFB refers to the Microsoft Compound File Binary Format, a container format for XLS as well as DOC and other pre-OOXML data formats.

The mechanism is split into a CFB parser (which scans through the file and produces concrete data chunks) and a Workbook parser (which does excel-specific parsing).

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

.Sheets[sheetname] returns a data structure representing the sheet

.Sheets[sheetname][address].val returns the value of the cell. Types are currently not recorded (but Number and RkNumber show up as javascript Numbers).

Test Files

Test files are housed in another repo.

Running make init will refresh the test_files submodule and get the files.

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

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.

XLSX Support

XLSX is available in my js-xlsx project.

References

OSP-covered specifications:

  • [MS-CFB]: Compound File Binary File Format
  • [MS-XLS]: Excel Binary File Format (.xls) Structure Specification
  • [MS-XLSX]: Excel (.xlsx) Extensions to the Office Open XML SpreadsheetML File Format
  • [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
  • [XLS]: Microsoft Office Excel 97-2007 Binary File Format Specification

Certain features are shared with the Office Open XML File Formats, covered in:

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

githalytics.com alpha