npmpackage.info

exceljs

Excel Workbook Manager

4.4.0

14,046

MIT

JavaScript

251.09 kB

183,448,764 5

Installations

npm install exceljs

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Min. Node Version

>=8.3.0

Node Version

15.8.0

NPM Version

7.5.1 Score

Supply Chain

Quality

77.1

Maintenance

100

Vulnerability

94.4

License

Pull Requests

Open

113

Total

549

Closed

82

Merged

354

Issues

Open

577

Total

1,832

Closed

1,255

Releases

v4.4.0

Published on 19 Oct 2023

View all 1 releases

Contributors

187

View all 187 contributors

Languages

JavaScript

HTML

TypeScript

JavaScript (99.66%)

HTML (0.23%)

TypeScript (0.1%)

Developer

exceljs

Download Statistics

Total Downloads

183,448,764

Last Day

341,604

Last Week

1,504,153

Last Month

6,961,656

Last Year

76,903,274

GitHub Statistics

14,046 Stars

1,775 Commits

1,796 Forks

180 Watching

14 Branches

187 Contributors

Bundle Size

920.79 kB

Minified

251.09 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.4.0

Package Id

exceljs@4.4.0

Unpacked Size

20.81 MB

Size

4.50 MB

File Count

519

NPM Version

7.5.1

Node Version

15.8.0

Publised On

19 Oct 2023

Total Downloads

Cumulative downloads

Total Downloads

183,448,764

Last day

-9.3%

341,604

Compared to previous day

Last week

-18.7%

1,504,153

Compared to previous week

Last month

2.7%

6,961,656

Compared to previous month

Last year

67.3%

76,903,274

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

ExcelJS

Read, manipulate and write spreadsheet data and styles to XLSX and JSON.

Reverse engineered from Excel spreadsheet files as a project.

Translations

中文文档

Installation

1npm install exceljs

New Features!

Merged fix: styles rendering in case when "numFmt" is present in conditional formatting rules (resolves #1814) #1815.
Many thanks to @andreykrupskii for this contribution!
Merged inlineStr cell type support #1575 #1576.
Many thanks to @drdmitry for this contribution!
Merged Fix parsing of boolean attributes #1849.
Many thanks to @bno1 for this contribution!
Merged add optional custom auto-filter to table #1670.
Many thanks to @thambley for this contribution!
Merged Deep copy inherited style #1850.
Many thanks to @ikzhr for this contribution!
Merged Upgrade actions/cache and actions/setup-node #1846.
Many thanks to @cclauss for this contribution!
Merged Check object keys in isEqual #1831.
Many thanks to @bno1 for this contribution!
Merged Add v17 to testing workflow #1856.
Many thanks to @Siemienik for this contribution!
Merged Upgrade jszip to its latest version to date. This version does not have any vulnerability found by Snyk so far #1895.
Many thanks to @ValerioSevilla for this contribution!
Merged Update README.md #1677.
Many thanks to @xjrcode for this contribution!
Merged (docs): set prototype of RegExp correctly. #1700.
Many thanks to @joeldenning for this contribution!
Merged Added timeouts to github actions #1733.
Many thanks to @alexbjorlig for this contribution!
Merged fix issue 1676 #1701.
Many thanks to @skypesky for this contribution!
Merged ExcelJS/ExcelJS#2237 : Update CI Tests, Drop support for Node v8 #2242.
Many thanks to @Siemienik for this contribution!
Merged Fix types for getWorksheet() #2223.
Many thanks to @hfhchan-plb for this contribution!
Merged add characters cannot be used for worksheet name #2126.
Many thanks to @tkm-kj for this contribution!
Merged Fix issue #1753 Reject promise when workbook reader is writing to temporary file stream and error occurs #1756.
Many thanks to @pauliusg for this contribution!
Merged README.md to have correct link for Streaming XLSX #2186.
Many thanks to @wulfsolter for this contribution!
Merged Added a polyfill of promise.finally to support lower versions of Firefox. #1982.
Many thanks to @DemoJj for this contribution!
Merged Fix read this.worksheet before assign it #1934.
Many thanks to @ZyqGitHub1 for this contribution!
Merged chore: upgrade jszip to ^3.10.1 #2211.
Many thanks to @jarrod-cocoon for this contribution!
Merged fixed spelling error in README.md file #2208.
Many thanks to @HugoP27 for this contribution!
Merged fix: Fix xlsx.writeFile() not catching error when error occurs #2244.
Many thanks to @zurmokeeper for this contribution!
Merged Improve worksheets' naming validation logic. #2257.
Many thanks to @Siemienik for this contribution!
Merged fix issue 2125 - spliceRows remove last row #2140.
Many thanks to @babu-ch for this contribution!
Merged fix: fix the loss of column attributes due to incorrect column order #2222.
Many thanks to @cpaiyueyue for this contribution!
Merged Fix: Sheet Properties Types #2327.
Many thanks to @albeniraouf for this contribution!
Merged Use node 18 LTS for tsc, and benchmark. Add node 20. to test matrix. … #2354.
Many thanks to @Siemienik for this contribution!
Merged Add missing tooltip attribute to CellHyperlinkValue index.d.ts #2350.
Many thanks to @NiklasPor for this contribution!
Merged Increase resilience to generating large workbooks #2320.
Many thanks to @hfhchan-plb for this contribution!
Merged repair all 'c2fo.io' links ('c2fo.github.io') #2324.
Many thanks to @justintunev7 for this contribution!
Merged fix: fix type definitions about last column, formula values and protection #2309.
Many thanks to @gltjk for this contribution!
Merged fix: add spinCount field for WorksheetProtection type #2284.
Many thanks to @damingerdai for this contribution!
Merged Add type definition for WorksheetModel.merges #2281.
Many thanks to @ytjmt for this contribution!

Contributions

Contributions are very welcome! It helps me know what features are desired or what bugs are causing the most pain.

I have just one request; If you submit a pull request for a bugfix, please add a unit-test or integration-test (in the spec folder) that catches the problem. Even a PR that just has a failing test is fine - I can analyse what the test is doing and fix the code from that.

Note: Please try to avoid modifying the package version in a PR. Versions are updated on release and any change will most likely result in merge collisions.

To be clear, all contributions added to this library will be included in the library's MIT licence.

Importing⬆

1const ExcelJS = require('exceljs');

ES5 Imports⬆

To use the ES5 transpiled code, for example for node.js versions older than 10, use the dist/es5 path.

1const ExcelJS = require('exceljs/dist/es5');

Note: The ES5 build has an implicit dependency on a number of polyfills which are no longer explicitly added by exceljs. You will need to add "core-js" and "regenerator-runtime" to your dependencies and include the following requires in your code before the exceljs import:

1// polyfills required by exceljs
2require('core-js/modules/es.promise');
3require('core-js/modules/es.string.includes');
4require('core-js/modules/es.object.assign');
5require('core-js/modules/es.object.keys');
6require('core-js/modules/es.symbol');
7require('core-js/modules/es.symbol.async-iterator');
8require('regenerator-runtime/runtime');
9
10const ExcelJS = require('exceljs/dist/es5');

For IE 11, you'll also need a polyfill to support unicode regex patterns. For example,

1const rewritePattern = require('regexpu-core');
2const {generateRegexpuOptions} = require('@babel/helper-create-regexp-features-plugin/lib/util');
3
4const {RegExp} = global;
5try {
6  new RegExp('a', 'u');
7} catch (err) {
8  global.RegExp = function(pattern, flags) {
9    if (flags && flags.includes('u')) {
10      return new RegExp(rewritePattern(pattern, flags, generateRegexpuOptions({flags, pattern})));
11    }
12    return new RegExp(pattern, flags);
13  };
14  global.RegExp.prototype = RegExp.prototype;
15}

Browserify⬆

ExcelJS publishes two browserified bundles inside the dist/ folder:

One with implicit dependencies on core-js polyfills...

1<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
2<script src="exceljs.js"></script>

And one without...

1<script src="--your-project's-pollyfills-here--"></script>
2<script src="exceljs.bare.js"></script>

Interface⬆

Create a Workbook⬆

1const workbook = new ExcelJS.Workbook();

Set Workbook Properties⬆

1workbook.creator = 'Me';
2workbook.lastModifiedBy = 'Her';
3workbook.created = new Date(1985, 8, 30);
4workbook.modified = new Date();
5workbook.lastPrinted = new Date(2016, 9, 27);

1// Set workbook dates to 1904 date system
2workbook.properties.date1904 = true;

Set Calculation Properties⬆

1// Force workbook calculation on load
2workbook.calcProperties.fullCalcOnLoad = true;

Workbook Views⬆

The Workbook views controls how many separate windows Excel will open when viewing the workbook.

1workbook.views = [
2  {
3    x: 0, y: 0, width: 10000, height: 20000,
4    firstSheet: 0, activeTab: 1, visibility: 'visible'
5  }
6]

Add a Worksheet⬆

1const sheet = workbook.addWorksheet('My Sheet');

Use the second parameter of the addWorksheet function to specify options for the worksheet.

For Example:

1// create a sheet with red tab colour
2const sheet = workbook.addWorksheet('My Sheet', {properties:{tabColor:{argb:'FFC0000'}}});
3
4// create a sheet where the grid lines are hidden
5const sheet = workbook.addWorksheet('My Sheet', {views: [{showGridLines: false}]});
6
7// create a sheet with the first row and column frozen
8const sheet = workbook.addWorksheet('My Sheet', {views:[{state: 'frozen', xSplit: 1, ySplit:1}]});
9
10// Create worksheets with headers and footers
11const sheet = workbook.addWorksheet('My Sheet', {
12  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
13});
14
15// create new sheet with pageSetup settings for A4 - landscape
16const worksheet =  workbook.addWorksheet('My Sheet', {
17  pageSetup:{paperSize: 9, orientation:'landscape'}
18});

Remove a Worksheet⬆

Use the worksheet id to remove the sheet from workbook.

For Example:

1// Create a worksheet
2const sheet = workbook.addWorksheet('My Sheet');
3
4// Remove the worksheet using worksheet id
5workbook.removeWorksheet(sheet.id)

Access Worksheets⬆

1// Iterate over all sheets
2// Note: workbook.worksheets.forEach will still work but this is better
3workbook.eachSheet(function(worksheet, sheetId) {
4  // ...
5});
6
7// fetch sheet by name
8const worksheet = workbook.getWorksheet('My Sheet');
9
10// fetch sheet by id
11// INFO: Be careful when using it!
12// It tries to access to `worksheet.id` field. Sometimes (really very often) workbook has worksheets with id not starting from 1.
13// For instance It happens when any worksheet has been deleted.
14// It's much more safety when you assume that ids are random. And stop to use this function.
15// If you need to access all worksheets in a loop please look to the next example.
16const worksheet = workbook.getWorksheet(1);
17
18// access by `worksheets` array:
19workbook.worksheets[0]; //the first one;
20

It's important to know that workbook.getWorksheet(1) != Workbook.worksheets[0] and workbook.getWorksheet(1) != Workbook.worksheets[1], because workbook.worksheets[0].id may have any value.

Worksheet State⬆

1// make worksheet visible
2worksheet.state = 'visible';
3
4// make worksheet hidden
5worksheet.state = 'hidden';
6
7// make worksheet hidden from 'hide/unhide' dialog
8worksheet.state = 'veryHidden';

Worksheet Properties⬆

Worksheets support a property bucket to allow control over some features of the worksheet.

1// create new sheet with properties
2const worksheet = workbook.addWorksheet('sheet', {properties:{tabColor:{argb:'FF00FF00'}}});
3
4// create a new sheet writer with properties
5const worksheetWriter = workbookWriter.addWorksheet('sheet', {properties:{outlineLevelCol:1}});
6
7// adjust properties afterwards (not supported by worksheet-writer)
8worksheet.properties.outlineLevelCol = 2;
9worksheet.properties.defaultRowHeight = 15;

Supported Properties

Name	Default	Description
tabColor	undefined	Color of the tabs
outlineLevelCol	0	The worksheet column outline level
outlineLevelRow	0	The worksheet row outline level
defaultRowHeight	15	Default row height
defaultColWidth	(optional)	Default column width
dyDescent	55	TBD

Worksheet Metrics⬆

Some new metrics have been added to Worksheet...

Name	Description
rowCount	The total row size of the document. Equal to the row number of the last row that has values.
actualRowCount	A count of the number of rows that have values. If a mid-document row is empty, it will not be included in the count.
columnCount	The total column size of the document. Equal to the maximum cell count from all of the rows
actualColumnCount	A count of the number of columns that have values.

Page Setup⬆

All properties that can affect the printing of a sheet are held in a pageSetup object on the sheet.

1// create new sheet with pageSetup settings for A4 - landscape
2const worksheet =  workbook.addWorksheet('sheet', {
3  pageSetup:{paperSize: 9, orientation:'landscape'}
4});
5
6// create a new sheet writer with pageSetup settings for fit-to-page
7const worksheetWriter = workbookWriter.addWorksheet('sheet', {
8  pageSetup:{fitToPage: true, fitToHeight: 5, fitToWidth: 7}
9});
10
11// adjust pageSetup settings afterwards
12worksheet.pageSetup.margins = {
13  left: 0.7, right: 0.7,
14  top: 0.75, bottom: 0.75,
15  header: 0.3, footer: 0.3
16};
17
18// Set Print Area for a sheet
19worksheet.pageSetup.printArea = 'A1:G20';
20
21// Set multiple Print Areas by separating print areas with '&&'
22worksheet.pageSetup.printArea = 'A1:G10&&A11:G20';
23
24// Repeat specific rows on every printed page
25worksheet.pageSetup.printTitlesRow = '1:3';
26
27// Repeat specific columns on every printed page
28worksheet.pageSetup.printTitlesColumn = 'A:C';

Supported pageSetup settings

Name	Default	Description
margins		Whitespace on the borders of the page. Units are inches.
orientation	'portrait'	Orientation of the page - i.e. taller (portrait) or wider (landscape)
horizontalDpi	4294967295	Horizontal Dots per Inch. Default value is -1
verticalDpi	4294967295	Vertical Dots per Inch. Default value is -1
fitToPage		Whether to use fitToWidth and fitToHeight or scale settings. Default is based on presence of these settings in the pageSetup object - if both are present, scale wins (i.e. default will be false)
pageOrder	'downThenOver'	Which order to print the pages - one of ['downThenOver', 'overThenDown']
blackAndWhite	false	Print without colour
draft	false	Print with less quality (and ink)
cellComments	'None'	Where to place comments - one of ['atEnd', 'asDisplayed', 'None']
errors	'displayed'	Where to show errors - one of ['dash', 'blank', 'NA', 'displayed']
scale	100	Percentage value to increase or reduce the size of the print. Active when fitToPage is false
fitToWidth	1	How many pages wide the sheet should print on to. Active when fitToPage is true
fitToHeight	1	How many pages high the sheet should print on to. Active when fitToPage is true
paperSize		What paper size to use (see below)
showRowColHeaders	false	Whether to show the row numbers and column letters
showGridLines	false	Whether to show grid lines
firstPageNumber		Which number to use for the first page
horizontalCentered	false	Whether to center the sheet data horizontally
verticalCentered	false	Whether to center the sheet data vertically

Example Paper Sizes

Name	Value
Letter	undefined
Legal	5
Executive	7
A3	8
A4	9
A5	11
B5 (JIS)	13
Envelope #10	20
Envelope DL	27
Envelope C5	28
Envelope B5	34
Envelope Monarch	37
Double Japan Postcard Rotated	82
16K 197x273 mm	119

Headers and Footers⬆

Here's how to add headers and footers. The added content is mainly text, such as time, introduction, file information, etc., and you can set the style of the text. In addition, you can set different texts for the first page and even page.

Note: Images are not currently supported.

1
2// Create worksheets with headers and footers
3var sheet = workbook.addWorksheet('sheet', {
4  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
5});
6// Create worksheets with headers and footers
7var worksheetWriter = workbookWriter.addWorksheet('sheet', {
8  headerFooter:{firstHeader: "Hello Exceljs", firstFooter: "Hello World"}
9});
10// Set footer (default centered), result: "Page 2 of 16"
11worksheet.headerFooter.oddFooter = "Page &P of &N";
12
13// Set the footer (default centered) to bold, resulting in: "Page 2 of 16"
14worksheet.headerFooter.oddFooter = "Page &P of &N";
15
16// Set the left footer to 18px and italicize. Result: "Page 2 of 16"
17worksheet.headerFooter.oddFooter = "&LPage &P of &N";
18
19// Set the middle header to gray Aril, the result: "52 exceljs"
20worksheet.headerFooter.oddHeader = "&C&KCCCCCC&\"Aril\"52 exceljs";
21
22// Set the left, center, and right text of the footer. Result: “Exceljs” in the footer left. “demo.xlsx” in the footer center. “Page 2” in the footer right
23worksheet.headerFooter.oddFooter = "&Lexceljs&C&F&RPage &P";
24
25// Add different header & footer for the first page
26worksheet.headerFooter.differentFirst = true;
27worksheet.headerFooter.firstHeader = "Hello Exceljs";
28worksheet.headerFooter.firstFooter = "Hello World"

Supported headerFooter settings

Name	Default	Description
differentFirst	false	Set the value of differentFirst as true, which indicates that headers/footers for first page are different from the other pages
differentOddEven	false	Set the value of differentOddEven as true, which indicates that headers/footers for odd and even pages are different
oddHeader	null	Set header string for odd(default) pages, could format the string
oddFooter	null	Set footer string for odd(default) pages, could format the string
evenHeader	null	Set header string for even pages, could format the string
evenFooter	null	Set footer string for even pages, could format the string
firstHeader	null	Set header string for the first page, could format the string
firstFooter	null	Set footer string for the first page, could format the string

Script Commands

Commands	Description
&L	Set position to the left
&C	Set position to the center
&R	Set position to the right
&P	The current page number
&N	The total number of pages
&D	The current date
&T	The current time
&G	A picture
&A	The worksheet name
&F	The file name
&B	Make text bold
&I	Italicize text
&U	Underline text
&"font name"	font name, for example &"Aril"
&font size	font size, for example 12
&KHEXCode	font color, for example &KCCCCCC

Worksheet Views⬆

Worksheets now support a list of views, that control how Excel presents the sheet:

frozen - where a number of rows and columns to the top and left are frozen in place. Only the bottom right section will scroll
split - where the view is split into 4 sections, each semi-independently scrollable.

Each view also supports various properties:

Name	Default	Description
state	'normal'	Controls the view state - one of normal, frozen or split
rightToLeft	false	Sets the worksheet view's orientation to right-to-left
activeCell	undefined	The currently selected cell
showRuler	true	Shows or hides the ruler in Page Layout
showRowColHeaders	true	Shows or hides the row and column headers (e.g. A1, B1 at the top and 1,2,3 on the left
showGridLines	true	Shows or hides the gridlines (shown for cells where borders have not been defined)
zoomScale	100	Percentage zoom to use for the view
zoomScaleNormal	100	Normal zoom for the view
style	undefined	Presentation style - one of pageBreakPreview or pageLayout. Note pageLayout is not compatible with frozen views

Frozen Views⬆

Frozen views support the following extra properties:

Name	Default	Description
xSplit	0	How many columns to freeze. To freeze rows only, set this to 0 or undefined
ySplit	0	How many rows to freeze. To freeze columns only, set this to 0 or undefined
topLeftCell	special	Which cell will be top-left in the bottom-right pane. Note: cannot be a frozen cell. Defaults to first unfrozen cell

1worksheet.views = [
2  {state: 'frozen', xSplit: 2, ySplit: 3, topLeftCell: 'G10', activeCell: 'A1'}
3];

Split Views⬆

Split views support the following extra properties:

Name	Default	Description
xSplit	0	How many points from the left to place the splitter. To split vertically, set this to 0 or undefined
ySplit	0	How many points from the top to place the splitter. To split horizontally, set this to 0 or undefined
topLeftCell	undefined	Which cell will be top-left in the bottom-right pane.
activePane	undefined	Which pane will be active - one of topLeft, topRight, bottomLeft and bottomRight

1worksheet.views = [
2  {state: 'split', xSplit: 2000, ySplit: 3000, topLeftCell: 'G10', activeCell: 'A1'}
3];

Auto filters⬆

It is possible to apply an auto filter to your worksheet.

1worksheet.autoFilter = 'A1:C1';

While the range string is the standard form of the autoFilter, the worksheet will also support the following values:

1// Set an auto filter from A1 to C1
2worksheet.autoFilter = {
3  from: 'A1',
4  to: 'C1',
5}
6
7// Set an auto filter from the cell in row 3 and column 1
8// to the cell in row 5 and column 12
9worksheet.autoFilter = {
10  from: {
11    row: 3,
12    column: 1
13  },
14  to: {
15    row: 5,
16    column: 12
17  }
18}
19
20// Set an auto filter from D3 to the
21// cell in row 7 and column 5
22worksheet.autoFilter = {
23  from: 'D3',
24  to: {
25    row: 7,
26    column: 5
27  }
28}

Columns⬆

1// Add column headers and define column keys and widths
2// Note: these column structures are a workbook-building convenience only,
3// apart from the column width, they will not be fully persisted.
4worksheet.columns = [
5  { header: 'Id', key: 'id', width: 10 },
6  { header: 'Name', key: 'name', width: 32 },
7  { header: 'D.O.B.', key: 'DOB', width: 10, outlineLevel: 1 }
8];
9
10// Access an individual columns by key, letter and 1-based column number
11const idCol = worksheet.getColumn('id');
12const nameCol = worksheet.getColumn('B');
13const dobCol = worksheet.getColumn(3);
14
15// set column properties
16
17// Note: will overwrite cell value C1
18dobCol.header = 'Date of Birth';
19
20// Note: this will overwrite cell values C1:C2
21dobCol.header = ['Date of Birth', 'A.K.A. D.O.B.'];
22
23// from this point on, this column will be indexed by 'dob' and not 'DOB'
24dobCol.key = 'dob';
25
26dobCol.width = 15;
27
28// Hide the column if you'd like
29dobCol.hidden = true;
30
31// set an outline level for columns
32worksheet.getColumn(4).outlineLevel = 0;
33worksheet.getColumn(5).outlineLevel = 1;
34
35// columns support a readonly field to indicate the collapsed state based on outlineLevel
36expect(worksheet.getColumn(4).collapsed).to.equal(false);
37expect(worksheet.getColumn(5).collapsed).to.equal(true);
38
39// iterate over all current cells in this column
40dobCol.eachCell(function(cell, rowNumber) {
41  // ...
42});
43
44// iterate over all current cells in this column including empty cells
45dobCol.eachCell({ includeEmpty: true }, function(cell, rowNumber) {
46  // ...
47});
48
49// add a column of new values
50worksheet.getColumn(6).values = [1,2,3,4,5];
51
52// add a sparse column of values
53worksheet.getColumn(7).values = [,,2,3,,5,,7,,,,11];
54
55// cut one or more columns (columns to the right are shifted left)
56// If column properties have been defined, they will be cut or moved accordingly
57// Known Issue: If a splice causes any merged cells to move, the results may be unpredictable
58worksheet.spliceColumns(3,2);
59
60// remove one column and insert two more.
61// Note: columns 4 and above will be shifted right by 1 column.
62// Also: If the worksheet has more rows than values in the column inserts,
63//  the rows will still be shifted as if the values existed
64const newCol3Values = [1,2,3,4,5];
65const newCol4Values = ['one', 'two', 'three', 'four', 'five'];
66worksheet.spliceColumns(3, 1, newCol3Values, newCol4Values);
67

Rows⬆

1// Get a row object. If it doesn't already exist, a new empty one will be returned
2const row = worksheet.getRow(5);
3
4// Get multiple row objects. If it doesn't already exist, new empty ones will be returned
5const rows = worksheet.getRows(5, 2); // start, length (>0, else undefined is returned)
6
7// Get the last editable row in a worksheet (or undefined if there are none)
8const row = worksheet.lastRow;
9
10// Set a specific row height
11row.height = 42.5;
12
13// make row hidden
14row.hidden = true;
15
16// set an outline level for rows
17worksheet.getRow(4).outlineLevel = 0;
18worksheet.getRow(5).outlineLevel = 1;
19
20// rows support a readonly field to indicate the collapsed state based on outlineLevel
21expect(worksheet.getRow(4).collapsed).to.equal(false);
22expect(worksheet.getRow(5).collapsed).to.equal(true);
23
24
25row.getCell(1).value = 5; // A5's value set to 5
26row.getCell('name').value = 'Zeb'; // B5's value set to 'Zeb' - assuming column 2 is still keyed by name
27row.getCell('C').value = new Date(); // C5's value set to now
28
29// Get a row as a sparse array
30// Note: interface change: worksheet.getRow(4) ==> worksheet.getRow(4).values
31row = worksheet.getRow(4).values;
32expect(row[5]).toEqual('Kyle');
33
34// assign row values by contiguous array (where array element 0 has a value)
35row.values = [1,2,3];
36expect(row.getCell(1).value).toEqual(1);
37expect(row.getCell(2).value).toEqual(2);
38expect(row.getCell(3).value).toEqual(3);
39
40// assign row values by sparse array  (where array element 0 is undefined)
41const values = []
42values[5] = 7;
43values[10] = 'Hello, World!';
44row.values = values;
45expect(row.getCell(1).value).toBeNull();
46expect(row.getCell(5).value).toEqual(7);
47expect(row.getCell(10).value).toEqual('Hello, World!');
48
49// assign row values by object, using column keys
50row.values = {
51  id: 13,
52  name: 'Thing 1',
53  dob: new Date()
54};
55
56// Insert a page break below the row
57row.addPageBreak();
58
59// Iterate over all rows that have values in a worksheet
60worksheet.eachRow(function(row, rowNumber) {
61  console.log('Row ' + rowNumber + ' = ' + JSON.stringify(row.values));
62});
63
64// Iterate over all rows (including empty rows) in a worksheet
65worksheet.eachRow({ includeEmpty: true }, function(row, rowNumber) {
66  console.log('Row ' + rowNumber + ' = ' + JSON.stringify(row.values));
67});
68
69// Iterate over all non-null cells in a row
70row.eachCell(function(cell, colNumber) {
71  console.log('Cell ' + colNumber + ' = ' + cell.value);
72});
73
74// Iterate over all cells in a row (including empty cells)
75row.eachCell({ includeEmpty: true }, function(cell, colNumber) {
76  console.log('Cell ' + colNumber + ' = ' + cell.value);
77});
78
79// Commit a completed row to stream
80row.commit();
81
82// row metrics
83const rowSize = row.cellCount;
84const numValues = row.actualCellCount;

Add Rows⬆

1// Add a couple of Rows by key-value, after the last current row, using the column keys
2worksheet.addRow({id: 1, name: 'John Doe', dob: new Date(1970,1,1)});
3worksheet.addRow({id: 2, name: 'Jane Doe', dob: new Date(1965,1,7)});
4
5// Add a row by contiguous Array (assign to columns A, B & C)
6worksheet.addRow([3, 'Sam', new Date()]);
7
8// Add a row by sparse Array (assign to columns A, E & I)
9const rowValues = [];
10rowValues[1] = 4;
11rowValues[5] = 'Kyle';
12rowValues[9] = new Date();
13worksheet.addRow(rowValues);
14
15// Add a row with inherited style
16// This new row will have same style as last row
17// And return as row object
18const newRow = worksheet.addRow(rowValues, 'i');
19
20// Add an array of rows
21const rows = [
22  [5,'Bob',new Date()], // row by array
23  {id:6, name: 'Barbara', dob: new Date()}
24];
25// add new rows and return them as array of row objects
26const newRows = worksheet.addRows(rows);
27
28// Add an array of rows with inherited style
29// These new rows will have same styles as last row
30// and return them as array of row objects
31const newRowsStyled = worksheet.addRows(rows, 'i');

Parameter	Description	Default Value
value/s	The new row/s values
style	'i' for inherit from row above, 'i+' to include empty cells, 'n' for none	'n'

Handling Individual Cells⬆

1const cell = worksheet.getCell('C3');
2
3// Modify/Add individual cell
4cell.value = new Date(1968, 5, 1);
5
6// query a cell's type
7expect(cell.type).toEqual(Excel.ValueType.Date);
8
9// use string value of cell
10myInput.value = cell.text;
11
12// use html-safe string for rendering...
13const html = '<div>' + cell.html + '</div>';
14

Merged Cells⬆

1// merge a range of cells
2worksheet.mergeCells('A4:B5');
3
4// ... merged cells are linked
5worksheet.getCell('B5').value = 'Hello, World!';
6expect(worksheet.getCell('B5').value).toBe(worksheet.getCell('A4').value);
7expect(worksheet.getCell('B5').master).toBe(worksheet.getCell('A4'));
8
9// ... merged cells share the same style object
10expect(worksheet.getCell('B5').style).toBe(worksheet.getCell('A4').style);
11worksheet.getCell('B5').style.font = myFonts.arial;
12expect(worksheet.getCell('A4').style.font).toBe(myFonts.arial);
13
14// unmerging the cells breaks the style links
15worksheet.unMergeCells('A4');
16expect(worksheet.getCell('B5').style).not.toBe(worksheet.getCell('A4').style);
17expect(worksheet.getCell('B5').style.font).not.toBe(myFonts.arial);
18
19// merge by top-left, bottom-right
20worksheet.mergeCells('K10', 'M12');
21
22// merge by start row, start column, end row, end column (equivalent to K10:M12)
23worksheet.mergeCells(10,11,12,13);

Insert Rows⬆

1insertRow(pos, value, style = 'n')
2insertRows(pos, values, style = 'n')
3
4// Insert a couple of Rows by key-value, shifting down rows every time
5worksheet.insertRow(1, {id: 1, name: 'John Doe', dob: new Date(1970,1,1)});
6worksheet.insertRow(1, {id: 2, name: 'Jane Doe', dob: new Date(1965,1,7)});
7
8// Insert a row by contiguous Array (assign to columns A, B & C)
9worksheet.insertRow(1, [3, 'Sam', new Date()]);
10
11// Insert a row by sparse Array (assign to columns A, E & I)
12var rowValues = [];
13rowValues[1] = 4;
14rowValues[5] = 'Kyle';
15rowValues[9] = new Date();
16// insert new row and return as row object
17const insertedRow = worksheet.insertRow(1, rowValues);
18
19// Insert a row, with inherited style
20// This new row will have same style as row on top of it
21// And return as row object
22const insertedRowInherited = worksheet.insertRow(1, rowValues, 'i');
23
24// Insert a row, keeping original style
25// This new row will have same style as it was previously
26// And return as row object
27const insertedRowOriginal = worksheet.insertRow(1, rowValues, 'o');
28
29// Insert an array of rows, in position 1, shifting down current position 1 and later rows by 2 rows
30var rows = [
31  [5,'Bob',new Date()], // row by array
32  {id:6, name: 'Barbara', dob: new Date()}
33];
34// insert new rows and return them as array of row objects
35const insertedRows = worksheet.insertRows(1, rows);
36
37// Insert an array of rows, with inherited style
38// These new rows will have same style as row on top of it
39// And return them as array of row objects
40const insertedRowsInherited = worksheet.insertRows(1, rows, 'i');
41
42// Insert an array of rows, keeping original style
43// These new rows will have same style as it was previously in 'pos' position
44const insertedRowsOriginal = worksheet.insertRows(1, rows, 'o');
45

Parameter	Description	Default Value
pos	Row number where you want to insert, pushing down all rows from there
value/s	The new row/s values
style	'i' for inherit from row above, , 'i+' to include empty cells, 'o' for original style, 'o+' to include empty cells, 'n' for none	'n'

Splice⬆

1// Cut one or more rows (rows below are shifted up)
2// Known Issue: If a splice causes any merged cells to move, the results may be unpredictable
3worksheet.spliceRows(4, 3);
4
5// remove one row and insert two more.
6// Note: rows 4 and below will be shifted down by 1 row.
7const newRow3Values = [1, 2, 3, 4, 5];
8const newRow4Values = ['one', 'two', 'three', 'four', 'five'];
9worksheet.spliceRows(3, 1, newRow3Values, newRow4Values);
10
11// Cut one or more cells (cells to the right are shifted left)
12// Note: this operation will not affect other rows
13row.splice(3, 2);
14
15// remove one cell and insert two more (cells to the right of the cut cell will be shifted right)
16row.splice(4, 1, 'new value 1', 'new value 2');

Parameter	Description	Default Value
start	Starting point to splice from
count	Number of rows/cells to remove
...inserts	New row/cell values to insert

Duplicate a Row⬆

1duplicateRow(start, amount = 1, insert = true)
2
3const wb = new ExcelJS.Workbook();
4const ws = wb.addWorksheet('duplicateTest');
5ws.getCell('A1').value = 'One';
6ws.getCell('A2').value = 'Two';
7ws.getCell('A3').value = 'Three';
8ws.getCell('A4').value = 'Four';
9
10// This line will duplicate the row 'One' twice but it will replace rows 'Two' and 'Three'
11// if third param was true so it would insert 2 new rows with the values and styles of row 'One'
12ws.duplicateRow(1,2,false);

Parameter	Description	Default Value
start	Row number you want to duplicate (first in excel is 1)
amount	The times you want to duplicate the row	1
insert	true if you want to insert new rows for the duplicates, or false if you want to replace them	true

Defined Names⬆

Individual cells (or multiple groups of cells) can have names assigned to them. The names can be used in formulas and data validation (and probably more).

1// assign (or get) a name for a cell (will overwrite any other names that cell had)
2worksheet.getCell('A1').name = 'PI';
3expect(worksheet.getCell('A1').name).to.equal('PI');
4
5// assign (or get) an array of names for a cell (cells can have more than one name)
6worksheet.getCell('A1').names = ['thing1', 'thing2'];
7expect(worksheet.getCell('A1').names).to.have.members(['thing1', 'thing2']);
8
9// remove a name from a cell
10worksheet.getCell('A1').removeName('thing1');
11expect(worksheet.getCell('A1').names).to.have.members(['thing2']);

Data Validations⬆

Cells can define what values are valid or not and provide prompting to the user to help guide them.

Validation types can be one of the following:

Type	Description
list	Define a discrete set of valid values. Excel will offer these in a dropdown for easy entry
whole	The value must be a whole number
decimal	The value must be a decimal number
textLength	The value may be text but the length is controlled
custom	A custom formula controls the valid values

For types other than list or custom, the following operators affect the validation:

Operator	Description
between	Values must lie between formula results
notBetween	Values must not lie between formula results
equal	Value must equal formula result
notEqual	Value must not equal formula result
greaterThan	Value must be greater than formula result
lessThan	Value must be less than formula result
greaterThanOrEqual	Value must be greater than or equal to formula result
lessThanOrEqual	Value must be less than or equal to formula result

1// Specify list of valid values (One, Two, Three, Four).
2// Excel will provide a dropdown with these values.
3worksheet.getCell('A1').dataValidation = {
4  type: 'list',
5  allowBlank: true,
6  formulae: ['"One,Two,Three,Four"']
7};
8
9// Specify list of valid values from a range.
10// Excel will provide a dropdown with these values.
11worksheet.getCell('A1').dataValidation = {
12  type: 'list',
13  allowBlank: true,
14  formulae: ['$D$5:$F$5']
15};
16
17// Specify Cell must be a whole number that is not 5.
18// Show the user an appropriate error message if they get it wrong
19worksheet.getCell('A1').dataValidation = {
20  type: 'whole',
21  operator: 'notEqual',
22  showErrorMessage: true,
23  formulae: [5],
24  errorStyle: 'error',
25  errorTitle: 'Five',
26  error: 'The value must not be Five'
27};
28
29// Specify Cell must be a decimal number between 1.5 and 7.
30// Add 'tooltip' to help guid the user
31worksheet.getCell('A1').dataValidation = {
32  type: 'decimal',
33  operator: 'between',
34  allowBlank: true,
35  showInputMessage: true,
36  formulae: [1.5, 7],
37  promptTitle: 'Decimal',
38  prompt: 'The value must between 1.5 and 7'
39};
40
41// Specify Cell must be have a text length less than 15
42worksheet.getCell('A1').dataValidation = {
43  type: 'textLength',
44  operator: 'lessThan',
45  showErrorMessage: true,
46  allowBlank: true,
47  formulae: [15]
48};
49
50// Specify Cell must be have be a date before 1st Jan 2016
51worksheet.getCell('A1').dataValidation = {
52  type: 'date',
53  operator: 'lessThan',
54  showErrorMessage: true,
55  allowBlank: true,
56  formulae: [new Date(2016,0,1)]
57};

Cell Comments⬆

Add old style comment to a cell

1// plain text note
2worksheet.getCell('A1').note = 'Hello, ExcelJS!';
3
4// colourful formatted note
5ws.getCell('B1').note = {
6  texts: [
7    {'font': {'size': 12, 'color': {'theme': 0}, 'name': 'Calibri', 'family': 2, 'scheme': 'minor'}, 'text': 'This is '},
8    {'font': {'italic': true, 'size': 12, 'color': {'theme': 0}, 'name': 'Calibri', 'scheme': 'minor'}, 'text': 'a'},
9    {'font': {'size': 12, 'color': {'theme': 1}, 'name': 'Calibri', 'family': 2, 'scheme': 'minor'}, 'text': ' '},
10    {'font': {'size': 12, 'color': {'argb': 'FFFF6600'}, 'name': 'Calibri', 'scheme': 'minor'}, 'text': 'colorful'},
11    {'font': {'size': 12, 'color': {'theme': 1}, 'name': 'Calibri', 'family': 2, 'scheme': 'minor'}, 'text': ' text '},
12    {'font': {'size': 12, 'color': {'argb': 'FFCCFFCC'}, 'name': 'Calibri', 'scheme': 'minor'}, 'text': 'with'},
13    {'font': {'size': 12, 'color': {'theme': 1}, 'name': 'Calibri', 'family': 2, 'scheme': 'minor'}, 'text': ' in-cell '},
14    {'font': {'bold': true, 'size': 12, 'color': {'theme': 1}, 'name': 'Calibri', 'family': 2, 'scheme': 'minor'}, 'text': 'format'},
15  ],
16  margins: {
17    insetmode: 'custom',
18    inset: [0.25, 0.25, 0.35, 0.35]
19  },
20  protection: {
21    locked: True,
22    lockText: False
23  },
24  editAs: 'twoCells',
25};

Cell Comments Properties⬆

The following table defines the properties supported by cell comments.

Field	Required	Default Value	Description
texts	Y		The text of the comment
margins	N	{}	Determines the value of margins for automatic or custom cell comments
protection	N	{}	Specifying the lock status of objects and object text using protection attributes
editAs	N	'absolute'	Use the 'editAs' attribute to specify how the annotation is anchored to the cell

Cell Comments Margins

Determine the page margin setting mode of the cell annotation, automatic or custom mode.

1ws.getCell('B1').note.margins = {
2  insetmode: 'custom',
3  inset: [0.25, 0.25, 0.35, 0.35]
4}

Supported Margins Properties⬆

Property	Required	Default Value	Description
insetmode	N	'auto'	Determines whether comment margins are set automatically and the value is 'auto' or 'custom'
inset	N	[0.13, 0.13, 0.25, 0.25]	Whitespace on the borders of the comment. Units are centimeter. Direction is left, top, right, bottom

Note: This inset setting takes effect only when the value of insetmode is 'custom'.

Cell Comments Protection

Specifying the lock status of objects and object text using protection attributes.

1ws.getCell('B1').note.protection = {
2  locked: 'False',
3  lockText: 'False',
4};

Supported Protection Properties⬆

Property	Required	Default Value	Description
locked	N	'True'	This element specifies that the object is locked when the sheet is protected
lockText	N	'True'	This element specifies that the text of the object is locked

Note: Locked objects are valid only when the worksheet is protected.

Cell Comments EditAs⬆

The cell comments can also have the property 'editAs' which will control how the comments is anchored to the cell(s). It can have one of the following values:

1ws.getCell('B1').note.editAs = 'twoCells';

Value	Description
twoCells	It specifies that the size and position of the note varies with cells
oneCells	It specifies that the size of the note is fixed and the position changes with the cell
absolute	This is the default. Comments will not be moved or sized with cells

Tables⬆

Tables allow for in-sheet manipulation of tabular data.

To add a table to a worksheet, define a table model and call addTable:

1// add a table to a sheet
2ws.addTable({
3  name: 'MyTable',
4  ref: 'A1',
5  headerRow: true,
6  totalsRow: true,
7  style: {
8    theme: 'TableStyleDark3',
9    showRowStripes: true,
10  },
11  columns: [
12    {name: 'Date', totalsRowLabel: 'Totals:', filterButton: true},
13    {name: 'Amount', totalsRowFunction: 'sum', filterButton: false},
14  ],
15  rows: [
16    [new Date('2019-07-20'), 70.10],
17    [new Date('2019-07-21'), 70.60],
18    [new Date('2019-07-22'), 70.10],
19  ],
20});

Note: Adding a table to a worksheet will modify the sheet by placing headers and row data to the sheet. Any data on the sheet covered by the resulting table (including headers and totals) will be overwritten.

Table Properties⬆

The following table defines the properties supported by tables.

Table Property	Description	Required	Default Value
name	The name of the table	Y
displayName	The display name of the table	N	name
ref	Top left cell of the table	Y
headerRow	Show headers at top of table	N	true
totalsRow	Show totals at bottom of table	N	false
style	Extra style properties	N	{}
columns	Column definitions	Y
rows	Rows of data	Y

Table Style Properties⬆

The following table defines the properties supported within the table style property.

Style Property	Description	Required	Default Value
theme	The colour theme of the table	N	'TableStyleMedium2'
showFirstColumn	Highlight the first column (bold)	N	false
showLastColumn	Highlight the last column (bold)	N	false
showRowStripes	Alternate rows shown with background colour	N	false
showColumnStripes	Alternate rows shown with background colour	N	false

Table Column Properties⬆

The following table defines the properties supported within each table column.

Column Property	Description	Required	Default Value
name	The name of the column, also used in the header	Y
filterButton	Switches the filter control in the header	N	false
totalsRowLabel	Label to describe the totals row (first column)	N	'Total'
totalsRowFunction	Name of the totals function	N	'none'
totalsRowFormula	Optional formula for custom functions	N

Totals Functions⬆

The following table list the valid values for the totalsRowFunction property defined by columns. If any value other than 'custom' is used, it is not necessary to include the associated formula as this will be inserted by the table.

Totals Functions	Description
none	No totals function for this column
average	Compute average for the column
countNums	Count the entries that are numbers
count	Count of entries
max	The maximum value in this column
min	The minimum value in this column
stdDev	The standard deviation for this column
var	The variance for this column
sum	The sum of entries for this column
custom	A custom formula. Requires an associated totalsRowFormula value.

Table Style Themes⬆

Valid theme names follow the following pattern:

"TableStyle[Shade][Number]"

Shades, Numbers can be one of:

Light, 1-21
Medium, 1-28
Dark, 1-11

For no theme, use the value null.

Note: custom table themes are not supported by exceljs yet.

Modifying Tables⬆

Tables support a set of manipulation functions that allow data to be added or removed and some properties to be changed. Since many of these operations may have on-sheet effects, the changes must be committed once complete.

All index values in the table are zero based, so the first row number and first column number is 0.

Adding or Removing Headers and Totals

1const table = ws.getTable('MyTable');
2
3// turn header row on
4table.headerRow = true;
5
6// turn totals row off
7table.totalsRow = false;
8
9// commit the table changes into the sheet
10table.commit();

Relocating a Table

1const table = ws.getTable('MyTable');
2
3// table top-left move to D4
4table.ref = 'D4';
5
6// commit the table changes into the sheet
7table.commit();

Adding and Removing Rows

1const table = ws.getTable('MyTable');
2
3// remove first two rows
4table.removeRows(0, 2);
5
6// insert new rows at index 5
7table.addRow([new Date('2019-08-05'), 5, 'Mid'], 5);
8
9// append new row to bottom of table
10table.addRow([new Date('2019-08-10'), 10, 'End']);
11
12// commit the table changes into the sheet
13table.commit();

Adding and Removing Columns

1const table = ws.getTable('MyTable');
2
3// remove second column
4table.removeColumns(1, 1);
5
6// insert new column (with data) at index 1
7table.addColumn(
8  {name: 'Letter', totalsRowFunction: 'custom', totalsRowFormula: 'ROW()', totalsRowResult: 6, filterButton: true},
9  ['a', 'b', 'c', 'd'],
10  2
11);
12
13// commit the table changes into the sheet
14table.commit();

Change Column Properties

1const table = ws.getTable('MyTable');
2
3// Get Column Wrapper for second column
4const column = table.getColumn(1);
5
6// set some properties
7column.name = 'Code';
8column.filterButton = true;
9column.style = {font:{bold: true, name: 'Comic Sans MS'}};
10column.totalsRowLabel = 'Totals';
11column.totalsRowFunction = 'custom';
12column.totalsRowFormula = 'ROW()';
13column.totalsRowResult = 10;
14
15// commit the table changes into the sheet
16table.commit();

Styles⬆

Cells, Rows and Columns each support a rich set of styles and formats that affect how the cells are displayed.

Styles are set by assigning the following properties:

numFmt
font
alignment
border
fill

1// assign a style to a cell
2ws.getCell('A1').numFmt = '0.00%';
3
4// Apply styles to worksheet columns
5ws.columns = [
6  { header: 'Id', key: 'id', width: 10 },
7  { header: 'Name', key: 'name', width: 32, style: { font: { name: 'Arial Black' } } },
8  { header: 'D.O.B.', key: 'DOB', width: 10, style: { numFmt: 'dd/mm/yyyy' } }
9];
10
11// Set Column 3 to Currency Format
12ws.getColumn(3).numFmt = '"£"#,##0.00;[Red]\-"£"#,##0.00';
13
14// Set Row 2 to Comic Sans.
15ws.getRow(2).font = { name: 'Comic Sans MS', family: 4, size: 16, underline: 'double', bold: true };

When a style is applied to a row or column, it will be applied to all currently existing cells in that row or column. Also, any new cell that is created will inherit its initial styles from the row and column it belongs to.

If a cell's row and column both define a specific style (e.g. font), the cell will use the row style over the column style. However if the row and column define different styles (e.g. column.numFmt and row.font), the cell will inherit the font from the row and the numFmt from the column.

Caveat: All the above properties (with the exception of numFmt, which is a string), are JS object structures. If the same style object is assigned to more than one spreadsheet entity, then each entity will share the same style object. If the style object is later modified before the spreadsheet is serialized, then all entities referencing that style object will be modified too. This behaviour is intended to prioritize performance by reducing the number of JS objects created. If you want the style objects to be independent, you will need to clone them before assigning them. Also, by default, when a document is read from file (or stream) if spreadsheet entities share similar styles, then they will reference the same style object too.

Number Formats⬆

1// display value as '1 3/5'
2ws.getCell('A1').value = 1.6;
3ws.getCell('A1').numFmt = '# ?/?';
4
5// display value as '1.60%'
6ws.getCell('B1').value = 0.016;
7ws.getCell('B1').numFmt = '0.00%';

Fonts⬆

1
2// for the wannabe graphic designers out there
3ws.getCell('A1').font = {
4  name: 'Comic Sans MS',
5  family: 4,
6  size: 16,
7  underline: true,
8  bold: true
9};
10
11// for the graduate graphic designers...
12ws.getCell('A2').font = {
13  name: 'Arial Black',
14  color: { argb: 'FF00FF00' },
15  family: 2,
16  size: 14,
17  italic: true
18};
19
20// for the vertical align
21ws.getCell('A3').font = {
22  vertAlign: 'superscript'
23};
24
25// note: the cell will store a reference to the font object assigned.
26// If the font object is changed afterwards, the cell font will change also...
27const font = { name: 'Arial', size: 12 };
28ws.getCell('A3').font = font;
29font.size = 20; // Cell A3 now has font size 20!
30
31// Cells that share similar fonts may reference the same font object after
32// the workbook is read from file or stream

Font Property	Description	Example Value(s)
name	Font name.	'Arial', 'Calibri', etc.
family	Font family for fallback. An integer value.	1 - Serif, 2 - Sans Serif, 3 - Mono, Others - unknown
scheme	Font scheme.	'minor', 'major', 'none'
charset	Font charset. An integer value.	1, 2, etc.
size	Font size. An integer value.	9, 10, 12, 16, etc.
color	Colour description, an object containing an ARGB value.	{ argb: 'FFFF0000'}
bold	Font weight	true, false
italic	Font slope	true, false
underline	Font underline style	true, false, 'none', 'single', 'double', 'singleAccounting', 'doubleAccounting'
strike	Font ~~strikethrough~~	true, false
outline	Font outline	true, false
vertAlign	Vertical align	'superscript', 'subscript'

Alignment⬆

1// set cell alignment to top-left, middle-center, bottom-right
2ws.getCell('A1').alignment = { vertical: 'top', horizontal: 'left' };
3ws.getCell('B1').alignment = { vertical: 'middle', horizontal: 'center' };
4ws.getCell('C1').alignment = { vertical: 'bottom', horizontal: 'right' };
5
6// set cell to wrap-text
7ws.getCell('D1').alignment = { wrapText: true };
8
9// set cell indent to 1
10ws.getCell('E1').alignment = { indent: 1 };
11
12// set cell text rotation to 30deg upwards, 45deg downwards and vertical text
13ws.getCell('F1').alignment = { textRotation: 30 };
14ws.getCell('G1').alignment = { textRotation: -45 };
15ws.getCell('H1').alignment = { textRotation: 'vertical' };

Valid Alignment Property Values

horizontal	vertical	wrapText	shrinkToFit	indent	readingOrder	textRotation
left	top	true	true	integer	rtl	0 to 90
center	middle	false	false		ltr	-1 to -90
right	bottom					vertical
fill	distributed
justify	justify
centerContinuous
distributed

Borders⬆

1// set single thin border around A1
2ws.getCell('A1').border = {
3  top: {style:'thin'},
4  left: {style:'thin'},
5  bottom: {style:'thin'},
6  right: {style:'thin'}
7};
8
9// set double thin green border around A3
10ws.getCell('A3').border = {
11  top: {style:'double', color: {argb:'FF00FF00'}},
12  left: {style:'double', color: {argb:'FF00FF00'}},
13  bottom: {style:'double', color: {argb:'FF00FF00'}},
14  right: {style:'double', color: {argb:'FF00FF00'}}
15};
16
17// set thick red cross in A5
18ws.getCell('A5').border = {
19  diagonal: {up: true, down: true, style:'thick', color: {argb:'FFFF0000'}}
20};

Valid Border Styles

thin
dotted
dashDot
hair
dashDotDot
slantDashDot
mediumDashed
mediumDashDotDot
mediumDashDot
medium
double
thick

Fills⬆

1// fill A1 with red darkVertical stripes
2ws.getCell('A1').fill = {
3  type: 'pattern',
4  pattern:'darkVertical',
5  fgColor:{argb:'FFFF0000'}
6};
7
8// fill A2 with yellow dark trellis and blue behind
9ws.getCell('A2').fill = {
10  type: 'pattern',
11  pattern:'darkTrellis',
12  fgColor:{argb:'FFFFFF00'},
13  bgColor:{argb:'FF0000FF'}
14};
15
16// fill A3 with solid coral
17ws.getCell('A3').fill = {
18  type: 'pattern',
19  pattern:'solid',
20  fgColor:{argb:'F08080'},
21};
22
23// fill A4 with blue-white-blue gradient from left to right
24ws.getCell('A4').fill = {
25  type: 'gradient',
26  gradient: 'angle',
27  degree: 0,
28  stops: [
29    {position:0, color:{argb:'FF0000FF'}},
30    {position:0.5, color:{argb:'FFFFFFFF'}},
31    {position:1, color:{argb:'FF0000FF'}}
32  ]
33};
34
35
36// fill A5 with red-green gradient from center
37ws.getCell('A5').fill = {
38  type: 'gradient',
39  gradient: 'path',
40  center:{left:0.5,top:0.5},
41  stops: [
42    {position:0, color:{argb:'FFFF0000'}},
43    {position:1, color:{argb:'FF00FF00'}}
44  ]
45};

Pattern Fills⬆

Property	Required	Description
type	Y	Value: 'pattern' Specifies this fill uses patterns
pattern	Y	Specifies type of pattern (see Valid Pattern Types below)
fgColor	N	Specifies the pattern foreground color. Default is black.
bgColor	N	Specifies the pattern background color. Default is white.

Note: If you want to fill a cell using the solid pattern, then you don't need to specify bgColor. See example above for cell A3 with a solid pattern and a coral fgColor.

Valid Pattern Types

none
solid
darkGray
mediumGray
lightGray
gray125
gray0625
darkHorizontal
darkVertical
darkDown
darkUp
darkGrid
darkTrellis
lightHorizontal
lightVertical
lightDown
lightUp
lightGrid
lightTrellis

Gradient Fills⬆

Property	Required	Description
type	Y	Value: 'gradient' Specifies this fill uses gradients
gradient	Y	Specifies gradient type. One of ['angle', 'path']
degree	angle	For 'angle' gradient, specifies the direction of the gradient. 0 is from the left to the right. Values from 1 - 359 rotates the direction clockwise
center	path	For 'path' gradient. Specifies the relative coordinates for the start of the path. 'left' and 'top' values range from 0 to 1
stops	Y	Specifies the gradient colour sequence. Is an array of objects containing position and color starting with position 0 and ending with position 1. Intermediary positions may be used to specify other colours on the path.

Caveats

Using the interface above it may be possible to create gradient fill effects not possible using the XLSX editor program. For example, Excel only supports angle gradients of 0, 45, 90 and 135. Similarly the sequence of stops may also be limited by the UI with positions [0,1] or [0,0.5,1] as the only options. Take care with this fill to be sure it is supported by the target XLSX viewers.

Rich Text⬆

Individual cells now support rich text or in-cell formatting. Rich text values can control the font properties of any number of sub-strings within the text value. See Fonts for a complete list of details on what font properties are supported.

1
2ws.getCell('A1').value = {
3  'richText': [
4    {'font': {'size': 12,'color': {'theme': 0},'name': 'Calibri','family': 2,'scheme': 'minor'},'text': 'This is '},
5    {'font': {'italic': true,'size': 12,'color': {'theme': 0},'name': 'Calibri','scheme': 'minor'},'text': 'a'},
6    {'font': {'size': 12,'color': {'theme': 1},'name': 'Calibri','family': 2,'scheme': 'minor'},'text': ' '},
7    {'font': {'size': 12,'color': {'argb': 'FFFF6600'},'name': 'Calibri','scheme': 'minor'},'text': 'colorful'},
8    {'font': {'size': 12,'color': {'theme': 1},'name': 'Calibri','family': 2,'scheme': 'minor'},'text': ' text '},
9    {'font': {'size': 12,'color': {'argb': 'FFCCFFCC'},'name': 'Calibri','scheme': 'minor'},'text': 'with'},
10    {'font': {'size': 12,'color': {'theme': 1},'name': 'Calibri','family': 2,'scheme': 'minor'},'text': ' in-cell '},
11    {'font': {'bold': true,'size': 12,'color': {'theme': 1},'name': 'Calibri','family': 2,'scheme': 'minor'},'text': 'format'}
12  ]
13};
14
15expect(ws.getCell('A1').text).to.equal('This is a colorful text with in-cell format');
16expect(ws.getCell('A1').type).to.equal(Excel.ValueType.RichText);
17

Cell Protection⬆

Cell level protection can be modified using the protection property.

1ws.getCell('A1').protection = {
2  locked: false,
3  hidden: true,
4};

Supported Protection Properties

Property	Default	Description
locked	true	Specifies whether a cell will be locked if the sheet is protected.
hidden	false	Specifies whether a cell's formula will be visible if the sheet is protected.

Conditional Formatting⬆

Conditional formatting allows a sheet to show specific styles, icons, etc depending on cell values or any arbitrary formula.

Conditional formatting rules are added at the sheet level and will typically cover a range of cells.

Multiple rules can be applied to a given cell range and each rule will apply its own style.

If multiple rules affect a given cell, the rule priority value will determine which rule wins out if competing styles collide. The rule with the lower priority value wins. If priority values are not specified for a given rule, ExcelJS will assign them in ascending order.

Note: at present, only a subset of conditional formatting rules are supported. Specifically, only the formatting rules that do not require XML rendering inside an <extLst> element. This means that datasets and three specific icon sets (3Triangles, 3Stars, 5Boxes) are not supported.

1// add a checkerboard pattern to A1:E7 based on row + col being even or odd
2worksheet.addConditionalFormatting({
3  ref: 'A1:E7',
4  rules: [
5    {
6      type: 'expression',
7      formulae: ['MOD(ROW()+COLUMN(),2)=0'],
8      style: {fill: {type: 'pattern', pattern: 'solid', bgColor: {argb: 'FF00FF00'}}},
9    }
10  ]
11})

Supported Conditional Formatting Rule Types

Type	Description
expression	Any custom function may be used to activate the rule.
cellIs	Compares cell value with supplied formula using specified operator
top10	Applies formatting to cells with values in top (or bottom) ranges
aboveAverage	Applies formatting to cells with values above (or below) average
colorScale	Applies a coloured background to cells based on where their values lie in the range
iconSet	Adds one of a range of icons to cells based on value
containsText	Applies formatting based on whether cell a specific text
timePeriod	Applies formatting based on whether cell datetime value lies within a specified range

Expression⬆

Field	Optional	Default	Description
type			'expression'
priority	Y	<auto>	determines priority ordering of styles
formulae			array of 1 formula string that returns a true/false value. To reference the cell value, use the top-left cell address
style			style structure to apply if the formula returns true

Cell Is⬆

Field	Optional	Default	Description
type			'cellIs'
priority	Y	<auto>	determines priority ordering of styles
operator			how to compare cell value with formula result
formulae			array of 1 formula string that returns the value to compare against each cell
style			style structure to apply if the comparison returns true

Cell Is Operators

Operator	Description
equal	Apply format if cell value equals formula value
greaterThan	Apply format if cell value is greater than formula value
lessThan	Apply format if cell value is less than formula value
between	Apply format if cell value is between two formula values (inclusive)

Top 10⬆

Field	Optional	Default	Description
type			'top10'
priority	Y	<auto>	determines priority ordering of styles
rank	Y	10	specifies how many top (or bottom) values are included in the formatting
percent	Y	false	if true, the rank field is a percentage, not an absolute
bottom	Y	false	if true, the bottom values are included instead of the top
style			style structure to apply if the comparison returns true

Above Average⬆

Field	Optional	Default	Description
type			'aboveAverage'
priority	Y	<auto>	determines priority ordering of styles
aboveAverage	Y	false	if true, the rank field is a percentage, not an absolute
style			style structure to apply if the comparison returns true

Color Scale⬆

Field	Optional	Default	Description
type			'colorScale'
priority	Y	<auto>	determines priority ordering of styles
cfvo			array of 2 to 5 Conditional Formatting Value Objects specifying way-points in the value range
color			corresponding array of colours to use at given way points
style			style structure to apply if the comparison returns true

Icon Set⬆

Field	Optional	Default	Description
type			'iconSet'
priority	Y	<auto>	determines priority ordering of styles
iconSet	Y	3TrafficLights	name of icon set to use
showValue		true	Specifies whether the cells in the applied range display the icon and cell value, or the icon only
reverse		false	Specifies whether the icons in the icon set specified in iconSet are show in reserve order. If custom equals "true" this value must be ignored
custom		false	Specifies whether a custom set of icons is used
cfvo			array of 2 to 5 Conditional Formatting Value Objects specifying way-points in the value range
style			style structure to apply if the comparison returns true

Data Bar⬆

Field	Optional	Default	Description
type			'dataBar'
priority	Y	<auto>	determines priority ordering of styles
minLength		0	Specifies the length of the shortest data bar in this conditional formatting range
maxLength		100	Specifies the length of the longest data bar in this conditional formatting range
showValue		true	Specifies whether the cells in the conditional formatting range display both the data bar and the numeric value or the data bar
gradient		true	Specifies whether the data bar has a gradient fill
border		true	Specifies whether the data bar has a border
negativeBarColorSameAsPositive		true	Specifies whether the data bar has a negative bar color that is different from the positive bar color
negativeBarBorderColorSameAsPositive		true	Specifies whether the data bar has a negative border color that is different from the positive border color
axisPosition		'auto'	Specifies the axis position for the data bar
direction		'leftToRight'	Specifies the direction of the data bar
cfvo			array of 2 to 5 Conditional Formatting Value Objects specifying way-points in the value range
style			style structure to apply if the comparison returns true

Contains Text⬆

Field	Optional	Default	Description
type			'containsText'
priority	Y	<auto>	determines priority ordering of styles
operator			type of text comparison
text			text to search for
style			style structure to apply if the comparison returns true

Contains Text Operators

Operator	Description
containsText	Apply format if cell value contains the value specified in the 'text' field
containsBlanks	Apply format if cell value contains blanks
notContainsBlanks	Apply format if cell value does not contain blanks
containsErrors	Apply format if cell value contains errors
notContainsErrors	Apply format if cell value does not contain errors

Time Period⬆

Field	Optional	Default	Description
type			'timePeriod'
priority	Y	<auto>	determines priority ordering of styles
timePeriod			what time period to compare cell value to
style			style structure to apply if the comparison returns true

Time Periods

Time Period	Description
lastWeek	Apply format if cell value falls within the last week
thisWeek	Apply format if cell value falls in this week
nextWeek	Apply format if cell value falls in the next week
yesterday	Apply format if cell value is equal to yesterday
today	Apply format if cell value is equal to today
tomorrow	Apply format if cell value is equal to tomorrow
last7Days	Apply format if cell value falls within the last 7 days
lastMonth	Apply format if cell value falls in last month
thisMonth	Apply format if cell value falls in this month
nextMonth	Apply format if cell value falls in next month

Outline Levels⬆

Excel supports outlining; where rows or columns can be expanded or collapsed depending on what level of detail the user wishes to view.

Outline levels can be defined in column setup:

1worksheet.columns = [
2  { header: 'Id', key: 'id', width: 10 },
3  { header: 'Name', key: 'name', width: 32 },
4  { header: 'D.O.B.', key: 'DOB', width: 10, outlineLevel: 1 }
5];

Or directly on the row or column

1worksheet.getColumn(3).outlineLevel = 1;
2worksheet.getRow(3).outlineLevel = 1;

The sheet outline levels can be set on the worksheet

1// set column outline level
2worksheet.properties.outlineLevelCol = 1;
3
4// set row outline level
5worksheet.properties.outlineLevelRow = 1;

Note: adjusting outline levels on rows or columns or the outline levels on the worksheet will incur a side effect of also modifying the collapsed property of all rows or columns affected by the property change. E.g.:

1worksheet.properties.outlineLevelCol = 1;
2
3worksheet.getColumn(3).outlineLevel = 1;
4expect(worksheet.getColumn(3).collapsed).to.be.true;
5
6worksheet.properties.outlineLevelCol = 2;
7expect(worksheet.getColumn(3).collapsed).to.be.false;

The outline properties can be set on the worksheet

1worksheet.properties.outlineProperties = {
2  summaryBelow: false,
3  summaryRight: false,
4};

Images⬆

Adding images to a worksheet is a two-step process. First, the image is added to the workbook via the addImage() function which will also return an imageId value. Then, using the imageId, the image can be added to the worksheet either as a tiled background or covering a cell range.

Note: As of this version, adjusting or transforming the image is not supported and images are not supported in streaming mode.

Add Image to Workbook⬆

The Workbook.addImage function supports adding images by filename or by Buffer. Note that in both cases, the extension must be specified. Valid extension values include 'jpeg', 'png', 'gif'.

1// add image to workbook by filename
2const imageId1 = workbook.addImage({
3  filename: 'path/to/image.jpg',
4  extension: 'jpeg',
5});
6
7// add image to workbook by buffer
8const imageId2 = workbook.addImage({
9  buffer: fs.readFileSync('path/to.image.png'),
10  extension: 'png',
11});
12
13// add image to workbook by base64
14const myBase64Image = "data:image/png;base64,iVBORw0KG...";
15const imageId2 = workbook.addImage({
16  base64: myBase64Image,
17  extension: 'png',
18});

Add image background to worksheet⬆

Using the image id from Workbook.addImage, the background to a worksheet can be set using the addBackgroundImage function

1// set background
2worksheet.addBackgroundImage(imageId1);

Add image over a range⬆

Using the image id from Workbook.addImage, an image can be embedded within the worksheet to cover a range. The coordinates calculated from the range will cover from the top-left of the first cell to the bottom right of the second.

1// insert an image over B2:D6
2worksheet.addImage(imageId2, 'B2:D6');

Using a structure instead of a range string, it is possible to partially cover cells.

Note that the coordinate system used for this is zero based, so the top-left of A1 will be { col: 0, row: 0 }. Fractions of cells can be specified by using floating point numbers, e.g. the midpoint of A1 is { col: 0.5, row: 0.5 }.

1// insert an image over part of B2:D6
2worksheet.addImage(imageId2, {
3  tl: { col: 1.5, row: 1.5 },
4  br: { col: 3.5, row: 5.5 }
5});

The cell range can also have the property 'editAs' which will control how the image is anchored to the cell(s) It can have one of the following values:

Value	Description
undefined	It specifies the image will be moved and sized with cells
oneCell	This is the default. Image will be moved with cells but not sized
absolute	Image will not be moved or sized with cells

1ws.addImage(imageId, {
2  tl: { col: 0.1125, row: 0.4 },
3  br: { col: 2.101046875, row: 3.4 },
4  editAs: 'oneCell'
5});

Add image to a cell⬆

You can add an image to a cell and then define its width and height in pixels at 96dpi.

1worksheet.addImage(imageId2, {
2  tl: { col: 0, row: 0 },
3  ext: { width: 500, height: 200 }
4});

Add image with hyperlinks⬆

You can add an image with hyperlinks to a cell, and defines the hyperlinks in image range.

1worksheet.addImage(imageId2, {
2  tl: { col: 0, row: 0 },
3  ext: { width: 500, height: 200 },
4  hyperlinks: {
5    hyperlink: 'http://www.somewhere.com',
6    tooltip: 'http://www.somewhere.com'
7  }
8});

Sheet Protection⬆

Worksheets can be protected from modification by adding a password.

1await worksheet.protect('the-password', options);

Worksheet protection can also be removed:

1worksheet.unprotect();

See Cell Protection for details on how to modify individual cell protection.

Note: While the protect() function returns a Promise indicating that it is async, the current implementation runs on the main thread and will use approx 600ms on an average CPU. This can be adjusted by setting the spinCount, which can be used to make the process either faster or more resilient.

Sheet Protection Options⬆

Field	Default	Description
selectLockedCells	true	Lets the user select locked cells
selectUnlockedCells	true	Lets the user select unlocked cells
formatCells	false	Lets the user format cells
formatColumns	false	Lets the user format columns
formatRows	false	Lets the user format rows
insertRows	false	Lets the user insert rows
insertColumns	false	Lets the user insert columns
insertHyperlinks	false	Lets the user insert hyperlinks
deleteRows	false	Lets the user delete rows
deleteColumns	false	Lets the user delete columns
sort	false	Lets the user sort data
autoFilter	false	Lets the user filter data in tables
pivotTables	false	Lets the user use pivot tables
spinCount	100000	The number of hash iterations performed when protecting or unprotecting

File I/O⬆

XLSX⬆

Reading XLSX⬆

Options supported when reading CSV files.

Field	Required	Type	Description
ignoreNodes	N	Array	A list of node names to ignore while loading the XLSX document. Improves performance in some situations. Available: `sheetPr`, `dimension`, `sheetViews` , `sheetFormatPr`, `cols` , `sheetData`, `autoFilter` , `mergeCells` , `rowBreaks`, `hyperlinks` , `pageMargins`, `dataValidations`, `pageSetup`, `headerFooter` , `printOptions` , `picture`, `drawing`, `sheetProtection`, `tableParts` , `conditionalFormatting`, `extLst`,

1// read from a file
2const workbook = new Excel.Workbook();
3await workbook.xlsx.readFile(filename);
4// ... use workbook
5
6
7// read from a stream
8const workbook = new Excel.Workbook();
9await workbook.xlsx.read(stream);
10// ... use workbook
11
12
13// load from buffer
14const workbook = new Excel.Workbook();
15await workbook.xlsx.load(data);
16// ... use workbook
17
18
19// using additional options
20const workbook = new Excel.Workbook();
21await workbook.xlsx.load(data, {
22  ignoreNodes: [
23    'dataValidations' // ignores the workbook's Data Validations
24  ],
25});
26// ... use workbook

Writing XLSX⬆

1// write to a file
2const workbook = createAndFillWorkbook();
3await workbook.xlsx.writeFile(filename);
4
5// write to a stream
6await workbook.xlsx.write(stream);
7
8// write to a new buffer
9const buffer = await workbook.xlsx.writeBuffer();

CSV⬆

Reading CSV⬆

Options supported when reading CSV files.

Field	Required	Type	Description
dateFormats	N	Array	Specify the date encoding format of dayjs.
map	N	Function	Custom Array.prototype.map() callback function for processing data.
sheetName	N	String	Specify worksheet name.
parserOptions	N	Object	parseOptions options @fast-csv/format module to write csv data.

1// read from a file
2const workbook = new Excel.Workbook();
3const worksheet = await workbook.csv.readFile(filename);
4// ... use workbook or worksheet
5
6
7// read from a stream
8const workbook = new Excel.Workbook();
9const worksheet = await workbook.csv.read(stream);
10// ... use workbook or worksheet
11
12
13// read from a file with European Dates
14const workbook = new Excel.Workbook();
15const options = {
16  dateFormats: ['DD/MM/YYYY']
17};
18const worksheet = await workbook.csv.readFile(filename, options);
19// ... use workbook or worksheet
20
21
22// read from a file with custom value parsing
23const workbook = new Excel.Workbook();
24const options = {
25  map(value, index) {
26    switch(index) {
27      case 0:
28        // column 1 is string
29        return value;
30      case 1:
31        // column 2 is a date
32        return new Date(value);
33      case 2:
34        // column 3 is JSON of a formula value
35        return JSON.parse(value);
36      default:
37        // the rest are numbers
38        return parseFloat(value);
39    }
40  },
41  // https://c2fo.github.io/fast-csv/docs/parsing/options
42  parserOptions: {
43    delimiter: '\t',
44    quote: false,
45  },
46};
47const worksheet = await workbook.csv.readFile(filename, options);
48// ... use workbook or worksheet

The CSV parser uses fast-csv to read the CSV file. The formatterOptions in the options passed to the above write function will be passed to the @fast-csv/format module to write csv data. Please refer to the fast-csv README.md for details.

Dates are parsed using the npm module dayjs. If a dateFormats array is not supplied, the following dateFormats are used:

'YYYY-MM-DD[T]HH:mm:ss'
'MM-DD-YYYY'
'YYYY-MM-DD'

Please refer to the dayjs CustomParseFormat plugin for details on how to structure a dateFormat.

Writing CSV⬆

Options supported when writing to a CSV file.

Field	Required	Type	Description
dateFormat	N	String	Specify the date encoding format of dayjs.
dateUTC	N	Boolean	Specify whether ExcelJS uses `dayjs.utc ()` to convert time zone for parsing dates.
encoding	N	String	Specify file encoding format. (Only applies to `.writeFile`.)
includeEmptyRows	N	Boolean	Specifies whether empty rows can be written.
map	N	Function	Custom Array.prototype.map() callback function for processing row values.
sheetName	N	String	Specify worksheet name.
sheetId	N	Number	Specify worksheet ID.
formatterOptions	N	Object	formatterOptions options @fast-csv/format module to write csv data.

1
2// write to a file
3const workbook = createAndFillWorkbook();
4await workbook.csv.writeFile(filename);
5
6// write to a stream
7// Be careful that you need to provide sheetName or
8// sheetId for correct import to csv.
9await workbook.csv.write(stream, { sheetName: 'Page name' });
10
11// write to a file with European Date-Times
12const workbook = new Excel.Workbook();
13const options = {
14  dateFormat: 'DD/MM/YYYY HH:mm:ss',
15  dateUTC: true, // use utc when rendering dates
16};
17await workbook.csv.writeFile(filename, options);
18
19
20// write to a file with custom value formatting
21const workbook = new Excel.Workbook();
22const options = {
23  map(value, index) {
24    switch(index) {
25      case 0:
26        // column 1 is string
27        return value;
28      case 1:
29        // column 2 is a date
30        return dayjs(value).format('YYYY-MM-DD');
31      case 2:
32        // column 3 is a formula, write just the result
33        return value.result;
34      default:
35        // the rest are numbers
36        return value;
37    }
38  },
39  // https://c2fo.github.io/fast-csv/docs/formatting/options
40  formatterOptions: {
41    delimiter: '\t',
42    quote: false,
43  },
44};
45await workbook.csv.writeFile(filename, options);
46
47// write to a new buffer
48const buffer = await workbook.csv.writeBuffer();

The CSV parser uses fast-csv to write the CSV file. The formatterOptions in the options passed to the above write function will be passed to the @fast-csv/format module to write csv data. Please refer to the fast-csv README.md for details.

Dates are formatted using the npm module dayjs. If no dateFormat is supplied, dayjs.ISO_8601 is used. When writing a CSV you can supply the boolean dateUTC as true to have ExcelJS parse the date without automatically converting the timezone using dayjs.utc().

Streaming I/O⬆

The File I/O documented above requires that an entire workbook is built up in memory before the file can be written. While convenient, it can limit the size of the document due to the amount of memory required.

A streaming writer (or reader) processes the workbook or worksheet data as it is generated, converting it into file form as it goes. Typically this is much more efficient on memory as the final memory footprint and even intermediate memory footprints are much more compact than with the document version, especially when you consider that the row and cell objects are disposed once they are committed.

The interface to the streaming workbook and worksheet is almost the same as the document versions with a few minor practical differences:

Once a worksheet is added to a workbook, it cannot be removed.
Once a row is committed, it is no longer accessible since it will have been dropped from the worksheet.
unMergeCells() is not supported.

Note that it is possible to build the entire workbook without committing any rows. When the workbook is committed, all added worksheets (including all uncommitted rows) will be automatically committed. However in this case, little will have been gained over the Document version.

Streaming XLSX⬆

Streaming XLSX Writer(#contents)

The streaming XLSX workbook writer is available in the ExcelJS.stream.xlsx namespace.

The constructor takes an optional options object with the following fields:

Field	Description
stream	Specifies a writable stream to write the XLSX workbook to.
filename	If stream not specified, this field specifies the path to a file to write the XLSX workbook to.
useSharedStrings	Specifies whether to use shared strings in the workbook. Default is `false`.
useStyles	Specifies whether to add style information to the workbook. Styles can add some performance overhead. Default is `false`.
zip	Zip options that ExcelJS internally passes to Archiver. Default is `undefined`.

If neither stream nor filename is specified in the options, the workbook writer will create a StreamBuf object that will store the contents of the XLSX workbook in memory. This StreamBuf object, which can be accessed via the property workbook.stream, can be used to either access the bytes directly by stream.read() or to pipe the contents to another stream.

1// construct a streaming XLSX workbook writer with styles and shared strings
2const options = {
3  filename: './streamed-workbook.xlsx',
4  useStyles: true,
5  useSharedStrings: true
6};
7const workbook = new Excel.stream.xlsx.WorkbookWriter(options);

In general, the interface to the streaming XLSX writer is the same as the Document workbook (and worksheets) described above, in fact the row, cell and style objects are the same.

However there are some differences...

Construction

As seen above, the WorkbookWriter will typically require the output stream or file to be specified in the constructor.

Committing Data

When a worksheet row is ready, it should be committed so that the row object and contents can be freed. Typically this would be done as each row is added...

1worksheet.addRow({
2   id: i,
3   name: theName,
4   etc: someOtherDetail
5}).commit();

The reason the WorksheetWriter does not commit rows as they are added is to allow cells to be merged across rows:

1worksheet.mergeCells('A1:B2');
2worksheet.getCell('A1').value = 'I am merged';
3worksheet.getCell('C1').value = 'I am not';
4worksheet.getCell('C2').value = 'Neither am I';
5worksheet.getRow(2).commit(); // now rows 1 and two are committed.

As each worksheet is completed, it must also be committed:

1// Finished adding data. Commit the worksheet
2worksheet.commit();

To complete the XLSX document, the workbook must be committed. If any worksheet in a workbook are uncommitted, they will be committed automatically as part of the workbook commit.

1// Finished the workbook.
2await workbook.commit();
3// ... the stream has been written

Streaming XLSX Reader(#contents)

The streaming XLSX workbook reader is available in the ExcelJS.stream.xlsx namespace.

The constructor takes a required input argument and an optional options argument:

Argument	Description
input (required)	Specifies the name of the file or the readable stream from which to read the XLSX workbook.
options (optional)	Specifies how to handle the event types occuring during the read parsing.
options.entries	Specifies whether to emit entries (`'emit'`) or not (`'ignore'`). Default is `'emit'`.
options.sharedStrings	Specifies whether to cache shared strings (`'cache'`), which inserts them into the respective cell values, or whether to emit them (`'emit'`) or ignore them (`'ignore'`), in both of which case the cell value will be a reference to the shared string's index. Default is `'cache'`.
options.hyperlinks	Specifies whether to cache hyperlinks (`'cache'`), which inserts them into their respective cells, whether to emit them (`'emit'`) or whether to ignore them (`'ignore'`). Default is `'cache'`.
options.styles	Specifies whether to cache styles (`'cache'`), which inserts them into their respective rows and cells, or whether to ignore them (`'ignore'`). Default is `'cache'`.
options.worksheets	Specifies whether to emit worksheets (`'emit'`) or not (`'ignore'`). Default is `'emit'`.

1const workbookReader = new ExcelJS.stream.xlsx.WorkbookReader('./file.xlsx');
2for await (const worksheetReader of workbookReader) {
3  for await (const row of worksheetReader) {
4    // ...
5  }
6}

Please note that worksheetReader returns an array of rows rather than each row individually for performance reasons: https://github.com/nodejs/node/issues/31979

Iterating over all events(#contents)

Events on workbook are 'worksheet', 'shared-strings' and 'hyperlinks'. Events on worksheet are 'row' and 'hyperlinks'.

1const options = {
2  sharedStrings: 'emit',
3  hyperlinks: 'emit',
4  worksheets: 'emit',
5};
6const workbook = new ExcelJS.stream.xlsx.WorkbookReader('./file.xlsx', options);
7for await (const {eventType, value} of workbook.parse()) {
8  switch (eventType) {
9    case 'shared-strings':
10      // value is the shared string
11    case 'worksheet':
12      // value is the worksheetReader
13    case 'hyperlinks':
14      // value is the hyperlinksReader
15  }
16}

Readable stream(#contents)

While we strongly encourage to use async iteration, we also expose a streaming interface for backwards compatibility.

1const options = {
2  sharedStrings: 'emit',
3  hyperlinks: 'emit',
4  worksheets: 'emit',
5};
6const workbookReader = new ExcelJS.stream.xlsx.WorkbookReader('./file.xlsx', options);
7workbookReader.read();
8
9workbookReader.on('worksheet', worksheet => {
10  worksheet.on('row', row => {
11  });
12});
13
14workbookReader.on('shared-strings', sharedString => {
15  // ...
16});
17
18workbookReader.on('hyperlinks', hyperlinksReader => {
19  // ...
20});
21
22workbookReader.on('end', () => {
23  // ...
24});
25workbookReader.on('error', (err) => {
26  // ...
27});

Browser⬆

A portion of this library has been isolated and tested for use within a browser environment.

Due to the streaming nature of the workbook reader and workbook writer, these have not been included. Only the document based workbook may be used (see Create a Workbook for details).

For example code using ExcelJS in the browser take a look at the spec/browser folder in the github repo.

Prebundled⬆

The following files are pre-bundled and included inside the dist folder.

exceljs.js
exceljs.min.js

Value Types⬆

The following value types are supported.

Null Value⬆

Enum: Excel.ValueType.Null

A null value indicates an absence of value and will typically not be stored when written to file (except for merged cells). It can be used to remove the value from a cell.

E.g.

1worksheet.getCell('A1').value = null;

Merge Cell⬆

Enum: Excel.ValueType.Merge

A merge cell is one that has its value bound to another 'master' cell. Assigning to a merge cell will cause the master's cell to be modified.

Number Value⬆

Enum: Excel.ValueType.Number

A numeric value.

E.g.

1worksheet.getCell('A1').value = 5;
2worksheet.getCell('A2').value = 3.14159;

String Value⬆

Enum: Excel.ValueType.String

A simple text string.

E.g.

1worksheet.getCell('A1').value = 'Hello, World!';

Date Value⬆

Enum: Excel.ValueType.Date

A date value, represented by the JavaScript Date type.

E.g.

1worksheet.getCell('A1').value = new Date(2017, 2, 15);

Hyperlink Value⬆

Enum: Excel.ValueType.Hyperlink

A URL with both text and link value.

E.g.

1// link to web
2worksheet.getCell('A1').value = {
3  text: 'www.mylink.com',
4  hyperlink: 'http://www.mylink.com',
5  tooltip: 'www.mylink.com'
6};
7
8// internal link
9worksheet.getCell('A1').value = { text: 'Sheet2', hyperlink: '#\'Sheet2\'!A1' };

Formula Value⬆

Enum: Excel.ValueType.Formula

An Excel formula for calculating values on the fly. Note that while the cell type will be Formula, the cell may have an effectiveType value that will be derived from the result value.

Note that ExcelJS cannot process the formula to generate a result, it must be supplied.

Note that function semantic names must be in English and the separator must be a comma.

E.g.

1worksheet.getCell('A3').value = { formula: 'A1+A2', result: 7 };
2worksheet.getCell('A3').value = { formula: 'SUM(A1,A2)', result: 7 };

Cells also support convenience getters to access the formula and result:

1worksheet.getCell('A3').formula === 'A1+A2';
2worksheet.getCell('A3').result === 7;

Shared Formula⬆

Shared formulae enhance the compression of the xlsx document by decreasing the repetition of text within the worksheet xml. The top-left cell in a range is the designated master and will hold the formula that all the other cells in the range will derive from. The other 'slave' cells can then refer to this master cell instead of redefining the whole formula again. Note that the master formula will be translated to the slave cells in the usual Excel fashion so that references to other cells will be shifted down and to the right depending on the slave's offset to the master. For example: if the master cell A2 has a formula referencing A1 then if cell B2 shares A2's formula, then it will reference B1.

A master formula can be assigned to a cell along with the slave cells in its range

1worksheet.getCell('A2').value = {
2  formula: 'A1',
3  result: 10,
4  shareType: 'shared',
5  ref: 'A2:B3'
6};

A shared formula can be assigned to a cell using a new value form:

1worksheet.getCell('B2').value = { sharedFormula: 'A2', result: 10 };

This specifies that the cell B2 is a formula that will be derived from the formula in A2 and its result is 10.

The formula convenience getter will translate the formula in A2 to what it should be in B2:

1expect(worksheet.getCell('B2').formula).to.equal('B1');

Shared formulae can be assigned into a sheet using the 'fillFormula' function:

1// set A1 to starting number
2worksheet.getCell('A1').value = 1;
3
4// fill A2 to A10 with ascending count starting from A1
5worksheet.fillFormula('A2:A10', 'A1+1', [2,3,4,5,6,7,8,9,10]);

fillFormula can also use a callback function to calculate the value at each cell

1// fill A2 to A100 with ascending count starting from A1
2worksheet.fillFormula('A2:A100', 'A1+1', (row, col) => row);

Formula Type⬆

To distinguish between real and translated formula cells, use the formulaType getter:

1worksheet.getCell('A3').formulaType === Enums.FormulaType.Master;
2worksheet.getCell('B3').formulaType === Enums.FormulaType.Shared;

Formula type has the following values:

Name	Value
Enums.FormulaType.None	0
Enums.FormulaType.Master	1
Enums.FormulaType.Shared	2

Array Formula⬆

A new way of expressing shared formulae in Excel is the array formula. In this form, the master cell is the only cell that contains any information relating to a formula. It contains the shareType 'array' along with the range of cells it applies to and the formula that will be copied. The rest of the cells are regular cells with regular values.

Note: array formulae are not translated in the way shared formulae are. So if master cell A2 refers to A1, then slave cell B2 will also refer to A1.

E.g.

1// assign array formula to A2:B3
2worksheet.getCell('A2').value = {
3  formula: 'A1',
4  result: 10,
5  shareType: 'array',
6  ref: 'A2:B3'
7};
8
9// it may not be necessary to fill the rest of the values in the sheet

The fillFormula function can also be used to fill an array formula

1// fill A2:B3 with array formula "A1"
2worksheet.fillFormula('A2:B3', 'A1', [1,1,1,1], 'array');

Rich Text Value⬆

Enum: Excel.ValueType.RichText

Rich, styled text.

E.g.

1worksheet.getCell('A1').value = {
2  richText: [
3    { text: 'This is '},
4    {font: {italic: true}, text: 'italic'},
5  ]
6};

Boolean Value⬆

Enum: Excel.ValueType.Boolean

E.g.

1worksheet.getCell('A1').value = true;
2worksheet.getCell('A2').value = false;

Error Value⬆

Enum: Excel.ValueType.Error

E.g.

1worksheet.getCell('A1').value = { error: '#N/A' };
2worksheet.getCell('A2').value = { error: '#VALUE!' };

The current valid Error text values are:

Name	Value
Excel.ErrorValue.NotApplicable	#N/A
Excel.ErrorValue.Ref	#REF!
Excel.ErrorValue.Name	#NAME?
Excel.ErrorValue.DivZero	#DIV/0!
Excel.ErrorValue.Null	#NULL!
Excel.ErrorValue.Value	#VALUE!
Excel.ErrorValue.Num	#NUM!

Interface Changes⬆

Every effort is made to make a good consistent interface that doesn't break through the versions but regrettably, now and then some things have to change for the greater good.

0.1.0⬆

Worksheet.eachRow⬆

The arguments in the callback function to Worksheet.eachRow have been swapped and changed; it was function(rowNumber,rowValues), now it is function(row, rowNumber) which gives it a look and feel more like the underscore (_.each) function and priorities the row object over the row number.

Worksheet.getRow⬆

This function has changed from returning a sparse array of cell values to returning a Row object. This enables accessing row properties and will facilitate managing row styles and so on.

The sparse array of cell values is still available via Worksheet.getRow(rowNumber).values;

0.1.1⬆

cell.model⬆

cell.styles renamed to cell.style

0.2.44⬆

Promises returned from functions switched from Bluebird to native node Promise which can break calling code if they rely on Bluebird's extra features.

To mitigate this the following two changes were added to 0.3.0:

A more fully featured and still browser compatible promise lib is used by default. This lib supports many of the features of Bluebird but with a much lower footprint.
An option to inject a different Promise implementation. See Config section for more details.

Config⬆

ExcelJS now supports dependency injection for the promise library. You can restore Bluebird promises by including the following code in your module...

1ExcelJS.config.setValue('promise', require('bluebird'));

Please note: I have tested ExcelJS with bluebird specifically (since up until recently this was the library it used). From the tests I have done it will not work with Q.

Caveats⬆

Dist Folder⬆

Before publishing this module, the source code is transpiled and otherwise processed before being placed in a dist/ folder. This README identifies two files - a browserified bundle and minified version. No other contents of the dist/ folder are guaranteed in any way other than the file specified as "main" in the package.json

Known Issues⬆

Testing with Puppeteer⬆

The test suite included in this lib includes a small script executed in a headless browser to validate the bundled packages. At the time of this writing, it appears that this test does not play nicely in the Windows Linux subsystem.

For this reason, the browser test can be disabled by the existence of a file named .disable-test-browser

1sudo apt-get install libfontconfig

Splice vs Merge⬆

If any splice operation affects a merged cell, the merge group will not be moved correctly

Release History⬆

Version	Changes
0.0.9	Number Formats
0.1.0	Bug Fixes "<" and ">" text characters properly rendered in xlsx Better Column control Better Row control
0.1.1	Bug Fixes More textual data written properly to xml (including text, hyperlinks, formula results and format codes) Better date format code recognition Cell Font Style
0.1.2	Fixed potential race condition on zip write
0.1.3	Cell Alignment Style Row Height Some Internal Restructuring
0.1.5	Bug Fixes Now handles 10 or more worksheets in one workbook theme1.xml file properly added and referenced Cell Borders
0.1.6	Bug Fixes More compatible theme1.xml included in XLSX file Cell Fills
0.1.8	Bug Fixes More compatible theme1.xml included in XLSX file Fixed filename case issue Cell Fills
0.1.9	Bug Fixes Added docProps files to satisfy Mac Excel users Fixed filename case issue Fixed worksheet id issue Core Workbook Properties
0.1.10	Bug Fixes Handles File Not Found error CSV Files
0.1.11	Bug Fixes Fixed Vertical Middle Alignment Issue Row and Column Styles Worksheet.eachRow supports options Row.eachCell supports options New function Column.eachCell
0.2.0	Streaming XLSX Writer At long last ExcelJS can support writing massive XLSX files in a scalable memory efficient manner. Performance has been optimised and even smaller spreadsheets can be faster to write than the document writer. Options have been added to control the use of shared strings and styles as these can both have a considerable effect on performance Worksheet.lastRow Access the last editable row in a worksheet. Row.commit() For streaming writers, this method commits the row (and any previous rows) to the stream. Committed rows will no longer be editable (and are typically deleted from the worksheet object). For Document type workbooks, this method has no effect.
0.2.2	One Billion Cells Achievement Unlocked: A simple test using ExcelJS has created a spreadsheet with 1,000,000,000 cells. Made using random data with 100,000,000 rows of 10 cells per row. I cannot validate the file yet as Excel will not open it and I have yet to implement the streaming reader but I have every confidence that it is good since 1,000,000 rows loads ok.
0.2.3	Bug Fixes Merge Cell Styles Merged cells now persist (and parse) their styles. Streaming XLSX Writer At long last ExcelJS can support writing massive XLSX files in a scalable memory efficient manner. Performance has been optimised and even smaller spreadsheets can be faster to write than the document writer. Options have been added to control the use of shared strings and styles as these can both have a considerable effect on performance Worksheet.lastRow Access the last editable row in a worksheet. Row.commit() For streaming writers, this method commits the row (and any previous rows) to the stream. Committed rows will no longer be editable (and are typically deleted from the worksheet object). For Document type workbooks, this method has no effect.
0.2.4	Bug Fixes Worksheets with Ampersand Names Worksheet names are now xml-encoded and should work with all xml compatible characters Row.hidden & Column.hidden Rows and Columns now support the hidden attribute. Worksheet.addRows New function to add an array of rows (either array or object form) to the end of a worksheet.
0.2.6	Bug Fixes invalid signature: 0x80014: Thanks to hasanlussa for the PR Defined Names Cells can now have assigned names which may then be used in formulas. Converted Bluebird.defer() to new Bluebird(function(resolve, reject){}). Thanks to user Nishchit for the Pull Request
0.2.7	Data Validations Cells can now define validations that controls the valid values the cell can have
0.2.8	Rich Text Value Cells now support *in-cell* formatting - Thanks to Peter ADAM Fixed typo in README - Thanks to MRdNk Fixing emit in worksheet-reader - Thanks to Alan Gunning Clearer Docs - Thanks to miensol
0.2.9	Fixed "read property 'richText' of undefined error. Thanks to james075
0.2.10	Refactoring Complete. All unit and integration tests pass.
0.2.11	Outline Levels. Thanks to cricri for the contribution. Worksheet Properties Further refactoring of worksheet writer.
0.2.12	Sheet Views. Thanks to cricri again for the contribution.
0.2.13	Fix for exceljs might be vulnerable for regular expression denial of service. Kudos to yonjah and Josh Emerson for the resolution. Fix for Multiple Sheets opens in 'Group' mode in Excel. My bad - overzealous sheet view code. Also fix for empty sheet generating invalid xlsx.
0.2.14	Fix for exceljs might be vulnerable for regular expression denial of service. Kudos to yonjah and Josh Emerson for the resolution. Fixed Multiple Sheets opens in 'Group' mode in Excel again. Added Workbook views. Also fix for empty sheet generating invalid xlsx.
0.2.15	Added Page Setup Properties. Thanks to Jackkum for the PR
0.2.16	New Page Setup Property: Print Area
0.2.17	Merged Fix a bug on phonetic characters. This fixes an issue related to reading workbooks with phonetic text in. Note phonetic text is not properly supported yet - just properly ignored. Thanks to zephyrrider and gen6033 for the contribution.
0.2.18	Merged Fix regression #150: Stream API fails to write XLSX files. Apologies for the regression! Thanks to danieleds for the fix. Merged Fix a bug on phonetic characters. This fixes an issue related to reading workbooks with phonetic text in. Note phonetic text is not properly supported yet - just properly ignored. Thanks to zephyrrider and gen6033 for the contribution.
0.2.19	Merged Update xlsx.js #119. This should make parsing more resilient to open-office documents. Thanks to nvitaterna for the contribution.
0.2.20	Merged Changes from exceljs/exceljs#127 applied to latest version #179. Fixes parsing of defined name values. Thanks to agdevbridge and priitliivak for the contribution.
0.2.21	Merged color tabs for worksheet-writer #135. Modified the behaviour to print deprecation warning as tabColor has moved into options.properties. Thanks to ethanlook for the contribution.
0.2.22	Merged Throw legible error when failing Value.getType() #136. Thanks to wulfsolter for the contribution. Honourable mention to contributors whose PRs were fixed before I saw them: haoliangyu wulfsolter
0.2.23	Merged Fall back to JSON.stringify() if unknown Cell.Type #137 with some modification. If a cell value is assigned to an unrecognisable javascript object, the stored value in xlsx and csv files will be JSON stringified. Note that if the file is read again, no attempt will be made to parse the stringified JSON text. Thanks to wulfsolter for the contribution.
0.2.24	Merged Protect cell fix #166. This does not mean full support for protected cells merely that the parser is not confused by the extra xml. Thanks to jayflo for the contribution.
0.2.25	Added functions to delete cells, rows and columns from a worksheet. Modelled after the Array splice method, the functions allow cells, rows and columns to be deleted (and optionally inserted). See Columns and Rows for details. Note: Not compatible with cell merges
0.2.26	Merged Update border-xform.js #184Border edges without style will be parsed and rendered as no-border. Thanks to skumarnk2 for the contribution.
0.2.27	Merged Pass views to worksheet-writer #187. Now also passes views to worksheet-writer. Thanks to Temetz for the contribution. Merged Do not escape xml characters when using shared strings #189. Fixing bug in shared strings. Thanks to tkirda for the contribution.
0.2.28	Merged Fix tiny bug [Update hyperlink-map.js] #190Thanks to lszlkss for the contribution. Merged fix typo on sheet view showGridLines option #196 "showGridlines" should have been "showGridLines". Thanks to gadiaz1 for the contribution.
0.2.29	Merged Fire finish event instead of end event on write stream #199 and Listen for finish event on zip stream instead of middle stream #200. Fixes issues with stream completion events. Thanks to junajan for the contribution.
0.2.30	Merged Fix issue #178 #201. Adds the following properties to workbook: title subject keywords category description company manager Thanks to stavenko for the contribution.
0.2.31	Merged Fix issue #163: the "spans" attribute of the row element is optional #203. Now xlsx parsing will handle documents without row spans. Thanks to arturas-vitkauskas for the contribution.
0.2.32	Merged Fix issue 206 #208. Fixes issue reading xlsx files that have been printed. Also adds "lastPrinted" property to Workbook. Thanks to arturas-vitkauskas for the contribution.
0.2.33	Merged Allow styling of cells with no value. #210. Includes Null type cells with style in the rendering parsing. Thanks to oferns for the contribution.
0.2.34	Merged Fix "Unexpected xml node in parseOpen" bug in LibreOffice documents for attributes dc:language and cp:revision #212. Thanks to jessica-jordan for the contribution.
0.2.35	Fixed Getting a column/row count #74. Worksheet now has rowCount and columnCount properties (and actual variants), Row has cellCount.
0.2.36	Merged Stream reader fixes #217. Thanks to kturney for the contribution.
0.2.37	Merged Fix output order of Sheet Properties #225. Thanks to keeneym for the contribution. Merged remove empty worksheet[0] from _worksheets #231. Thanks to pookong for the contribution. Merged do not skip empty string in shared strings so that indexes match #232. Thanks again to pookong for the contribution. Merged use shared strings for streamed writes #233. Thanks again to pookong for the contribution.
0.2.38	Merged Add a comment for issue #216 #236. Thanks to jsalwen for the contribution. Merged Start on support for 1904 based dates #237. Fixed date handling in documents with the 1904 flag set. Thanks to holm for the contribution.
0.2.39	Merged Stops Bluebird warning about unreturned promise #245. Thanks to robinbullocks4rb for the contribution. Merged Added missing dependency: col-cache.js #247. Thanks to Manish2005 for the contribution.
0.2.42	Browser Compatible! Well mostly. I have added a browser sub-folder that contains a browserified bundle and an index.js that can be used to generate another. See Browser section for details. Fixed corrupted theme.xml. Apologies for letting that through. Merged [BUGFIX] data validation formulae undefined #253. Thanks to jayflo for the contribution.
0.2.43	Merged added a (maybe partial) solution to issue 99. i wasn't able to create an appropriate test #255. This fixes Too few data or empty worksheet generate malformed excel file #99. Thanks to mminuti for the contribution.
0.2.44	Reduced Dependencies. Goodbye lodash, goodbye bluebird. Minified bundle is now just over half what it was in the first version.
0.2.45	Merged Sheets with hyperlinks and data validations are corrupted #256. Thanks to simon-stoic for the contribution.
0.2.46	Merged Exclude character controls from XML output. Fixes #234 #262. Thanks to holm for the contribution. Merged Add support for identifier #259. This fixes Broken XLSX because of "vertical tab" ascii character in a cell #234. Thanks to NOtherDev for the contribution.
0.3.0	Addressed Breaking change removing bluebird #266. Appologies for any inconvenience. Added Promise library dependency injection. See Config section for more details.
0.3.1	Merged Update dependencies #279. Thanks to holm for the contribution. Merged Minor fixes for stream handling #267. Thanks to holm for the contribution. Added automated tests in phantomjs for the browserified code.
0.4.0	Fixed issue Boolean cell with value ="true" is returned as 1 #278. The fix involved adding two new Call Value types: Boolean Value Error Value Note: Minor version has been bumped up to 4 as this release introduces a couple of interface changes: Boolean cells previously will have returned 1 or 0 will now return true or false Error cells that previously returned a string value will now return an error structure Fixed issue Code correctness - setters don't return a value #280. Addressed issue v0.3.1 breaks meteor build #288.
0.4.1	Merged Add support for cp:contentStatus #285. Thanks to holm for the contribution. Merged Fix Valid characters in XML (allow \n and \r when saving) #286. Thanks to Rycochet for the contribution. Fixed hyperlink with query arguments corrupts workbook #275. The hyperlink target is not escaped before serialising in the xml.
0.4.2	Addressed the following issues: White text and borders being changed to black #290 Losing formatting/pivot table from loaded file #261 Solid fill become black #272 These issues are potentially caused by a bug that caused colours with zero themes, tints or indexes to be rendered and parsed incorrectly. Regarding themes: the theme files stored inside the xlsx container hold important information regarding colours, styles etc and if the theme information from a loaded xlsx file is lost, the results can be unpredictable and undesirable. To address this, when an ExcelJS Workbook parses an XLSX file, it will preserve any theme files it finds and include them when writing to a new XLSX. If this behaviour is not desired, the Workbook class exposes a clearThemes() function which will drop the theme content. Note that this behaviour is only implemented in the document based Workbook class, not the streamed Reader and Writer.
0.4.3	Merged Support error references in cell ranges #294. Thanks to holm for the contribution.
0.4.4	Merged Issue with copied cells #297. This merge adds support for shared formulas. Thanks to muscapades for the contribution.
0.4.6	Merged Correct spelling #304. Thanks to toanalien for the contribution. Merged Added support for auto filters #306. This adds Auto Filters to the Worksheet. Thanks to C4rmond4i for the contribution. Restored NodeJS 4.0.0 compatability by removing the destructuring code. My apologies for any inconvenience.
0.4.9	Switching to transpiled code for distribution. This will ensure compatability with 4.0.0 and above from here on. And it will also allow use of much more expressive JS code in the lib folder! Basic Image Support!Images can now be added to worksheets either as a tiled background or stretched over a range. Note: other features like rotation, etc. are not supported yet and will reqeuire further work.
0.4.10	Merged Add missing Office Rels #319. Thanks goes to mauriciovillalobos for the contribution. Merged Add printTitlesRow Support #320 Thanks goes to psellers89 for the contribution.
0.4.11	Merged Avoid error on anchor with no media #327. Thanks goes to holm for the contribution. Merged Assortment of fixes for streaming read #332. Thanks goes to holm for the contribution.
0.4.12	Merged Don’t set address if hyperlink r:id is undefined #334. Thanks goes to holm for the contribution.
0.4.13	Merged Issue 296 #343. This fixes Issue with writing newlines #296. Thanks goes to holly-weisser for the contribution.
0.4.14	Merged Syntax highlighting added ✨ #350. Thanks goes to rmariuzzo for the contribution.
0.5.0	Merged Fix right to left issues #356. Fixes Add option to RTL file #72 and Adding an option to set RTL worksheet #126. Big thank you to alitaheri for this contribution.
0.5.1	Merged Fix #345 TypeError: Cannot read property 'date1904' of undefined #364. This fixes TypeError: Cannot read property 'date1904' of undefined #345. Thanks to Diluka for this contribution.
0.6.0	Merged Add rowBreaks feature. #389. Thanks to brucejo75 for this contribution.
0.6.1	Merged Guard null model fields - fix and tests #403. Thanks to thecjharries for this contribution. Also thanks to Ryc O'Chet for help with reviewing.
0.6.2	Merged Add some comments in readme according csv importing #396. Thanks to Michael Lelyakin for this contribution. Also thanks to planemar for help with reviewing. This also closes csv to stream doesn't work #395.
0.7.0	Merged Impl <xdr:twoCellAnchor editAs=oneCell> #407. Thanks to Ocke Janssen and Kay Ramme for this contribution. This change allows control on how images are anchored to cells.
0.7.1	Merged Don't break when attempting to import a zip file that's not an Excel file (eg. .numbers) #423. Thanks to Andreas Lind for this contribution. This change makes exceljs more reslilient when opening non-excel files. Merged Fixes #419 : Updates readme. #434. Thanks to Vishnu Kyatannawar for this contribution. Merged Don't break when docProps/core.xml contains a <cp:version> tag #436. Thanks to Andreas Lind for this contribution. This change handles core.xml files with empty version tags.
0.8.0	Merged Add Base64 Image support for the .addImage() method #442. Thanks to James W Mann for this contribution. Merged update moment to 2.19.3 #453. Thanks to Markan Patel for this contribution.
0.8.1	Merged Additional information about font family property #457. Thanks to kayakyakr for this contribution. Merged Fixes #458 #459. This fixes Add style to column causes it to be hidden #458. Thanks to Alexander James Phillips for this contribution.
0.8.2	Merged Don't break when loading an Excel file containing a chartsheet #466. Thanks to Andreas Lind for this contribution. Merged Hotfix/sheet order#257 #471. This fixes Sheet Order #257. Thanks to Robbi for this contribution.
0.8.3	Assimilated fix #79 outdated dependencies in unzip2. Thanks to Jules Sam. Randolph for starting this fix and a really big thanks to Alexander Kachkaev for finding the final solution.
0.8.4	Merged Round Excel date to nearest millisecond when converting to javascript date #479. Thanks to Benoit Jean for this contribution.
0.8.5	Merged Bug fix: wb.worksheets/wb.eachSheet caused getWorksheet(0) to return sheet #485. Thanks to mah110020 for this contribution.
0.9.0	Merged Feature/issue 424 #489. This fixes No way to control summaryBelow or summaryRight #424. Many thanks to Sarah for this contribution.
0.9.1	Merged add type definition #490. This adds type definitions to ExcelJS! Many thanks to taoqf for this contribution.
1.0.0	Merged Add Node 8 and Node 9 to continuous integration testing #494. Many thanks to Markan Patel for this contribution. Merged Small README fix #508. Many thanks to Guilherme Bernal for this contribution. Merged Add support for inlineStr, including rich text #501. Many thanks to linguamatics-pdenes and Rob Scott for their efforts towards this contribution. Since this change is technically a breaking change (the rendered XML for inline strings will change) I'm making this a major release!
1.0.1	Fixed spliceColumns problem when the number of columns are important #520.
1.0.2	Merged Loosen exceljs's dependency requirements for moment #524. Many thanks to nicoladefranceschi for this contribution. This change addresses Ability to use external "moment" package #517.
1.1.0	Addressed Is there a way inserting values in columns. #514. Added a new getter/setter property to Column to get and set column values (see Columns for details).
1.1.1	Merged Include index.d.ts in published packages #532. To fix TypeScript definitions missing from npm package #525. Many thanks to Kagami Sascha Rosylight for this contribution.
1.1.2	Merged Don't break when docProps/core.xml contains <cp:contentType /> #536. Many thanks to Andreas Lind (and reviewers) for this contribution.
1.1.3	Merged Try to handle the case where a <c> element is missing an r attribute #537. Many thanks to Andreas Lind for this contribution.
1.2.0	Merged Add dateUTC flag to CSV Writing #544. Many thanks to Zackery Griesinger for this contribution.
1.2.1	Merged worksheet name is writable #547. Many thanks to xzper for this contribution.
1.3.0	Merged Add CSV write buffer support #549. Many thanks to Jarom Loveridge for this contribution.
1.4.2	Merged Discussion: Customizable row/cell limit #541. Many thanks to Andreas Lind for this contribution.
1.4.3	Merged Get the right text out of hyperlinked formula cells #552. Many thanks to Andreas Lind and Christian Holm for this contribution.
1.4.5	Merged Add test case with a huge file #556. Many thanks to Andreas Lind and Christian Holm for this contribution.
1.4.6	Merged Update README.md to reflect correct functionality of row.addPageBreak() #557. Many thanks to RajDesai for this contribution. Merged fix index.d.ts #558. Many thanks to Diluka for this contribution.
1.4.7	Merged List /xl/sharedStrings.xml in [Content_Types].xml only if one of the … #562. Many thanks to Priidik Vaikla for this contribution.
1.4.8	Merged List /xl/sharedStrings.xml in [Content_Types].xml only if one of the … #562. Many thanks to Priidik Vaikla for this contribution. Fixed issue with above where shared strings were used but the content type was not added.
1.4.9	Merged List /xl/sharedStrings.xml in [Content_Types].xml only if one of the … #562. Many thanks to Priidik Vaikla for this contribution. Fixed issue with above where shared strings were used but the content type was not added. Fixed issue 1.4.8 broke writing Excel files with useSharedStrings:true #581.
1.4.10	Merged core-xform: Tolerate a missing cp: namespace for the coreProperties element #564. Many thanks to Andreas Lind for this contribution.
1.4.12	Merged Avoid error on malformed address #567. Many thanks to Andreas Lind for this contribution. Merged Added a missing Promise<void> in index.d.ts #571. Many thanks to Gabriel Fournier for this contribution. This release should fix Is workbook.commit() still a promise or not #548
1.4.13	Merged Issue #488 #574. Many thanks to dljenkins for this contribution. This release should fix Invalid time value Exception #488.
1.5.0	Merged Sheet add state for hidden or show #577. Many thanks to Freddie Hsinfu Huang for this contribution. This release should fix hide worksheet and reorder sheets #226.
1.5.1	Merged Update index.d.ts #582. Many thanks to hankolsen for this contribution. Merged Decode the x<4 hex chars> escape notation in shared strings #584. Many thanks to Andreas Lind for this contribution.
1.6.0	Added .html property to Cells to facilitate html-safe rendering. See Handling Individual Cells for details.
1.6.1	Merged Fix Issue #488 where dt is an invalid date format. #587 to fix Invalid time value Exception #488. Many thanks to Iliya Zubakin for this contribution.
1.6.2	Merged Fix Issue #488 where dt is an invalid date format. #587 to fix Invalid time value Exception #488. Many thanks to Iliya Zubakin for this contribution. Merged drawing element must be below rowBreaks according to spec or corrupt worksheet #590 Many thanks to Liam Neville for this contribution.
1.6.3	Merged set type optional #595 Many thanks to taoqf for this contribution. Merged Fix some xlsx stream read xlsx not in guaranteed order problem #578 Many thanks to KMethod for this contribution. Merged Fix formatting issue in README #599 Many thanks to Vishnu Kyatannawar for this contribution.
1.7.0	Merged Ability to set tooltip for hyperlink #602 Many thanks to Kuznetsov Aleksey for this contribution.
1.8.0	Merged Fix misinterpreted ranges from <definedName> #636 Many thanks to Andreas Lind for this contribution. Merged Add LGTM code quality badges #640 Many thanks to Xavier RENE-CORAIL for this contribution. Merged Add type definition for Column.values #646 Many thanks to Emil Laine for this contribution. This fixes Column.values is missing TypeScript definitions #645. Merged Update README.md with load() option #663 Many thanks to Joanna Walker for this contribution. Merged fixed packages according to npm audit #677 Many thanks to Manuel Minuti for this contribution. Merged Update index.d.ts #699 Many thanks to Ray Yen for this contribution. Merged Replaced node-unzip-2 to unzipper package which is more robust #708 Many thanks to johnmalkovich100 for this contribution. Merged Read worksheet hidden state #728 Many thanks to Dishu(Lester) Lyu for this contribution. Merged add Worksheet.state typescript definition fix #714 #736 Many thanks to Ilyes Kechidi for this contribution. This fixes Worksheet State does not exist in index.d.ts #714.
1.9.0	Merged Improvements for images (correct reading/writing possitions) #702. This fixes Image location don't respect Column width #650 and Image position - stretching image #467. Many thanks to Siemienik Paweł for this contribution.
1.9.1	Merged Add Typescript support for formulas without results #619. Many thanks to Loursin for this contribution. Merged Fix existing row styles when using spliceRows #737. Many thanks to cxam for this contribution. Merged Consistent code quality #774. Many thanks to Andreas Lubbe for this contribution.
1.10.0	Fixed effect of splicing rows and columns on defined names Merged Add support for adding images anchored to one cell #746. Many thanks to Karl von Randow for this contribution. Merged Add vertical align property #758. Many thanks to MikeZyatkov for this contribution. Merged Replace the temp lib to tmp #775. Many thanks to Ivan Sotnikov for this contribution. Merged Replace the temp lib to tmp #775. Many thanks to Andreas Lubbe for this contribution. Merged Update Worksheet.dimensions return type #793. Many thanks to Siemienik Paweł for this contribution. Merged One more types fix #795. Many thanks to Siemienik Paweł for this contribution.
1.11.0	Merged Add the ability to bail out of parsing if the number of columns exceeds a given limit #776. Many thanks to Andreas Lind for this contribution. Merged Add support for repeated columns on every page when printing. #799. Many thanks to Jasmin Auger for this contribution. Merged Do not use a promise polyfill on modern setups #815. Many thanks to Andreas Lubbe for this contribution. Merged copy LICENSE to the dist folder #807. Many thanks to Yuping Zuo for this contribution. Merged Avoid unhandled rejection on XML parse error #813. Many thanks to Andreas Lind for this contribution.
1.12.0	Merged (chore) increment unzipper to 0.9.12 to address npm advisory 886 #819. Many thanks to Kreig Zimmerman for this contribution. Merged docs(README): improve docs #817. Many thanks to Yuping Zuo for this contribution. Merged add comment support #529 #823. Many thanks to ilimei for this contribution. This fixes the following issues: Is it possible to add comment on a cell? #202 Add comment to cell #451 Excel add comment on cell #503 How to add Cell comment #529 Please add example to how I can insert comments for a cell #707
1.12.1	Merged fix issue with print area defined name corrupting file #822. Many thanks to Julia Donaldson for this contribution. This fixes issue Defined Names Break/Corrupt Excel File into Repair Mode #664. Merged Only keep at most 31 characters for sheetname #831. Many thanks to Xuebin He for this contribution. This fixes issue Limit worksheet name length to 31 characters #398.
1.12.2	Merged add cn doc #834 and update cn doc #852. Many thanks to flydragon for this contribution. Merged fix minor spelling mistake in readme #853. Many thanks to John Varga for this contribution. Merged Fix defaultRowHeight not working #855. Many thanks to autukill for this contribution. This should fix row height doesn't apply to row #422, The worksheet.properties.defaultRowHeight can't work!! How to set the rows height, help!! #634 and Default row height doesn't work ? #696. Merged Always keep first font #854. Many thanks to Dmitriy Gusev for this contribution. This should fix document scale (width only) is different after read & write #816, Default font from source document can not be parsed. #833 and Wrong base font: hardcoded Calibri instead of font from the document #849.
1.13.0	Merged zip: allow tuning compression for performance or size #862. Many thanks to myfreeer for this contribution. Merged Feat configure headers and footers #863. Many thanks to autukill for this contribution. Fixed an issue with defaultRowHeight where the default value resulted in 'customHeight' property being set.
1.14.0	Merged Fix header and footer text format error in README.md #874. Many thanks to autukill for this contribution. Added Tables. See Tables for details. Merged fix: #877 and #880. Many thanks to Alexander Heinrich for this contribution. This fixes bug: Hyperlink without text crashes write #877 and bug: malformed comment crashes on write #880
1.15.0	Merged Add Compression level option to WorkbookWriterOptions for streaming #889. Many thanks to Alfredo Benassi for this contribution. Merged Feature/Cell Protection #903 and Feature/Sheet Protection #907. Many thanks to karabaesh for these contributions.
2.0.1	Major Version Change Introducing async/await to ExcelJS! The new async and await features of JavaScript can help a lot to make code more readable and maintainable. To avoid confusion, particularly with returned promises from async functions, we have had to remove the Promise class configuration option and from v2 onwards ExcelJS will use native Promises. Since this is potentially a breaking change we're bumping the major version for this release. Changes Merged Introduce async/await #829. Many thanks to Andreas Lubbe for this contribution. Merged Update index.d.ts #930. Many thanks to cosmonovallc for this contributions. Merged TS: Add types for addTable function #940. Many thanks to egmen for this contributions. Merged added explicit return types to the type definitions of Worksheet.protect() and Worksheet.unprotect() #926. Many thanks to Tamas Czinege for this contributions. Dropped dependencies on Promise libraries.
3.0.0	Another Major Version Change Javascript has changed a lot over the years, and so have the modules and technologies surrounding it. To this end, this major version of ExcelJS changes the structure of the publish artefacts: Main Export is now the Original Javascript Source Prior to this release, the transpiled ES5 code was exported as the package main. From now on, the package main comes directly from the lib/ folder. This means a number of dependencies have been removed, including the polyfills. ES5 and Browserify are Still Included In order to support those that still require ES5 ready code (e.g. as dependencies in web apps) the source code will still be transpiled and available in dist/es5. The ES5 code is also browserified and available as dist/exceljs.js or dist/exceljs.min.js See the section Importing for details
3.1.0	Merged Uprev fast-csv to latest version which does not use unsafe eval #873. Many thanks to Mike Townsend for this contribution. Merged Exclude Infinity on createInputStream #906. Many thanks to Sophie Kwon for this contribution. Merged Feature/Add comments/notes to stream writer #911. Many thanks to brunoargolo for this contribution. This fixes Can't add cell comment using streaming WorkbookWriter #868 Fixed an issue with reading .xlsx files containing notes. This should resolve the following issues: Reading comment/note from xlsx #941 Excel.js doesn't parse comments/notes. #944
3.2.0	Merged Add document for zip options of streaming WorkbookWriter #923. Many thanks to Soichi Takamura for this contribution. Merged array formula #933. Many thanks to yoann-antoviaque for this contribution. This fixes broken array formula #932 and adds Array Formulae to ExcelJS.
3.3.0	Merged Fix anchor.js #892. Many thanks to Wojciech Wojtkowski for this contribution. Merged add xml:space="preserve" for all whitespaces #896. Many thanks to Sebastian Keller for this contribution. Merged Add `shrinkToFit` to document and typing #959. Many thanks to ('3') for this contribution. This fixes shrinkToFit property not on documentation #943. Merged #951: Force formula re-calculation on file open from Excel #980. Many thanks to zymon for this contribution. This fixes Force formula re-calculation on file open from Excel #951. Fixed Lib contains class syntax, not compatible with IE11 #989.
3.3.1	Merged Add headerFooter to worksheet model when importing from file #1000. Many thanks to Kaiichiro Ota for this contribution. Merged Update eslint plugins and configs #1005, Drop grunt-lib-phantomjs #1006 and Rename .browserslintrc.txt to .browserslistrc #1007. Many thanks to Takeshi Kurosawa for this contribution. Merged Fix issue #988 #1012. This fixes Can not read excel file #988. Many thanks to Todd Hambley for this contribution.
3.4.0	Merged Feature/stream writer add background images #1016. Many thanks to brunoargolo for this contribution. Merged Fix issue # 991 #1019. This fixes read csv file issue #991. Many thanks to Nathaniel J. Liberty for this contribution. Merged Large excels - optimize performance of writing file by excelJS + optimize generated file (MS excel opens it much faster) #1018. Many thanks to Piotr for this contribution.
3.5.0	Conditional Formatting A subset of Excel Conditional formatting has been implemented! Specifically the formatting rules that do not require XML to be rendered inside an <extLst> node, or in other words everything except databar and three icon sets (3Triangles, 3Stars, 5Boxes). These will be implemented in due course Merged remove core-js/ import #1030. Many thanks to jeffrey n. carre for this contribution. This change is used to create a new browserified bundle artefact that does not include any polyfills. See Browserify for details.
3.6.0	Merged 1041 multiple print areas #1042. Many thanks to Alexander Pruss for this contribution. Merged fix typings for cell.note #1058. Many thanks to xydens for this contribution. Conditional Formatting has been completed. The <extLst> conditional formattings including dataBar and the three iconSet types (3Triangles, 3Stars, 5Boxes) are now available.
3.6.1	Merged Clarify merging cells by row/column numbers #1047. Many thanks to Kendall Roth for this contribution. Merged Fix README mistakes concerning freezing views #1048. Many thanks to overlookmotel for this contribution. Merged: fix issue #1045 horizontalCentered & verticalCentered in page not working #1073 Fix the problem of anchor failure of readme_zh.md file #1082 Fix problems caused by case of worksheet names #1065 Many thanks to Alan Wang for this contribution.
3.7.0	Merged Fix Issue #1075: Unable to read/write defaultColWidth attribute in <sheetFormatPr> node #1076. Many thanks to Kaiichiro Ota for this contribution. Merged function duplicateRows added #1078 and Duplicate rows #1088. Many thanks to cbeltrangomez84 for this contribution. Merged Prevent from unhandled promise rejection durning workbook load #1087. Many thanks to Wojtek for this contribution. Merged fix issue #899 Support for inserting pictures with hyperlinks #1071. Many thanks to Alan Wang for this contribution. Merged Update TS definition to reference proper internal libraries #1089. Many thanks to Jesse Kawell for this contribution.
3.8.0	Merged Issue/Corrupt workbook using stream writer with background image #1090. Many thanks to brunoargolo for this contribution. Merged Fix index.d.ts #1092. Many thanks to Siemienik Paweł for this contribution. Merged Wait for writing to tmp fiels before handling zip stream close #1093. Many thanks to Wojtek for this contribution. Merged Support ArrayBuffer as an xlsx.load argument #1095. Many thanks to Wojtek for this contribution. Merged Export shared strings with RichText #1099. Many thanks to Kaiichiro Ota for this contribution. Merged Keep borders of merged cells after rewriting an Excel workbook #1102. Many thanks to Kaiichiro Ota for this contribution. Merged Fix #1103: `editAs` not working #1104. Many thanks to Alan Wang for this contribution. Merged Fix to issue #1101 #1105. Many thanks to Carlos Andres Beltran Gomez for this contribution. Merged fix some errors and typos in readme #1107. Many thanks to Alan Wang for this contribution. Merged Update issue templates #1112. Many thanks to Siemienik Paweł for this contribution.
3.8.1	Merged Update issue templates #1112. Many thanks to Siemienik Paweł for this contribution. Merged Typo: Replace 'allways' with 'always' #1124. Many thanks to Siemienik Paweł for this contribution. Merged Replace uglify with terser #1125. Many thanks to Andreas Lubbe for this contribution. Merged Apply codestyles on each commit and run lint:fix #1126. Many thanks to Andreas Lubbe for this contribution. Merged [WIP] Replace sax with saxes #1127. Many thanks to Andreas Lubbe for this contribution. Merged Add PR, Feature Request and Question github templates #1128. Many thanks to Andreas Lubbe for this contribution. Merged fix issue #749 Fix internal link example errors in readme #1137. Many thanks to Alan Wang for this contribution.
3.8.2	Merged Update @types/node version to latest lts #1133. Many thanks to Siemienik Paweł for this contribution. Merged fix issue #1118 Adding Data Validation and Conditional Formatting to the same sheet causes corrupt workbook #1134. Many thanks to Alan Wang for this contribution. Merged Add benchmarking #1139. Many thanks to Andreas Lubbe for this contribution. Merged fix issue #731 image extensions not be case sensitive #1148. Many thanks to Alan Wang for this contribution. Merged fix issue #1165 and update index.d.ts #1169. Many thanks to Alan Wang for this contribution.
3.9.0	Merged Optimize SAXStream #1140. Many thanks to Andreas Lubbe for this contribution. Merged fix issue #1057 Fix addConditionalFormatting is not a function error when using Streaming XLSX Writer #1143. Many thanks to Alan Wang for this contribution. Merged fix issue #204 sets default column width #1160. Many thanks to Alan Wang for this contribution. Merged Include cell address for Shared Formula master must exist.. error #1164. Many thanks to Brad Reed for this contribution. Merged Typo in DataValidation examples #1166. Many thanks to Matthieu Ravey for this contribution. Merged fixes #1175 #1176. Many thanks to Siemienik Paweł for this contribution. Merged fix issue #1178 and update index.d.ts #1179. Many thanks to Alan Wang for this contribution. Merged Simple test if typescript is able to compile #1182. Many thanks to Siemienik Paweł for this contribution. Merged More improvements #1190. Many thanks to Andreas Lubbe for this contribution. Merged Ensure all node_modules are compatible with IE11 #1193. Many thanks to Andreas Lubbe for this contribution. Merged fix issue #1194 and update index.d.ts #1199. Many thanks to Alan Wang for this contribution. This fixes [BUG] TypeScript version doesn't have definition for Worksheet.addConditionalFormatting #1194. Merged fix issue #1157 marked Cannot set property #1204. Many thanks to Alan Wang for this contribution. This fixes [BUG] Cannot set property 'marked' of undefined #1157. Merged Deprecate createInputStream #1209. Many thanks to Andreas Lubbe for this contribution. Merged fix issue #1206 #1205 Abnormality of and attributes #1210. Many thanks to Alan Wang for this contribution. This fixes [BUG] Unlocked cells do not maintain their unlocked status after reading and writing a workbook. #1205 and [BUG] Unlocked cells lose their vertical and horizontal alignment after a read and write. #1206.
3.10.0	Merged [Chore] Upgrade dependencies #1233. Many thanks to Andreas Lubbe for this contribution. Merged Fix issue #1198 Absolute path and relative path need to be compatible #1220. Many thanks to Alan Wang for this contribution. This fixes [BUG] Loading OpenPyXL workbooks #1198. Merged Upgrade tmp #1234. Many thanks to Andreas Lubbe for this contribution. This fixes Process doesn't exit < 8.12.0 #882. Merged New version of dayjs requires explicit `Z` in the date formats #1270. Many thanks to Andreas Lubbe for this contribution. Merged Fixed #1276 #1280. Many thanks to Subhajit Das for this contribution. This fixes [BUG] Invalid regular expression: /^[ -íŸ¿î€€-ï¿½ð€€-ô¿¿]$/: Range out of order in character class #1276. Merged [bugfix] Fix special cell values causing invalid files produced #1278. Many thanks to Alan Wang for this contribution. This fixes Special cell value results invalid file #703. Merged Re-translation of simplified Chinese documents (zh-cn) #1208. Many thanks to 不如怀念 for this contribution. Merged data-validations-xform: keep formulae if type not exists #1229. Many thanks to myfreeer for this contribution. Merged WorkbookWriter support rowBreaks #1257. Many thanks to Alan Wang for this contribution. This fixes [BUG] WorkbookWriter doesn't support headerFooter and rowBreaks. #1248. Merged Fixed ascii only #1289. Many thanks to Subhajit Das for this contribution. Merged Supports setting cell comment properties #1159. Many thanks to Alan Wang for this contribution. Merged docs: add links to top with jump2header #1215. Many thanks to Dragoș Străinu for this contribution. Merged Fix cell.text return an empty object when cell is empty #1310. Many thanks to Alan Wang for this contribution. Merged Use rest args instead of slicing arguments #1303. Many thanks to Andreas Lubbe for this contribution.
4.0.1	A Major Version Change - The main ExcelJS interface has been migrated from streams based API to Async Iterators making for much cleaner code. While technically a breaking change, most of the API is unchanged For details see UPGRADE-4.0.md. This upgrade has come from the following merges: [MAJOR VERSION] Async iterators #1135 [MAJOR VERSION] Move node v8 support to ES5 imports #1142 A lot of work from the team went into this - in particular Andreas Lubbe and Siemienik Paweł.
4.1.0	Merged Remove const enum and add ErrorValue in index.d.ts #1317 Many thanks to Alex Plumley for this contribution. Merged update README.md and READEME_zh.md #1319 Many thanks to Alan Wang for this contribution. Merged Added insert rows functionality with new style inherit options #1324 Many thanks to Subhajit Das for this contribution. Merged Updated readme for insert rows #1327 Many thanks to Subhajit Das for this contribution. Merged Fix: Async iterators definition #1338 Many thanks to Julien - JuH for this contribution. Merged [bugfix] Fix special cell values causing invalid files produced(#1339) #1344. This fixes [BUG] hasOwnProperty, constructor special words not serialized correctly with stream.xlsx.WorkbookWriter #1339. Many thanks to Alan Wang for this contribution. Merged Fix the error that comment does not delete at spliceColumn #1334. Many thanks to sdg9670 for this contribution. Merged bug fix can not read property date1904 of undefined #1328. Many thanks to 1328 for this contribution.
4.1.1	Merged update index.d.ts #1356 Many thanks to Siemienik Paweł for this contribution. Merged Fix styleOption error in index.ts #1358. This fixes [BUG] 4.1.0 causes TypeScript compilation errors - addRows styleOption should be optional? #1357. Many thanks to sdg9670 for this contribution. Merged Improved documentation #1354 Many thanks to Subhajit Das for this contribution.
4.2.0	Merged Fix issue #1431 Streaming WorkbookReader _parseSharedStrings doesn't handle rich text within shared string nodes #1432. Many thanks to Reza Heidari for this contribution. Merged Change typing for colorScale colour to array of colours #1442. Many thanks to Leondro Lio for this contribution. Merged AddRow/s and InsertRow/s now returning the newly added rows #1443. Many thanks to Subhajit Das for this contribution. Merged fix docs #1475. Many thanks to Dmytro Kyba for this contribution. Merged [bugfix]Fix Issue #1254 and update index.d.ts #1360. This should fix [BUG] getSheetValues() typescript definition is incorrect #1254. Many thanks to Alan Wang for this contribution. Merged Fix issue #1261 WorkbookWriter sheet.protect() function doesn't exist #1262. This should fix [BUG] WorkbookWriter sheet.protect() function doesn't exist #1261. Many thanks to Reza Heidari for this contribution. Merged README: images not supported in streaming mode #1405. Many thanks to Christian d'Heureuse for this contribution. Merged Run linter with prettier 2 #1477. Many thanks to Andreas Lubbe for this contribution. Merged Increase the performance of some xml and html helpers #1476. Many thanks to Andreas Lubbe for this contribution. Merged Performance improvement in col-cache #1482. Many thanks to Kevin Kwok for this contribution. Merged Fix type definition for DefinedNamesRanges #1481. Many thanks to Kevin Kwok for this contribution. Merged Fixed undefined ref error when setting a data validation that is a range of cells at the worksheet level #1480. Many thanks to Bene-Graham for this contribution. Merged add A3 paperSize number #1485. This should fix [F] The printing size can be set to A3 #1406. Many thanks to skypesky for this contribution. Merged Fix #1364 Incorrect Worksheet Name on Streaming XLSX Reader #1478. This should fix [BUG] Incorrect Worksheet Name on Streaming XLSX Reader #1364. Many thanks to Kevin Kwok for this contribution. Merged grunt: skip babel transpile for core-js #1466. Many thanks to myfreeer for this contribution. Merged xlsx: use TextDecoder and TextEncoder in browser #1486. Many thanks to myfreeer for this contribution. Merged Refine typing for Column #1488. This should fix [BUG] Typescript error from getColumn.eachCell #1120. Many thanks to Selwyn Yeow for this contribution. Merged col-cache: optimize for performance #1489. Many thanks to myfreeer for this contribution. Merged Add lastColumn property (fixes #1453) #1487. This should fix property of worsheet.lastcolumn #1453. Many thanks to FliegendeWurst for this contribution. Merged Add a test for CSV writeFile encoding #1495. This should close [BUG] Export CSV garbled characters #1473. and Can't get hebrew to display correctly in a generted CSV file #995. Many thanks to Joseph Dykstra for this contribution. Merged Clarify `encoding` option is just for `.writeFile` #1496. Many thanks to Joseph Dykstra for this contribution. Merged Merge cells after row insert #1377. Many thanks to Curt Commander for this contribution. Merged Fix issue 1474 (to check invalid sheet name) #1484. This should fix [BUG] Incorrectly handles '/', ':' characters in sheet name #1474. Many thanks to skypesky for this contribution.
4.2.1	Merged Typing FillPattern fgColor should be optional #1550. Many thanks to Andries Smit for this contribution. Merged Fixed return type on getRows #1564. Many thanks to Paul Mcilwaine for this contribution. Merged fix #1598 lint violations #1599. Fixes [BUG] npm run lint reports multiple violations #1598. Many thanks to Ilya I for this contribution. Merged Fix fullAddress row and col types #1606. Many thanks to Adam Eisenreich for this contribution.
4.3.0	Merged Add TS declarations of Workbook properties #1656. Many thanks to Tanawit Kritwongwiman for this contribution. Merged Fix issue #178 #201. Many thanks to Vasiliy Stavenko for this contribution. Merged doc: add example for solid pattern usage #1649. Many thanks to fpaupier for this contribution. Merged Add type definition for lastColumn property (fixes #1453) #1629. Fixes Add type for property of worsheet.lastcolumn #1453. Many thanks to Daniel Gonçalves for this contribution. Merged fix #1598 lint violations #1599. Fixes [BUG] npm run lint reports multiple violations #1598. Many thanks to Ilya I for this contribution. Merged Update @types/node version to latest lts #1133. Fixes ERROR in node_modules/exceljs/index.d.ts(1648,34): error TS2503: Cannot find namespace 'NodeJS'. #971 and ERROR in node_modules/exceljs/index.d.ts(1661,34): error TS2503: Cannot find namespace 'NodeJS'. #997. Many thanks to Siemienik Pawel for this contribution. Merged Added Node v16 to the test suite #1731. Many thanks to Alex Bjørlig for this contribution. Merged Readme moment to dayjs #1708. Many thanks to Jerebtw for this contribution. Merged Ability to set tooltip for hyperlink #602. Many thanks to Aleksey Kuznetsov for this contribution. Merged Fixed conditional format corrupting sheet #1305 #1574. Fixes [BUG] Errors when opening file in Excel after saving a file with conditional formatting #1305. Many thanks to Rolando Romero for this contribution. Merged Improvements for images (correct reading/writing possitions) #702. Many thanks to Siemienik Pawel for this contribution.

Stable Version

4.4.0

MODERATE

6.1/10

Summary

Cross-Site Scripting in exceljs

Affected Versions

< 1.6.0

Patched Versions

1.6.0

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Maintained

Determines if the project is "actively maintained".

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to exceljs

@types/exceljs

1.3.2

Stub TypeScript definitions entry for exceljs, which provides its own types definitions

exceljs-lightweight

1.14.0

Excel Workbook Manager - Read and Write xlsx and csv Files. Fork from exceljs/exceljs

jsreport-exceljs

4.0.1

Excel Workbook Manager - Read and Write xlsx and csv Files.

@zurmokeeper/exceljs

4.4.8

Excel Workbook Manager - Read and Write xlsx and csv Files.

exceljs

Installations

Developer Guide

Yes

CommonJS, UMD

>=8.3.0

15.8.0

7.5.1

Score

Pull Requests

113

549

82

354

Issues

577

1,832

1,255

Releases

Contributors

Languages

Developer

exceljs

Download Statistics

GitHub Statistics

Bundle Size

920.79 kB

251.09 kB

Maintainers

Package Meta Information

Total Downloads

183,448,764

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

ExcelJS

Translations

Installation

New Features!

Contributions

Let's chat together:

Contents

Importing⬆

ES5 Imports⬆

Browserify⬆

Interface⬆

Create a Workbook⬆

Set Workbook Properties⬆

Set Calculation Properties⬆

Workbook Views⬆

Add a Worksheet⬆

Remove a Worksheet⬆

Access Worksheets⬆

Worksheet State⬆

Worksheet Properties⬆

Worksheet Metrics⬆

Page Setup⬆

Headers and Footers⬆

Worksheet Views⬆

Frozen Views⬆

Split Views⬆

Auto filters⬆

Columns⬆

Rows⬆

Add Rows⬆

Handling Individual Cells⬆

Merged Cells⬆

Insert Rows⬆

Splice⬆

Duplicate a Row⬆

Defined Names⬆

Data Validations⬆

Cell Comments⬆

Cell Comments Properties⬆

Cell Comments Margins

Supported Margins Properties⬆

Cell Comments Protection