xuri/excelize-wasmPublic

NotificationsYou must be signed in to change notification settings
Fork43
Star311

A WebAssembly build of the Go Excelize library for reading and writing Microsoft Excel™ (XLAM / XLSM / XLSX / XLTM / XLTX) spreadsheets

License

BSD-3-Clause license

311 stars 43 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 97 Commits
.github		.github
cmd		cmd
src		src
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
README_zh.md		README_zh.md
chart.png		chart.png
excelize-wasm.svg		excelize-wasm.svg
package-lock.json		package-lock.json
package.json		package.json
rollup.config.js		rollup.config.js

Repository files navigation

excelize-wasm

Excelize-wasm is a pure WebAssembly / Javascript port of GoExcelize library that allow you to write to and read from XLAM / XLSM / XLSX / XLTM / XLTX files. Supports reading and writing spreadsheet documents generated by Microsoft Excel™ 2007 and later. Supports complex components by high compatibility. The full API docs can be found atdocs reference.

Environment Compatibility

Browser	Version
Chrome	≥57
Chrome for Android and Android Browser	≥105
Edge	≥16
Safari on macOS and iOS	≥11
Firefox	≥52
Firefox for Android	≥104
Opera	≥44
Opera Mobile	≥64
Samsung Internet	≥7.2
UC Browser for Android	≥13.4
QQ Browser	≥10.4
Node.js	≥12.0.0
Deno	≥1.0

Basic Usage

Installation

Node.js

npm install --save excelize-wasm

Browser

<scriptsrc="excelize-wasm/index.js"></script>

Create spreadsheet

Here is a minimal example usage that will create spreadsheet file.

const{ init}=require('excelize-wasm');constfs=require('fs');init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize)=>{constf=excelize.NewFile();if(f.error){console.log(f.error);return;}// Create a new sheet.const{ index}=f.NewSheet('Sheet2');// Set value of a cell.f.SetCellValue('Sheet2','A2','Hello world.');f.SetCellValue('Sheet1','B2',100);// Set active sheet of the workbook.f.SetActiveSheet(index);// Save spreadsheet by the given path.const{ buffer, error}=f.WriteToBuffer();if(error){console.log(error);return;}fs.writeFile('Book1.xlsx',buffer,'binary',(error)=>{if(error){console.log(error);}});});

Create spreadsheet in browser:

View code

<html><head><metacharset="utf-8"><scriptsrc="https://<your_hostname>/excelize-wasm/index.js"></script></head><body><div><buttononclick="download()">Download</button></div><script>functiondownload(){excelizeWASM.init('https://<your_hostname>/excelize-wasm/excelize.wasm.gz').then((excelize)=>{constf=excelize.NewFile();if(f.error){console.log(f.error);return;}// Create a new sheet.const{ index}=f.NewSheet('Sheet2');// Set value of a cell.f.SetCellValue('Sheet2','A2','Hello world.');f.SetCellValue('Sheet1','B2',100);// Set active sheet of the workbook.f.SetActiveSheet(index);// Save spreadsheet by the given path.const{ buffer, error}=f.WriteToBuffer();if(error){console.log(error);return;}constlink=document.createElement('a');link.download='Book1.xlsx';link.href=URL.createObjectURL(newBlob([buffer],{type:'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',}));link.click();});}</script></body>

Reading spreadsheet

The following constitutes the bare to read a spreadsheet document.

const{ init}=require('excelize-wasm');constfs=require('fs');init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize)=>{constf=excelize.OpenReader(fs.readFileSync('Book1.xlsx'));if(f.error){console.log(f.error);return;}// Set value of a cell.constret1=f.GetCellValue('Sheet1','B2');if(ret1.error){console.log(ret1.error);return;}console.log(ret1.value);// Get all the rows in the Sheet1.constret2=f.GetRows('Sheet1');if(ret2.error){console.log(ret2.error);return;}ret2.result.forEach((row)=>{row.forEach((colCell)=>{process.stdout.write(`${colCell}\t`);});console.log();});});

Add chart to spreadsheet file

With excelize-wasm chart generation and management is as easy as a few lines of code. You can build charts based on data in your worksheet or generate charts without any data in your worksheet at all.

const{ init}=require('excelize-wasm');constfs=require('fs');init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize)=>{constf=excelize.NewFile();if(f.error){console.log(f.error);return;}[[null,'Apple','Orange','Pear'],['Small',2,3,3],['Normal',5,2,4],['Large',6,7,8],].forEach((row,idx)=>{constret1=excelize.CoordinatesToCellName(1,idx+1);if(ret1.error){console.log(ret1.error);return;}constres2=f.SetSheetRow('Sheet1',ret1.cell,row);if(res2.error){console.log(res2.error);return;}});constret3=f.AddChart('Sheet1','E1',{Type:excelize.Col3DClustered,Series:[{Name:'Sheet1!$A$2',Categories:'Sheet1!$B$1:$D$1',Values:'Sheet1!$B$2:$D$2',},{Name:'Sheet1!$A$3',Categories:'Sheet1!$B$1:$D$1',Values:'Sheet1!$B$3:$D$3',},{Name:'Sheet1!$A$4',Categories:'Sheet1!$B$1:$D$1',Values:'Sheet1!$B$4:$D$4',},],Title:[{Text:'Fruit 3D Clustered Column Chart',}],});if(ret3.error){console.log(ret3.error);return;}// Save spreadsheet by the given path.const{ buffer, error}=f.WriteToBuffer();if(error){console.log(error);return;}fs.writeFile('Book1.xlsx',buffer,'binary',(error)=>{if(error){console.log(error);}});});

Add picture to spreadsheet file

const{ init}=require('excelize-wasm');constfs=require('fs');init('./node_modules/excelize-wasm/excelize.wasm.gz').then((excelize)=>{constf=excelize.OpenReader(fs.readFileSync('Book1.xlsx'));if(f.error){console.log(f.error);return;}// Insert a picture.constret1=f.AddPictureFromBytes('Sheet1','A2',{Extension:'.png',File:fs.readFileSync('image.png'),Format:{AltText:'Picture 1'},});if(ret1.error){console.log(ret1.error);return;}// Insert a picture to worksheet with scaling.constret2=f.AddPictureFromBytes('Sheet1','D2',{Extension:'.jpg',File:fs.readFileSync('image.jpg'),Format:{AltText:'Picture 2',ScaleX:0.5,ScaleY:0.5},});if(ret2.error){console.log(ret2.error);return;}// Insert a picture offset in the cell with printing support.constret3=f.AddPictureFromBytes('Sheet1','H2',{Extension:'.gif',File:fs.readFileSync('image.gif'),Format:{AltText:'Picture 3',OffsetX:15,OffsetY:10,PrintObject:true,LockAspectRatio:false,Locked:false,},});if(ret3.error){console.log(ret3.error);return;}// Save spreadsheet by the given path.const{ buffer, error}=f.WriteToBuffer();if(error){console.log(error);return;}fs.writeFile('Book1.xlsx',buffer,'binary',(error)=>{if(error){console.log(error);}});});