开源适用于JavaScript的Excel解析器和生成器

开发 前端
xlsx-populate是一个用JavaScript编写的Excel XLSX解析器/生成器,支持Node.js和浏览器,具备jQuery和D3.js的形式写法,加密功能以及保持现有工作簿功能和样式不变的特点!

介绍

xlsx-populate是一个用JavaScript编写的Excel XLSX解析器/生成器,支持Node.js和浏览器,具备jQuery和D3.js的形式写法,加密功能以及保持现有工作簿功能和样式不变的特点!

 

[[345304]]

 

Github

https://github.com/dtjohnson/xlsx-populate

获取xlsx-populate

 

  1. npm install xlsx-populate 

xlsx-populate使用ES6功能,因此仅支持Node.js v4 +

用法举例

xlsx-populate具有用于处理Excel工作簿的广泛API

  • 填充数据

要在工作簿中填充数据,先加载一个(空白,数据或文件)。然后,可以访问工作簿中的工作表和单元格以进行操作。

 

  1. const XlsxPopulate = require('xlsx-populate'); 
  2. // 加载新的空白工作簿 
  3. XlsxPopulate.fromBlankAsync()    .then(workbook => { 
  4.         // 修改工作簿。 
  5.         workbook.sheet("Sheet1").cell("A1").value("This is neat!"); 
  6.         // 写入文件。 
  7.         return workbook.toFileAsync("./out.xlsx"); 
  8.     }); 
  • 解析数据

 

  1. const XlsxPopulate = require('xlsx-populate'); 
  2. // 加载现有工作簿 
  3. XlsxPopulate.fromFileAsync("./Book1.xlsx"
  4.     .then(workbook => { 
  5.         // 修改工作簿。 
  6.         const value = workbook.sheet("Sheet1").cell("A1").value(); 
  7.         console.log(value);    }); 
  • 范围操作

xlsx-populate还支持单元格范围,以允许一次解析/操作多个单元格。

 

  1. const r = workbook.sheet(0).range("A1:C3"); 
  2. // 将所有单元格值设置为相同的值: 
  3. r.value(5); 
  4. // 使用2维数组设置值: 
  5. r.value([ 
  6.     [1, 2, 3], 
  7.     [4, 5, 6], 
  8.     [7, 8, 9] 
  9. ]); 
  10. // 使用回调函数设置值: 
  11. r.value((cell, ri, ci, range) => Math.random()); 

一个常见的用例是简单地一次提取所有值。可以使用Sheet.usedRange方法轻松地做到这一点。

 

  1. const values = workbook.sheet("Sheet1").usedRange().value(); 

或者,可以在一个范围内设置值,而该范围内仅需左上角的单元格:

 

  1. workbook.sheet(0).cell("A1").value([ 
  2.     [1, 2, 3], 
  3.     [4, 5, 6], 
  4.     [7, 8, 9] 
  5. ]); 
  • 行列操作

 

  1. sheet.column("B").width(25).hidden(false); 
  2. const cell = sheet.row(5).cell(3); 
  • 管理Sheet

 

  1. //按索引获取工作表 
  2. const sheet1 = workbook.sheet(0); 
  3. // 按名称获取工作表 
  4. const sheet2 = workbook.sheet("Sheet2"); 
  5. // 将所有工作表作为数组获取 
  6. const sheets = workbook.sheets(); 

可以添加新的工作表:

 

  1. const newSheet1 = workbook.addSheet('New 1'); 
  2. const newSheet2 = workbook.addSheet('New 2', 1); 
  3. const newSheet3 = workbook.addSheet('New 3''Sheet1'); 
  4. const sheet = workbook.sheet('Sheet1'); 
  5. const newSheet4 = workbook.addSheet('New 4', sheet); 

重命名

 

  1. const sheet = workbook.sheet(0).name("new sheet name"); 

移动

 

  1. workbook.moveSheet("Sheet1"); 
  2. workbook.moveSheet("Sheet1", 2); 
  3. workbook.moveSheet("Sheet1""Sheet2"); 

删除

 

  1. // 获取活动表 
  2. const sheet = workbook.activeSheet();// 检查当前工作表是否处于活动状态sheet.active() // returns true or false 
  3. // 激活工作表sheet.active(true); 
  4. // 或者从工作部激活workbook.activeSheet("Sheet2"); 

Excel支持创建引用地址,公式或常量的已定义名称。这些定义的名称可以作用于整个工作簿或仅单个工作表。 xlsx-populate支持查找引用单元格或范围的已定义名称。 (取消引用其他名称将导致错误。)如果将数据填充到已知模板中,则定义的名称特别有用。

 

  1. // 查找工作簿范围的名称,并将其值设置为5。 
  2. workbook.definedName("some name").value(5); 
  3. //查找范围为第一张表的名称,并将其值设置为“ foo”。workbook.sheet(0).definedName("some other name").value("foo"); 

 

  1. // 创建/修改工作簿范围定义的名称 
  2. workbook.definedName("some name""TRUE"); 
  3. // 删除工作表范围的定义名称: 
  4. workbook.sheet(0).definedName("some name"null); 
  • 查找和替换

可以在工作簿或工作表的单元格中搜索文本的出现,并有选择地替换它们

 

  1. // 在工作簿中查找所有出现的文本“ foo”,并替换为“ bar”。 
  2. workbook.find("foo""bar"); // 返回匹配单元格的数组 
  3. // 找到匹配项,但不要替换。workbook.find("foo"); 
  4. //只在第一张sheet。workbook.sheet(0).find("foo"); 
  5. // 检查特定单元格是否与值匹配。workbook.sheet("Sheet1").cell("A1").find("foo"); // Returns true or false 

 

  1. // 使用RegExp将所有小写字母替换为大写 
  2. workbook.find(/[a-z]+/g, match => match.toUpperCase()); 
  • 样式

xlsx-populate支持多种单元格格式

 

  1. // 获得单一风格 
  2. const bold = cell.style("bold"); // true 
  3. // 获取多种样式 
  4. const styles = cell.style(["bold""italic"]); // { bold: true, italic: true } 
  5. // 设置单一样式 
  6. cell.style("bold"true); 
  7. // 设置多种样式 
  8. cell.style({ bold: true, italic: true }); 
  • 富文本

可以在现有的RTF单元格上阅读和修改RTF:

 

  1. // 假设A1是富文本单元格 
  2. const RichText = require('xlsx-Populate').RichText; 
  3. const cell = workbook.sheet(0).cell('A1'); 
  4. cell.value() instanceof RichText // returns true 
  5. const richtext = cell.value();// 获取连接文本 
  6. richtext.text();// loop through each rich text fragment 
  7. for (let i = 0; i < richtext.length; i++) { 
  8.     const fragment = richtext.get(i);    // Get the style 
  9.     fragment.style('bold'); 
  10.     // Get many styles 
  11.     fragment.style(['bold''italic']); 
  12.     // Set one style 
  13.     fragment.style('bold'true); 
  14.     // Set many styles 
  15.     fragment.style({ 'bold'true'italic'true }); 
  16.     // Get the value 
  17.     fragment.value();    // Set the value 
  18.     fragment.value('hello'); 
  19. }// remove the first rich text fragment 
  20. richtext.remove(0); 
  21. // clear this rich texts 
  22. richtext.clear(); 

如何将单元格设置为富文本:

 

  1. const RichText = require('xlsx-Populate').RichText; 
  2. const cell = workbook.sheet(0).cell('A1'); 
  3. // 将单元格值设置为富文本 
  4. cell.value(new RichText());// 添加两个富文本片段 
  5. cell.value()    .add('hello ', { italic: true, bold: true }) 
  6.     .add('world!', { fontColor: 'FF0000' }); 
  • 浏览器

浏览器中的用法几乎相同。可以在Github代码中找到一个功能示例。该库以XlsxPopulate全局加载。可以从文件中加载现有工作簿:

 

  1. // 假设页面中有一个文件输入,标识为“ file-input” 
  2. var file = document.getElementById("file-input").files[0]; 
  3. //File对象是一种特殊的Blob。XlsxPopulate.fromDataAsync(file)    .then(function (workbook) { 
  4.         // ...    }); 

如果将responseType设置为'arraybuffer',也可以从AJAX加载:

 

  1. var req = new XMLHttpRequest(); 
  2. req.open("GET""http://..."true); 
  3. req.responseType = "arraybuffer"
  4. req.onreadystatechange = function () { 
  5.     if (req.readyState === 4 && req.status === 200){ 
  6.         XlsxPopulate.fromDataAsync(req.response)            .then(function (workbook) { 
  7.                 // ... 
  8.             }); 
  9.     } 
  10. }; 
  11. req.send(); 

要下载工作簿,可以将其导出为Blob(默认行为)或base64字符串。然后,可以将链接插入DOM并下载它:

 

  1. workbook.outputAsync() 
  2.     .then(function (blob) { 
  3.         if (window.navigator && window.navigator.msSaveOrOpenBlob) { 
  4.             // 如果是IE,则必须使用其他方法。 
  5.             window.navigator.msSaveOrOpenBlob(blob, "out.xlsx"); 
  6.         } else { 
  7.             var url = window.URL.createObjectURL(blob); 
  8.             var a = document.createElement("a"); 
  9.             document.body.appendChild(a); 
  10.             a.href = url; 
  11.             a.download = "out.xlsx"
  12.             a.click(); 
  13.             window.URL.revokeObjectURL(url); 
  14.             document.body.removeChild(a); 
  15.         } 
  16.     }); 

另外,可以通过数据URI下载,但是IE不支持此下载:

 

  1. workbook.outputAsync("base64"
  2.     .then(function (base64) { 
  3.         location.href = "data:" + XlsxPopulate.MIME_TYPE + ";base64," + base64; 
  4.     }); 
  • Promises

xlsx-populate使用Promise管理异步输入/输出。默认情况下,它使用浏览器或Node.js中定义的Promise。在不支持诺言(IE)的浏览器中,通过JSZip使用polyfill。

 

  1. var Promise = XlsxPopulate.Promise; 

可以覆盖与其他符合ES6的库(例如bluebird)一起使用的默认Promise库。

 

  1. const Promise = require("bluebird"); 
  2. const XlsxPopulate = require("xlsx-populate"); 
  3. XlsxPopulate.Promise = Promise; 
  • 加密

支持XLSX Agile加密和解密,因此可以读写受密码保护的工作簿。要阅读受保护的工作簿,请输入密码作为选项:

 

  1. XlsxPopulate.fromFileAsync("./Book1.xlsx", { password"S3cret!" }) 
  2.     .then(workbook => { 
  3.         // ... 
  4.     }); 

同样,写加密的工作簿:

 

  1. workbook.toFileAsync("./out.xlsx", { password"S3cret!" }); 

………

总结

xlsx-populate的功能绝不仅仅是以上介绍的内容,由于篇幅有限,更多的功能可以参考Github,具备详细的功能代码片段和API说明文档,enjoy it!

责任编辑:华轩 来源: 今日头条
相关推荐

2023-03-01 00:07:32

JavaScript迭代器生成器

2018-06-13 09:00:00

2022-02-15 10:30:58

UUID

2011-12-23 13:42:05

JavaScript

2023-08-09 13:46:39

2022-03-21 09:25:50

Kubernetes开源DevSecOps

2021-12-13 12:56:26

Linux浏览器

2022-02-21 20:56:12

Linux开源网页浏览器

2018-07-30 13:36:13

MacO开源应用程序

2021-07-23 11:24:54

Create Inc开源G代码生成器

2009-11-29 17:10:01

NetgearLinux系统路由器

2023-03-08 12:35:59

综合布线

2023-07-21 17:08:30

2018-11-12 11:50:10

开源发票工具Web

2018-01-09 11:09:42

RESTSOAP开源

2015-04-22 09:36:27

JAVA代码生成器

2021-01-19 13:30:52

Linux播放器互联网

2020-05-14 17:54:54

查看器 Linux 系统

2011-08-01 16:10:11

XCode Excel 数据库

2023-11-15 13:35:00

迭代器生成器Python
点赞
收藏

51CTO技术栈公众号