SheetJS js-xlsx

集成平台

Integrated Platform

自从库使用了像 这样的函数，老版本的浏览器需要shim 提供缺少的函数。

Since the library has used functions such as this, the old version of the browser requires .

包括移动App文件处理等更多的使用例子可以在included demos中查看。

More examples of use, including moving App files, can be found at included demos.

当处理可读流时，最简单的方式是缓存流，并且最后再去处理整个文件。这可以通过临时文件或者是显式连接流来实现。

The simplest way to handle a readable stream is to cache the stream and, finally, to process the entire file. This can be done by a temporary file or a visible stream of connections.

完整的对象格式会在本文件的后面部分进行介绍。

The complete object format will be presented at the end of this document.

• http://sheetjs.com/demos/modify.html read + modify + write files

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

node安装一个能够读取电子数据表和输出各种格式的命令行工具 。源码可以在 目录下的里面找到。

Node installs a command line tool that can read spreadsheets and output various formats. The source code can be found in the directory.

中的一些辅助函数会生成不同的工作表视图。

. Some of the auxiliary functions generate different sheet views.

• 生成CSV文件
• 生成UTF16的格式化文本
• 生成HTML
• 生成一个对象数组
• 生成一张公示列表

对编写而言，第一步是生成导出数据。辅助函数 和 将会生成各种适合分发的数据格式。第二步是和端点实际的共享数据。假设是一个工作簿对象。

For writing, the first step is to generate export data. Auxiliary functions and data formats will be generated that are suitable for distribution. The second step is to share actual data with the endpoint. Assumption is a workbook object.

included demos包含了移动app和其他专门的部署。

included demos includes mobile apps and other specialized deployments.

• http://sheetjs.com/demos/table.html 导出一个 HTML table
• http://sheetjs.com/demos/writexlsx.html 生成一个简单文件

对象中可以使用流式写入函数。流式函数像普通的函数一样传入相同的参数，不过返回一个可读流。但是他们只暴露在Nodejs中。

An object can use a flow-writing function. A current function carries the same parameter as a normal function, but returns a readable stream. But they are only exposed in Nodejs.

• 是 的流式版本。
• 是 的流式版本。
• 是 的流式版本。

https://github.com/sheetjs/sheetaki pips将可写流写入nodejs响应。

pips write streams to nodejs responses.

是浏览器暴露出来可以使用的方法，导出到node中能够使用的是库的版本(通过构建脚本添加)。是格式化库的嵌入版本。

It is the method that the browser is exposed to, and the version of the library that can be exported to Node is an embedded version of .

用来解析数据 。 用来读取文件名 并且解析。解析选项会在解析选项部分阐述。

Use to parsing data. Use to read file names and parsing. Parsing options are described in part at

用来写入工作簿 。 把 写入到特定的文件 中。如果是基于浏览器的环境，此函数会强制浏览器端下载。 把 写入到特定的文件 中。如果 被省略，写入函数会使用第三个参数作为回调函数。

To write to a workbook. Write to a specific file. If it is based on the browser environment, this function forces the browser to download. Write to a specific file. If omitted, the writing function uses the third parameter as a callback function.

写入选项会在写入选项部分部分进行阐述。

Writing options are described in section .

对象中的工具函数都可以使用，工具函数在工具函数部分进行阐述。

The tool functions in an object can be used. The tool functions are described in utility function .

导入:

Import:

• 把转换JS数据数组的数组为工作表。
• 把JS对象数组转换为工作表。
• 把DOM TABLE元素转换为工作表。
• 把JS数据数组的数组添加到已存在的工作表中。
• 把JS对象数组添加到已存在的工作表中。

导出:

Export:

• 把工作表转换为JS对象数组。
• 生成分隔符隔开值的输出。
• 生成UTF16格式化的文本。
• 生成HTML输出。
• 生成公式列表(带有值回退)。

单元格和单元格地址的操作:

Operation of cells and cell addresses:

• 生成文本类型的单元格值(使用数字格式)。
• 在0索引行和1索引行之间转换。
• 在0索引列和列名之间转换。
• 转换单元格地址。
• 转换单元格的范围。

js-xlsx符合常用的数据表格式(CSF)。

js-xlsx corresponds to the common data sheet format (CSF).

单元格地址对象的存储格式为，其中和分别代表的是0索引列和行号。例如单元格地址用对象表示。

Cell address objects are stored in a format that represents 0 index columns and row numbers, respectively. For example, a cell address is expressed as an object.

单元格范围对象存储格式为，其中是第一个单元格，是最后一个单元格。范围是包含关系。例如范围 用对象表示。当遍历数据表范围时，工具函数执行行优先命令。

Cell range objects are stored in format, with the first cell and the last cell. The range contains relationships. For example, the range is expressed as objects. When you go through the range of data tables, the tool function executes the line priority command.

单元格对象是纯粹的JS对象，它的keys和values遵循下列的约定：

Cells are intended for pure JS objects, with Keys and Values following the following agreement:

如果文本可以使用，内置的导出工具(比如CSV导出方法)就会使用它。要想改变单元格的值，在打算导出之前确保删除(或者设置 为)。工具函数会根据数字格式()和原始值(如果可用)重新生成文本。

If text can be used, the built-in export tool (e.g., CSV export method) will use it. To change the value of a cell, make sure that it is deleted (or set) before it is intended to export. The tool function will regenerate the text according to the number format () and the original value (if available).

真实的数组公式存储在数组范围中第一个单元个的字段内。此范围内的其他单元格会省略字段。

Real array formulae are stored in the field of the first cell in the array range. Other cells in this range omit fields.

原始值被存储在值属性中，用来解释基于类型的属性。这样的区别允许用于数字和数字类型文本的展示。下面有6种有效的单元格类型。

The original value is stored in the value property to explain the type-based properties. This distinction is allowed for the presentation of the text of the number and the type of number. There are six valid cell types below.

表示Number类型。包括了所有被Excel存储为数字的数据表，比如dates/times和Boolean字段。Excel专门使用能够被IEEE754浮点数表示的数据，比如JS Number，所以字段 保存原始数字。字段保持格式化文本。Dates 默认存储为数字，使用进行转换。

is the Number type. Includes all data tables stored as numbers by Excel, such as dates/times and Boolean fields. Excel uses data that can be expressed by IEE754 floats, such as JS Number, so the fields save the original numbers. The fields keep formatted text.

类型 表示日期类型，只有当选项为才会生成日期类型。因为JSON没有普通的日期类型，所以希望解析器存储的日期字符串像从中获取的一样。另一方面，写入函数和导出函数也可以处理日期字符串和JS日期对象。需要注意Excel会忽略时区修饰符，并且处理所有本地时区的日期。代码库没有改正这个错误。

Type The date type indicates that the date type is generated only if the option is selected. Because JSON does not have a normal date type, it wants the date string stored in the solver to be the same as that obtained from it. On the other hand, the writing and export functions can also handle the date string and the JS date object. Note that Excel ignores the time zone modifiers and processes all local time zone dates. The code library does not correct this error.

类型表示空白的存根单元格。生成存根单元格是为了以防万一单元格没有被赋予指定值，但是保留了注释或者是其他的元数据。存根单元格会被核心库的数据处理工具函数忽略。默认情况下不会生成存根单元格，只有当解析器的选项被设为时才会生成。

. The root cells are generated in case the cells are not assigned to the specified value, but the comment or other metadata are retained. The root cells are ignored by the data-processing tool function of the core library. The root cells are not generated by default, but only when the option of the parser is set.

日期

每一个不以开始的key都会映射到一个单元格(用符合)。 返回指定地址的单元格对象。

Each non-start key maps to a cell (with matching). Returns the cell object of the specified address.

指定的数据表属性(通过 访问, 每一个都以 开始):

数组公式被存储在数组块左上角的单元格内。一个数组公式的所有单元格都会有于该范围对应的字段。一个单一的单元格公式要注意于字段所存储的纯公式进行区分。

The array formula is stored in cells with the upper left corner of the array. All cells of a array formulae have fields corresponding to that range. A single cell formula is distinguished by the pure formula stored in the field.

工具函数和编写器被用来检查字段的存在，并且忽略单元格内任何可能的公式元素，这些单元格并不包含起始单元格。这些操作函数并不会被要求执行公式的校验。

Tool functions and compilers are used to check the existence of fields and to ignore any possible formula elements in cells that do not contain starting cells. These functions are not required to perform formula verifications.

行属性

如果 数组在每张电子表中都存在，那就是一个对象的集合，集合包含一下的属性：

If the arrays exist in every spreadsheet, it's a collection of objects that contains the properties:

注意：Excel UI显示基本大纲级别为,最大级别为。字段存储基本大纲级别为，最大级别为。

Note: Excel UI shows the base outline level, the maximum level. Field storage basic outline level, the maximum level.

数字格式

对于每一个单元格而言，的文本来自于 和 格式。如果格式没有指定，Excel格式就会被使用。格式要么是指定的的字符串要么是格式表内的一个索引。解析器应该用数字格式表来填充。写入函数用来序列化这个表。

For each cell, the text comes from both the & and the formatting. If the format is not specified, the Excel format is used. The formatting is either a specified string or an index within the formatting table. The parser should be filled with a digital formatting table. The writing function is used to sequence the table.

自定义的工具应该确保本地表的表内有各自的格式字符串。Excel约定规定自定义的格式以索引164开头。下面的例子从头创建了一个自定义的格式：

Customized tools should ensure that local tables contain their own formatting string. Excel agreed that the custom format should start with index 164. The following example creates a custom format from the beginning:

这些规则和Excel如何显示自定义的数字格式稍微有些区别。特别是文字字符必须必包含在双引号里面或者在反斜杠之前。更多信息，查看Excel文档 或者是ECMA-376 18.8.31(数字格式)。

These rules and Excel display a little bit different from the custom number format. In particular, text characters must be included in a double quote or before the backslash. For more information, look at Excel documents or ECMA-376, 18.8.31 (digital format).

格式14()被Excel本地化：即使文件指明了数字格式，也会根据系统设置用不同的方式绘制。当文件的的生产者和使用者都在相同的区域时这会很有用，不过对于网络上的例子就会不同。为了避免歧义，解析函数接受选项覆盖指定格式字符串的解释。

Format 14() is localized by Excel: Even if the file specifies a digital format, it is drawn in different ways according to the system settings. This is useful when the producers and users of the file are in the same area, but the examples on the network are different. To avoid ambiguity, the solution function accepts the explanation of the option overlaying the specified format string.

超链接

超链接存储在单元格对象的关键字内。超链接对象的字段是连接目标，包括了URI片段。工具提示被存储在字段内，当移动鼠标到文字上方就会显示。

Hyperlinks are stored in the key words of the cell object. The hyperlink object field is the connecting object, including the URL segment. Tooltips are stored in the field and are displayed when the mouse is moved to the top of the text.

例如下方的片段在单元格内创建了一个指向http://sheetjs.com的链接，提示信息是：

For example, the sub-snippets create a link in the cell to with the following message:

单元格注释

单元格注释是对象，被存储在单元格对象的数组内。实际上注释的内容根据注释的作者被分成了小块。每一个注释对象的字段存储注释的作者，字段是注释的纯文字展示。

cell comment is an object that is stored in the array of cell objects. The content of the note is in fact divided into blocks according to the author of the note. The author of each comment object field stores the comment, and the field is a plain text display of the comment.

例如下面的片段在单元格内添加了单元格注释：

For example, the following segments add cell notes to the cells:

注意：XLSB对作者的名字施加54个字符的限制。名字的长度超过54个字符可能造成其他的格式问题。

Note: XLSB limits the author's name to 54 characters. The length of the name exceeds 54 characters may cause other formatting problems.

把注释标记为普通的隐藏，只需设置属性：

Mark comments as ordinary hidden, just set attributes:

数据表能见度

Excel支持将表格隐藏在更低的标签栏。表格数据存储文件内，但是UI不容易让它可以使用。标准的隐藏表格会被显示在”Unhide”菜单内。Excel也有”very hidden”表格，这些表格不能被显示在菜单内。只可以通过Vb编辑器访问。

Excel supports hiding tables in lower tab bar. The table data storage file is not easy for UI to use. The standard hidden table is displayed in the Unhide menu. Excel also has the " very Hidden " table, which cannot be displayed in the menu. Only Vb editor can access it.

能见度的设置被存储在表格属性数组的属性当中。

Visibility settings are stored in the properties of the array of table properties.

VBA和宏命令

VBA宏命令存储在特殊的数据blob中，当选项为true时，blob会暴露在工作簿对象的属性中。VBA宏命令支持 , , 和 格式。如果blob存在于工作簿中，并且和工作簿的名字有关联，支持的格式写入函数会自动插入数据blob。

The VBA macro command is stored in a special data blob, which is exposed to the properties of the objects in the workbook when the selected item is true. The VBA macro command supports, and format. If the blob exists in the workbook and is associated with the name of the workbook, the supported format writing function automatically inserts data blob.

导出的 和 函数接受选项参数： | Option Name | Default | Description | | :————— | ———: | :—————————————————————————- | | | | 输入数据编码 (查看下方的输入类型) | | | false | 如果为true，纯文本解析不会解析值 | | | | 如果指定， 合适的时候使用编码页面 | || true | 保存公式到字段 | | | true | 解析富文本并把HTML保存到 字段 | | | false | 把数字格式的字符串保存到 字段 | | | false | 把样式/主题保存到 字段 | | | true | 生成格式化文本 字段 | | | false | 把日期存储为类型 (默认是 ) | | | | 如果指定，使用代码日期14的字符串 | | | false | 为子单元格创建类型的单元格对象 | | | 0 | 如果的值 >0, 读取第一个 行 | | | false | 值为true，解析计算链 | | | false | 如果值为true， 添加原始文件到工作簿对象 | | | false | 如果值为true， 只有足够的解析才能得到工作簿的元数据 | | | false | 如果值为true，只有足够的解析才能得到表格名称 | | | false | 如果值为true，复制 VBA blob 到 字段 | | | “” | 如果定义了密码并且文件已经加密，就会使用密码 | | | false | 如果值为true， 对意外的文件特性抛出错误 ** |

Option Name Description (see type of input under)

• 虽然为false，但是格式化的文本也会被生成并且保存到字段。
• 在一些情况下，即使为false，数据表也可能被解析。
• Excel积极尝试从CSV和其他纯文本中解释值。这会导致意外的行为！选项抑制值解析。
• 和 结合起来提供两套信息集合。
• 将会是一个空对象，如果为false。
• 的行为依赖于文件类型：
  • 数组(ZIP里面的路径)用于基于ZIP基础的格式
  • 哈希(将路径映射到表示文件的的对象)用于ZIP
  • 对象用于使用CFB容器的格式
• 将会在查看JSON对象输出时生成(因为解析数据时，数据头行会被计算成一行)
• 仅仅在展示原始的VBA CFB对象。不解析数据。XLSM 和 XLSB把VBA CFB对象存储在。BIFF8 XLS将VBA条目与核心工作簿条目混合在一起，因此库从XLS CFB容器生成了一个新的XLSB兼容blob。
• 用于没有记录的BIFF2 - BIFF5文件以及在内没有BOM的CSV文件。
• 目前仅支持XOR加密。当文件使用其他的加密方法时会抛出不支持的错误。
• WTF主要用于发展。默认情况下，单一的工作表内，解析器将会抑制读取错误，允许你从解析正确的工作表内读取。设置强制这些错误被抛出。

字符串能用很多种方式解释。的参数告诉库如何解析数据参数：

Strings can be interpreted in a variety of ways. The parameters tell the library how to interpret the data parameters:

导出的 和 函数接受一个选型参数：

Export function accepts an optional parameter:

• 较慢并且有更多的内存密集型，不过与iOS数字老版本有更好的兼容性。
• 原始数据时唯一保证存储的东西。在README文件中没有描述的功能可能无法序列化。
• 仅用于XLSX输出并且不能保证与第三方读取器一起工作。Excel自身不经常用类型编写单元格，因此非Excel工具会忽视数据或者是有日期错误。
• 是一个备份工作簿字段的对象。从工作簿文件属性 部分查看表格。
• 如果指定，来自的字符串会被存储为XLSX/XLSB/XLSM文件的基本主题(ZIP中的)。
• 由于在程序中有一个bug，一些功能比如”分列”会在忽略错误条件的工作表上使Excel崩溃。默认情况下写入函数将会标记文件忽略错误。设置为来禁止。

与第三方工具的广泛兼容性，这个库支持很多种输出格式。明确的文件类型被选项控制：

This library supports a wide range of output formats. Clear file types are controlled by options:

• 仅用于带ZIP容器的格式。
• 格式只支持需要选型指明工作表的单表。如果字符串为空，就会使用第一张工作表。
• 如果未指定值，那么会自动根据文件扩展名来猜测输出文件格式。他就会在上表中选择匹配扩展名的第一个格式。

函数的参数备份函数的参数： | | output | |——————|————————————————————————————————-| | | 字符串: 文件的Base64编码 | | | 字符串: 二进制字符串 (字节 是 ) | | | 字符串: JS 字符串 (字符被解释成UTF8) | | | nodejs Buffer | | | ArrayBuffer, 8位无符号整数的回退数组 | | | 字符串: 将要创建的文件的地址(仅用于nodejs) |

Parameters for the function's parameter backup function: output ---------------------------------------------------------------------------- string: binary string (word yes) string: JS string (word interpreted as UTF8) nodejs Buffer ArrayBuffer, 8-digit reverse array integer string: address of the document to be created (nodejs only)

函数接受一张工作表以及一个可选的选项对象。 函数接受一个数据对象以及一个可选的选项对象。 示例都是基于下面的工作表：

Function accepts a sheet and an optional object. Function accepts a data object and an optional object. Examples are based on the following sheet:

获取JS值数组的数组，并且返回一个工作表寻找输入数据。Numbers，Booleans和Strings都被存储为相应的样式。Date被存储为date或者是numbers。跳过数组孔和显式“未定义”值。值可能被剔除。所有其它值存储为字符串。函数获取选项参数：

Gets the array of JS value arrays and returns a sheet to look for input data. Numbers, Booleans and Strings are stored as the corresponding style. Date is stored as date or numberers. Skipping the array hole and display " undefined " values. Values can be cut off. All other values are stored as strings. Function capture option parameters:

获取JS值的数组的数组，并且更新一个已存在的工作表对象。它遵循和一样的过程，并且接受一个选项参数：

Retrieves the arrays of JS values and updates an existing sheet object. It follows the same process and accepts an option parameter:

应该是以下之一：

It should be one of the following:

获取对象数组并且返回一张基于对象自动生成”headers”的工作表。默认的列顺序由第一次出现的字段决定，这些字段通过使用得到，不过可以使用选项参数覆盖。

Gets an object array and returns a sheet that automatically generates "headers " on the basis of the object. The default column order is determined by the first-time field, which is obtained by use, although you can overwrite the option parameter.

获取一个对象数组，并且更新一个已存在的工作表对象。与一样有相同的过程，并且接受一个选项参数：

Gets an object array and updates an existing sheet object. There is the same process and accepts an option parameter:

应该是以下之一：

It should be one of the following:

获取一个table DOM元素，并且返回一个工作表寻找输入的table。Numbers会被解析。所有的数据将会被存储为字符串。

Gets a table DOM element and returns a sheet to find an inputable table. Numbers is parsed. All data will be stored as strings.

基于工作表会产生一个最小的工作簿。

A minimum workbook based on the sheet is created.

两个函数接受选项参数：

Two functions accept option parameters:

注意：能够处理表示为字符串的HTML。

N.B. Capable of handling HTML, expressed as a string.

生成一个命令数组，命令显示了一个人会怎样进入一个应用。每一个入口都是表格。字符串文字以”`”为前缀，符合Excel。

Generates a command array that shows how a person enters an application. Each entry is a table. String text is prefixed with " ` " and matches Excel.

作为一个 CSV 类型的替代，也会产生CSV输出。这个函数获取一个选项参数：

Replaces a CSV type with a CSV output. This function captures an option parameter:

• 将删除默认下每行的尾随逗号 必须设置为才能跳过空白行。

#### UTF-16 Unicode 文本

输出类型使用tab字符作为字段分隔符。如果可用(包含全部的分发但不是核心)，输出将会被编码为并且BOM会被预置。

The output type uses the tab character as a field separator. If available (including all distributions but not the core), the output will be encoded and BOM preset.

获取和一样的参数。

Get the same parameter.

作为’ writeFile ‘ HTML类型的替代，也会生成HTML输出。这个函数接受一个选项参数：

This function accepts an option parameter:

生成不同类型的JS对象。这个函数接受一个选项参数：

Generates different types of JS objects. This function accepts an option parameter:

• 只影响有格式编码()字段或者格式化文本()字段的单元格。
• 如果被指定，第一行就会被当做数据行；如果未指定，第一行是header并且不作为数据。
• 当header未指定时，转换将通过添加”_”和一个从”1”开始的计数自动消除标题条目的歧义。例如有三列的标题都是，那么输出字段是，，。
• 当值为true时返回，值为false会被跳过。
• 如果没有指定，通常和会被跳过。如果有指定值，所有的和嗲都将会用填充。
• 当为时，默认生成空白行。必须设置为来跳过空白行。
• 当不为时，默认跳过空白行。必须设置为来生成空白行。

是以下之一：

It is one of the following:

是以下之一：

It is one of the following:

如果不为，行对象将会包含不可枚举的属性，这个属性代表与条目相对应的工作表的行。

If not, the line object will contain a non-quantifiable attribute that represents the line of the sheet corresponding to the entry.

虽然库的名称是，不过它支持多种电子表格文件格式：

Although the name of the library is, it supports multiple spreadsheet file formats:

不会写入给定文件格式不支持的功能。具有范围限制的格式将会被静默截断：

Do not write functions that are not supported by the given file format. Formats with a range limit will be cut off silently:

Excel 2003 电子表格的范围限制被Excel的版本控制，并且不会写入函数强制执行。

Excel 2003 spreadsheets are limited in scope by Excel versions and are not enforced by writing functions.

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)

大多数较老的浏览器仅支持一种工作表：

Most older browsers support only one sheet:

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)

测试文件被封装在另一个仓库。

The test file is sealed at in another warehouse .

运行将会刷新子模块并获取子模块的文件。注意这个可能需要, , 以及其它可能不可用的命令。如果失败，请从仓库下载测试文件快照的最新版本。

Runs will refresh submodules and get files for submodules. Note that this may be necessary, as well as other commands that may not be available. If this fails, download the latest version of the snapshot from http://github.com/SheetJS/test_files/releases/download/20170409/test_files.zip (下载并解压到子目录)

由于开放规范承诺的不稳定性，确保代码是洁净室非常重要。贡献记录

Due to the volatility of open normative commitments, it is important to ensure that the code is a clean room.

更多细节请查阅相关的证书。原始作者保留未由Apache 2.0许可证明确授予的所有权利。

For more details, please refer to the relevant certificate.

• ISO/IEC 29500:2012(E) “信息技术 - 文档描述和处理语言 - Office开源XML文件格式”
• Office应用版本 1.2(2011/9/29)开源文档格式
• 工作表文件格式(来自于Lotus) 1984年12月

欧易(OKX)最新版本

【遇到注册下载问题请加文章最下面的客服微信】永久享受返佣20%手续费！

APP下载   全球官网 大陆官网

币安(Binance)最新版本

币安交易所app【遇到注册下载问题请加文章最下面的客服微信】永久享受返佣20%手续费！

APP下载   官网地址

火币HTX最新版本

火币老牌交易所【遇到注册下载问题请加文章最下面的客服微信】永久享受返佣20%手续费！

APP下载   官网地址