forked from sheetjs/docs.sheetjs.com
67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
|
## Interface
|
||
|
|
|
||
|
|
`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 the [format library](https://github.com/SheetJS/ssf).
|
||
|
|
|
||
|
|
### Parsing functions
|
||
|
|
|
||
|
|
`XLSX.read(data, read_opts)` attempts to parse `data`.
|
||
|
|
|
||
|
|
`XLSX.readFile(filename, read_opts)` attempts to read `filename` and parse.
|
||
|
|
|
||
|
|
Parse options are described in the [Parsing Options](#parsing-options) section.
|
||
|
|
|
||
|
|
### Writing functions
|
||
|
|
|
||
|
|
`XLSX.write(wb, write_opts)` attempts to write the workbook `wb`
|
||
|
|
|
||
|
|
`XLSX.writeFile(wb, filename, write_opts)` attempts to write `wb` to `filename`.
|
||
|
|
In browser-based environments, it will attempt to force a client-side download.
|
||
|
|
|
||
|
|
`XLSX.writeFileAsync(filename, wb, o, cb)` attempts to write `wb` to `filename`.
|
||
|
|
If `o` is omitted, the writer will use the third argument as the callback.
|
||
|
|
|
||
|
|
`XLSX.stream` contains a set of streaming write functions.
|
||
|
|
|
||
|
|
Write options are described in the [Writing Options](#writing-options) section.
|
||
|
|
|
||
|
|
### Utilities
|
||
|
|
|
||
|
|
Utilities are available in the `XLSX.utils` object and are described in the
|
||
|
|
[Utility Functions](#utility-functions) section:
|
||
|
|
|
||
|
|
**Constructing:**
|
||
|
|
|
||
|
|
- `book_new` creates an empty workbook
|
||
|
|
- `book_append_sheet` adds a worksheet to a workbook
|
||
|
|
|
||
|
|
**Importing:**
|
||
|
|
|
||
|
|
- `aoa_to_sheet` converts an array of arrays of JS data to a worksheet.
|
||
|
|
- `json_to_sheet` converts an array of JS objects to a worksheet.
|
||
|
|
- `table_to_sheet` converts a DOM TABLE element to a worksheet.
|
||
|
|
- `sheet_add_aoa` adds an array of arrays of JS data to an existing worksheet.
|
||
|
|
- `sheet_add_json` adds an array of JS objects to an existing worksheet.
|
||
|
|
|
||
|
|
|
||
|
|
**Exporting:**
|
||
|
|
|
||
|
|
- `sheet_to_json` converts a worksheet object to an array of JSON objects.
|
||
|
|
- `sheet_to_csv` generates delimiter-separated-values output.
|
||
|
|
- `sheet_to_txt` generates UTF16 formatted text.
|
||
|
|
- `sheet_to_html` generates HTML 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).
|
||
|
|
- `encode_row / decode_row` converts between 0-indexed rows and 1-indexed rows.
|
||
|
|
- `encode_col / decode_col` converts between 0-indexed columns and column names.
|
||
|
|
- `encode_cell / decode_cell` converts cell addresses.
|
||
|
|
- `encode_range / decode_range` converts cell ranges.
|
||
|
|
|