開源適用于JavaScript的Excel解析器和生成器
介紹
xlsx-populate是一個用JavaScript編寫的Excel XLSX解析器/生成器,支持Node.js和瀏覽器,具備jQuery和D3.js的形式寫法,加密功能以及保持現(xiàn)有工作簿功能和樣式不變的特點!
Github
https://github.com/dtjohnson/xlsx-populate
獲取xlsx-populate
- npm install xlsx-populate
xlsx-populate使用ES6功能,因此僅支持Node.js v4 +
用法舉例
xlsx-populate具有用于處理Excel工作簿的廣泛API
- 填充數(shù)據(jù)
要在工作簿中填充數(shù)據(jù),先加載一個(空白,數(shù)據(jù)或文件)。然后,可以訪問工作簿中的工作表和單元格以進行操作。
- const XlsxPopulate = require('xlsx-populate');
- // 加載新的空白工作簿
- XlsxPopulate.fromBlankAsync() .then(workbook => {
- // 修改工作簿。
- workbook.sheet("Sheet1").cell("A1").value("This is neat!");
- // 寫入文件。
- return workbook.toFileAsync("./out.xlsx");
- });
- 解析數(shù)據(jù)
- const XlsxPopulate = require('xlsx-populate');
- // 加載現(xiàn)有工作簿
- XlsxPopulate.fromFileAsync("./Book1.xlsx")
- .then(workbook => {
- // 修改工作簿。
- const value = workbook.sheet("Sheet1").cell("A1").value();
- console.log(value); });
- 范圍操作
xlsx-populate還支持單元格范圍,以允許一次解析/操作多個單元格。
- const r = workbook.sheet(0).range("A1:C3");
- // 將所有單元格值設(shè)置為相同的值:
- r.value(5);
- // 使用2維數(shù)組設(shè)置值:
- r.value([
- [1, 2, 3],
- [4, 5, 6],
- [7, 8, 9]
- ]);
- // 使用回調(diào)函數(shù)設(shè)置值:
- r.value((cell, ri, ci, range) => Math.random());
一個常見的用例是簡單地一次提取所有值??梢允褂肧heet.usedRange方法輕松地做到這一點。
- const values = workbook.sheet("Sheet1").usedRange().value();
或者,可以在一個范圍內(nèi)設(shè)置值,而該范圍內(nèi)僅需左上角的單元格:
- workbook.sheet(0).cell("A1").value([
- [1, 2, 3],
- [4, 5, 6],
- [7, 8, 9]
- ]);
- 行列操作
- sheet.column("B").width(25).hidden(false);
- const cell = sheet.row(5).cell(3);
- 管理Sheet
- //按索引獲取工作表
- const sheet1 = workbook.sheet(0);
- // 按名稱獲取工作表
- const sheet2 = workbook.sheet("Sheet2");
- // 將所有工作表作為數(shù)組獲取
- const sheets = workbook.sheets();
可以添加新的工作表:
- const newSheet1 = workbook.addSheet('New 1');
- const newSheet2 = workbook.addSheet('New 2', 1);
- const newSheet3 = workbook.addSheet('New 3', 'Sheet1');
- const sheet = workbook.sheet('Sheet1');
- const newSheet4 = workbook.addSheet('New 4', sheet);
重命名
- const sheet = workbook.sheet(0).name("new sheet name");
移動
- workbook.moveSheet("Sheet1");
- workbook.moveSheet("Sheet1", 2);
- workbook.moveSheet("Sheet1", "Sheet2");
刪除
- // 獲取活動表
- const sheet = workbook.activeSheet();// 檢查當(dāng)前工作表是否處于活動狀態(tài)sheet.active() // returns true or false
- // 激活工作表sheet.active(true);
- // 或者從工作部激活workbook.activeSheet("Sheet2");
Excel支持創(chuàng)建引用地址,公式或常量的已定義名稱。這些定義的名稱可以作用于整個工作簿或僅單個工作表。 xlsx-populate支持查找引用單元格或范圍的已定義名稱。 (取消引用其他名稱將導(dǎo)致錯誤。)如果將數(shù)據(jù)填充到已知模板中,則定義的名稱特別有用。
- // 查找工作簿范圍的名稱,并將其值設(shè)置為5。
- workbook.definedName("some name").value(5);
- //查找范圍為第一張表的名稱,并將其值設(shè)置為“ foo”。workbook.sheet(0).definedName("some other name").value("foo");
- // 創(chuàng)建/修改工作簿范圍定義的名稱
- workbook.definedName("some name", "TRUE");
- // 刪除工作表范圍的定義名稱:
- workbook.sheet(0).definedName("some name", null);
- 查找和替換
可以在工作簿或工作表的單元格中搜索文本的出現(xiàn),并有選擇地替換它們
- // 在工作簿中查找所有出現(xiàn)的文本“ foo”,并替換為“ bar”。
- workbook.find("foo", "bar"); // 返回匹配單元格的數(shù)組
- // 找到匹配項,但不要替換。workbook.find("foo");
- //只在第一張sheet。workbook.sheet(0).find("foo");
- // 檢查特定單元格是否與值匹配。workbook.sheet("Sheet1").cell("A1").find("foo"); // Returns true or false
- // 使用RegExp將所有小寫字母替換為大寫
- workbook.find(/[a-z]+/g, match => match.toUpperCase());
- 樣式
xlsx-populate支持多種單元格格式
- // 獲得單一風(fēng)格
- const bold = cell.style("bold"); // true
- // 獲取多種樣式
- const styles = cell.style(["bold", "italic"]); // { bold: true, italic: true }
- // 設(shè)置單一樣式
- cell.style("bold", true);
- // 設(shè)置多種樣式
- cell.style({ bold: true, italic: true });
- 富文本
可以在現(xiàn)有的RTF單元格上閱讀和修改RTF:
- // 假設(shè)A1是富文本單元格
- const RichText = require('xlsx-Populate').RichText;
- const cell = workbook.sheet(0).cell('A1');
- cell.value() instanceof RichText // returns true
- const richtext = cell.value();// 獲取連接文本
- richtext.text();// loop through each rich text fragment
- for (let i = 0; i < richtext.length; i++) {
- const fragment = richtext.get(i); // Get the style
- fragment.style('bold');
- // Get many styles
- fragment.style(['bold', 'italic']);
- // Set one style
- fragment.style('bold', true);
- // Set many styles
- fragment.style({ 'bold': true, 'italic': true });
- // Get the value
- fragment.value(); // Set the value
- fragment.value('hello');
- }// remove the first rich text fragment
- richtext.remove(0);
- // clear this rich texts
- richtext.clear();
如何將單元格設(shè)置為富文本:
- const RichText = require('xlsx-Populate').RichText;
- const cell = workbook.sheet(0).cell('A1');
- // 將單元格值設(shè)置為富文本
- cell.value(new RichText());// 添加兩個富文本片段
- cell.value() .add('hello ', { italic: true, bold: true })
- .add('world!', { fontColor: 'FF0000' });
- 瀏覽器
瀏覽器中的用法幾乎相同??梢栽贕ithub代碼中找到一個功能示例。該庫以XlsxPopulate全局加載。可以從文件中加載現(xiàn)有工作簿:
- // 假設(shè)頁面中有一個文件輸入,標識為“ file-input”
- var file = document.getElementById("file-input").files[0];
- //File對象是一種特殊的Blob。XlsxPopulate.fromDataAsync(file) .then(function (workbook) {
- // ... });
如果將responseType設(shè)置為'arraybuffer',也可以從AJAX加載:
- var req = new XMLHttpRequest();
- req.open("GET", "http://...", true);
- req.responseType = "arraybuffer";
- req.onreadystatechange = function () {
- if (req.readyState === 4 && req.status === 200){
- XlsxPopulate.fromDataAsync(req.response) .then(function (workbook) {
- // ...
- });
- }
- };
- req.send();
要下載工作簿,可以將其導(dǎo)出為Blob(默認行為)或base64字符串。然后,可以將鏈接插入DOM并下載它:
- workbook.outputAsync()
- .then(function (blob) {
- if (window.navigator && window.navigator.msSaveOrOpenBlob) {
- // 如果是IE,則必須使用其他方法。
- window.navigator.msSaveOrOpenBlob(blob, "out.xlsx");
- } else {
- var url = window.URL.createObjectURL(blob);
- var a = document.createElement("a");
- document.body.appendChild(a);
- a.href = url;
- a.download = "out.xlsx";
- a.click();
- window.URL.revokeObjectURL(url);
- document.body.removeChild(a);
- }
- });
另外,可以通過數(shù)據(jù)URI下載,但是IE不支持此下載:
- workbook.outputAsync("base64")
- .then(function (base64) {
- location.href = "data:" + XlsxPopulate.MIME_TYPE + ";base64," + base64;
- });
- Promises
xlsx-populate使用Promise管理異步輸入/輸出。默認情況下,它使用瀏覽器或Node.js中定義的Promise。在不支持諾言(IE)的瀏覽器中,通過JSZip使用polyfill。
- var Promise = XlsxPopulate.Promise;
可以覆蓋與其他符合ES6的庫(例如bluebird)一起使用的默認Promise庫。
- const Promise = require("bluebird");
- const XlsxPopulate = require("xlsx-populate");
- XlsxPopulate.Promise = Promise;
- 加密
支持XLSX Agile加密和解密,因此可以讀寫受密碼保護的工作簿。要閱讀受保護的工作簿,請輸入密碼作為選項:
- XlsxPopulate.fromFileAsync("./Book1.xlsx", { password: "S3cret!" })
- .then(workbook => {
- // ...
- });
同樣,寫加密的工作簿:
- workbook.toFileAsync("./out.xlsx", { password: "S3cret!" });
………
總結(jié)
xlsx-populate的功能絕不僅僅是以上介紹的內(nèi)容,由于篇幅有限,更多的功能可以參考Github,具備詳細的功能代碼片段和API說明文檔,enjoy it!