Write simple `*.xlsx` files in a browser or Node.js
write-excel-file*.xlsx files in a browser or Node.js
read-excel-file for reading small to medium *.xlsx files.
js
npm install write-excel-file --save
`
Alternatively, one could include it on a web page directly via a tag.
Use
To write an *.xlsx file, one must provide the contents of a spreadsheet in the form of data — an array of rows. Each row must be an array of cells.
Each cell should have a value, a type, and, optionally, other cell parameters.
If a cell doesn't have a type, then it is automatically detected from the value, or defaults to a String. Possible types are:
* String
* Number
* Boolean
* Date
* "Formula"
An empty cell could be represented by null or undefined.
Here's an example of data.
`js
const HEADER_ROW = [
{
value: 'Name',
fontWeight: 'bold'
},
{
value: 'Date of Birth',
fontWeight: 'bold'
},
{
value: 'Cost',
fontWeight: 'bold'
},
{
value: 'Paid',
fontWeight: 'bold'
}
]
const DATA_ROW_1 = [
// "Name"
{
type: String,
value: 'John Smith'
},
// "Date of Birth"
{
type: Date,
value: new Date(),
format: 'mm/dd/yyyy'
},
// "Cost"
{
type: Number,
value: 1800
},
// "Paid"
{
type: Boolean,
value: true
}
]
const data = [
HEADER_ROW,
DATA_ROW_1,
DATA_ROW_2,
DATA_ROW_3,
...
]
`
API
$3
Example 1: Write data to a file called file.xlsx and trigger a "Save as" file dialog so that the user could save the file to their disk.
`js
import writeXlsxFile from 'write-excel-file'
await writeXlsxFile(data, {
fileName: 'file.xlsx'
})
`
Under the hood, it uses file-saver package to save the *.xlsx file to disk.
Example 2: fileName parameter is not passed, so it returns a Blob.
`js
const blob = await writeXlsxFile(data)
`
$3
Example 1: Write data to a file at path /path/to/file.xlsx.
`js
// Import from '/node' subpackage.
const writeXlsxFile = require('write-excel-file/node')
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx'
})
`
Example 2: filePath parameter is not passed, but buffer: true parameter is passed, so it returns a Buffer.
`js
const buffer = await writeXlsxFile(data, { buffer: true })
`
Example 3: Neither filePath nor buffer: true parameters are passed, so it returns a readable Stream.
`js
const writeStream = fs.createWriteStream('/path/to/file.xlsx')
const readStream = await writeXlsxFile(data)
readStream.pipe(writeStream)
`
AWS S3 might refuse to accept the stream for output. How to fix that.
#####
AWS S3 might throw Cannot determine length of [object Object]:
`js
await new AWS.S3().putObject({
Bucket: ...,
Key: ...,
Body: stream,
ContentType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
}).promise()
`
The reason is that AWS S3 only accepts streams of known length, and the length of a zip file can't be known in advance.
Workaround for AWS SDK v2: write to Buffer instead of a stream.
Workaround for AWS SDK v3: use Upload operation.
Data vs Objects
Alternatively, instead of providing data, one could provide a list of JSON objects and a schema describing each output column:
`js
// Input data
const objects = [
{
name: 'John Smith',
dateOfBirth: new Date(),
cost: 1800,
paid: true
},
{
name: 'Alice Brown',
dateOfBirth: new Date(),
cost: 2600,
paid: false
}
]
`
`js
// Output columns
const schema = [
{
column: 'Name',
type: String,
value: student => student.name
},
{
column: 'Date of Birth',
type: Date,
format: 'mm/dd/yyyy',
value: student => student.dateOfBirth
},
{
column: 'Cost',
type: Number,
format: '#,##0.00',
value: student => student.cost
},
{
column: 'Paid',
type: Boolean,
value: student => student.paid
}
]
`
Each column should have a column title, a data type, a value "getter" function, and, optionally, other cell parameters.
$3
`js
import writeXlsxFile from 'write-excel-file'
await writeXlsxFile(objects, {
schema,
fileName: 'file.xlsx'
})
`
$3
`js
const writeXlsxFile = require('write-excel-file/node')
await writeXlsxFile(objects, {
schema,
filePath: '/path/to/file.xlsx'
})
`
Column Widths
One could specify custom column widths (in "characters" rather than in "pixels").
$3
When passing objects/schema, column widths can be specified via width property in the schema.
`js
const schema = [
// Column #1
{
column: 'Name',
value: student => student.name,
width: 20 // Column width (in characters).
},
...
]
`
$3
When passing data, one can pass a separate columns parameter to specify column widths:
`js
// Set Column #3 width to "20 characters".
const columns = [
{},
{},
{ width: 20 }, // Width is in characters
{}
]
await writeXlsxFile(data, {
columns, // Pass it here.
fileName: 'file.xlsx'
})
`
Cell Parameters
Regardless of whether you're passing data or objects/schema, each cell (or schema column) can also specify:
* Custom format — by specifying a format property.
* Custom style
* By specifying any of the style-related properties.
* (advanced) (only when passing objects/schema) By specifying a getCellStyle(object) function for a column in the schema, which allows specifying different cell style for different rows in the same column.
$3
The optional format property can only be used on cells (or schema columns) with type: Date, Number, String or "Formula" . Its purpose is to display the "raw" cell value — for example, a number or a date — in a particular way: as a floating-point number with a specific number of decimal places, or as a percentage, or maybe as a date in a particular date format, etc.
There're many standardized formats to choose from.
Below are some of the commonly used Number formats.
* 0.00 — Floating-point number with 2 decimal places. Example: 1234.56.
* 0.000 — Floating-point number with 3 decimal places. Example: 1234.567.
* #,##0 — Number with a comma as a thousands separator, as used in most English-speaking countries. Example: 1,234,567.
* #,##0.00 — Currency, as in most English-speaking countries. Example: 1,234.50.
* 0% — Percents. Example: 30%.
* 0.00% — Percents with 2 decimal places. Example: 30.00%.
All Date cells (or schema columns) are required to specify a format, unless a default dateFormat option is specified.
* mm/dd/yy — US date format. Example: 12/31/00 for December 31, 2000.
* mmm d yyyy — Example: Dec 31 2000.
* d mmmm yyyy — Example: 31 December 2000.
* dd/mm/yyyy hh:mm AM/PM — US date-time format. Example: 31/12/2000 12:30 AM.
* or any other format where:
* yy — Last two digits of a year number.
* yyyy — Four digits of a year number.
* m — Month number without a leading 0.
* mm — Month number with a leading 0 (when less than 10).
* mmm — Month name (short).
* mmmm — Month name (long).
* d — Day number without a leading 0.
* dd — Day number with a leading 0 (when less than 10).
* h — Hours without a leading 0.
* hh — Hours with a leading 0 (when less than 10).
* mm — Minutes with a leading 0 (when less than 10).
* ss — Seconds with a leading 0 (when less than 10).
* AM/PM — Either AM or PM, depending on the time.
A String cell (or schema column) could also specify a format.
* It could specify @ format in order to explicitly declare itself being of "Text" type rather than the default "General" type. The point is, this way Microsoft Excel won't attempt to "intelligently" interpret the String cell value as a number or a date, as it usually does by default. For example, by default, if a String cell value is "123456", Microsoft Excel will try to display it as a 123,456 number rather than a "123456" string.
$3
Cell style properties:
* align: string — Horizontal alignment of cell content. Available values: "left", "center", "right".
* alignVertical: string — Vertical alignment of cell content. Available values: "top", "center", "bottom".
* textRotation: number — Text rotation angle. Values from -90 to 90 are supported. Positive values rotate the text counterclockwise, and negative values rotate the text clockwise.
* height: number — Row height, in "points".
* span: number — Column span. Even if a cell spans N columns, it should still be represented as N individual cells in the data. In that case, all the cells except the left-most one will be ignored. One could use null or undefined to represent such ignored cells. For example, if the first cell in a row spans 3 columns, then the row would look like [{ value: 'Text', span: 3 }, null, null, { value: 'After text' }].
* rowSpan: number — Row span. Even if a cell spans N rows, it should still be represented as N individual cells in the data. In that case, all the cells except the top-most one will be ignored. One could use null or undefined to represent such ignored cells. For example, if the top left cell spans 2 rows, then the first row would look like [{ value: 'Rows', rowSpan: 2 }, { value: 'R1' }] and the second row would look like [null, { value: 'R2' }].
* indent: number — Horizontal indentation level for the cell content.
* wrap: boolean — Set to true to "wrap" text when it overflows the cell.
* fontFamily: string — Can be used to print text in a custom font family. Example: "Calibri".
* fontSize: number — Can be used to print text in a custom font size. Example: 12.
* fontWeight: string — Can be used to print text in bold. Available values: "bold".
* fontStyle: string — Can be used to make text appear italicized. Available values: "italic".
* color: string — Cell text color (in hexademical format). Example: "#aabbcc".
* backgroundColor: string — Cell background color (in hexademical format). Example: "#aabbcc".
* borderColor: string — Cell border color. Example: "#aabbcc".
* borderStyle: string — Cell border style. Example: "thick".
* leftBorderColor
* leftBorderStyle
* rightBorderColor
* rightBorderStyle
* topBorderColor
* topBorderStyle
* bottomBorderColor
* bottomBorderStyle
Objects: Table Header Style
When passing objects/schema, the output table will include a header row at the top. The header row can be customized by providing column titles and cell style.
Column titles should be specified as column property values in the schema.
`js
const schema = [
// Column #1
{
column: 'Name', // Column title
value: student => student.name
},
...
]
`
When column title is not specified, it's gonna be empty.
The default style for table header cells is:
* fontWeight — "bold"
* align — equal to the schema column's align property value
To override that default style, provide a getHeaderStyle(columnSchema) function:
`js
await writeXlsxFile(objects, {
schema,
getHeaderStyle: (columnSchema) => ({
backgroundColor: '#eeeeee',
fontWeight: 'bold',
align: columnSchema.align,
indent: columnSchema.indent
}),
filePath: '/path/to/file.xlsx'
})
`
Font
The default font is Calibri at 12px. To change the default font, pass fontFamily and fontSize parameters when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
fontFamily: 'Arial',
fontSize: 16
})
`
Orientation
To specify custom orientation (for all sheets), pass orientation parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
orientation: 'landscape'
})
`
Date Format
To set the default date format, pass dateFormat parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
dateFormat: 'mm/dd/yyyy'
})
`
Sticky Rows
To make some of the top rows "sticky" (Excel calls them "frozen"), pass stickyRowsCount parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
stickyRowsCount: 1
})
`
Sticky Columns
To make some of the columns at the start "sticky" (Excel calls them "frozen"), pass stickyColumnsCount parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
stickyColumnsCount: 1
})
`
Hide Grid Lines
To hide grid lines, pass showGridLines: false parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
showGridLines: false
})
`
Right-to-Left
To use right-to-left layout on all sheets, pass rightToLeft: true parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
rightToLeft: true
})
`
Sheet Name
To set the default sheet name, pass a sheet parameter when calling writeXlsxFile():
`js
await writeXlsxFile(data, {
filePath: '/path/to/file.xlsx',
sheet: 'Data'
})
`
Multiple Sheets
$3
To generate an *.xlsx file with multiple sheets when passing objects/schema:
* Pass a sheets parameter — an array of sheet names.
* The objects argument should be an array of objects for each sheet.
* The schema parameter should be an array of schemas for each sheet.
`js
await writeXlsxFile([objects1, objects2], {
schema: [schema1, schema2],
sheets: ['Sheet 1', 'Sheet 2'],
filePath: '/path/to/file.xlsx'
})
`
$3
To generate an *.xlsx file with multiple sheets when passing data:
* Pass a sheets parameter — an array of sheet names.
* The data argument should be an array of data for each sheet.
* (optional) The columns parameter should be an array of columns for each sheet.
`js
await writeXlsxFile([data1, data2], {
columns: [columns1, columns2], // (optional)
sheets: ['Sheet 1', 'Sheet 2'],
filePath: '/path/to/file.xlsx'
})
`
Images
Images reside in their own layer above any other data on a spreadsheet. Each separate sheet has its own layer of images.
To add images to a sheet, pass them as an images parameter to writeXlsxFile() function:
`js
const images = [{ ... }, { ... }]
// When passing data.
await writeXlsxFile(data, { images })
// When passing objects/schema.
await writeXlsxFile(objects, { schema, images })
`
When an *.xlsx file is written with multiple sheets, each separate sheet should specify its own images.
`js
const images1 = [{ ... }, { ... }]
const images2 = [{ ... }, { ... }]
// When passing data.
await writeXlsxFile([data1, data2], {
images: [images1, images2],
sheets: ['Sheet 1', 'Sheet 2']
})
// When passing objects/schema.
await writeXlsxFile([objects1, objects2], {
schema: [schema1, schema2],
images: [images1, images2],
sheets: ['Sheet 1', 'Sheet 2']
})
`
An image object should have properties:
* content — Image content.
* Browser: File or Blob or ArrayBuffer.
* Node: String file path or Readable stream or Buffer.
* contentType — MIME content type of the image. Example: "image/jpeg".
* width — Image width, in pixels.
* height — Image height, in pixels.
* dpi — Image "DPI" (aka "dots per inch").
* For legacy reasons described in the document, images in XLSX documents are measured not pixels but in some other weird measurement units. Mapping image pixels to those weird measurement units requires knowing a "DPI" of an image.
* The usual "DPI" of an image is either 72 or 96. Both values are equally meaningless. Pick one or the other.
* To find out an image's DPI in Windows, open file "Properties" and go to "Details" tab. There, it will say "Horizontal resolution" and "Vertical resolution".
If, after writing an .xlsx file, an image looks too large then try specifying a higher DPI. Conversely, if an image looks too small then try specifying a lower DPI.
* anchor — The cell that the image is positioned against. In other words, the image's top left corner is tied to the anchor cell's top left corner.
* row — Cell row number, starting with 1.
* column — Cell column number, starting with 1.
* offsetX — (optional) Image horizontal offset, in pixels, relative to the anchor cell.
* offsetY — (optional) Image vertical offset, in pixels, relative to the anchor cell.
* title — (optional) Image title.
* description — (optional) Image description.
The implementation details are described in a document.
CDN
To include this library directly via a tag on a page, one can use any npm CDN service, e.g. unpkg.com or jsdelivr.com
`html
`
GitHub
On March 9th, 2020, GitHub, Inc. silently banned my account (erasing all my repos, issues and comments, even in my employer's private repos) without any notice or explanation. Because of that, all source codes had to be promptly moved to GitLab. The GitHub repo is now only used as a backup (you can star the repo there too), and the primary repo is now the GitLab one. Issues can be reported in any repo.
License
MIT