How to read an Excel file with xlsx-populate in Node.js?

Use XlsxPopulate.fromFileAsync with the file path to load the workbook, then access cells using sheet and cell methods. For example, XlsxPopulate.fromFileAsync('./file.xlsx').then(workbook => { const value = workbook.sheet('Sheet1').cell('A1').value(); }).

xlsx-populate or SheetJS: which should I use?

xlsx-populate is better for preserving existing styles and formatting in templates due to its XML-based approach, while SheetJS might offer broader feature support and faster performance for read-heavy tasks. Choose based on your priority for style integrity versus comprehensive Excel features.

Can xlsx-populate edit Excel formulas?

Yes, you can set formulas using cell.formula('A1+B1'), but note that xlsx-populate does not recalculate formula results; it only stores and retrieves the last saved calculated values as explained in the parsing data section.

How to apply cell styles in xlsx-populate?

Use the style method on cells or ranges, e.g., cell.style('bold', true) or range.style({ fill: '0000ff' }). Refer to the style reference in the README for all available options, including complex patterns and gradients.

Does xlsx-populate support password-protected files?

Yes, it supports reading and writing Agile-encrypted XLSX files. Use options like { password: 'secret' } in fromFileAsync or toFileAsync methods, but note that encryption in browsers is slow, especially in IE.

What are the main limitations of xlsx-populate?

Key limitations include no formula recalculation, missing advanced Excel features like charts, and performance issues with encryption in browsers. The README's 'Missing Features' section details unsupported elements.

Open-Awesome

xlsx-populate

MITJavaScriptv1.19.1

A JavaScript library for parsing and generating Excel XLSX files with Node.js and browser support, preserving existing styles and features.

GitHub

999 stars197 forks0 contributors

What is xlsx-populate?

xlsx-populate is a JavaScript library for parsing, generating, and manipulating Excel XLSX files. It allows developers to programmatically read and write spreadsheet data, apply formatting, manage sheets, and handle encryption, all while preserving existing workbook structures and styles. It solves the problem of automating Excel file interactions without losing original content.

Target Audience

JavaScript developers working in Node.js or browser environments who need to automate Excel file processing, generate reports, or build spreadsheet-driven applications without relying on external Excel installations.

Value Proposition

Developers choose xlsx-populate for its focus on preserving existing workbook features, its fluent API with method chaining, and its support for both Node.js and browsers. Unlike some libraries, it maintains all original styles and content, even for unsupported features, ensuring file integrity.

Overview

Excel XLSX parser/generator written in JavaScript with Node.js and browser support, jQuery/d3-style method chaining, encryption, and a focus on keeping existing workbook features and styles in tact.

Use Cases

Best For

Generating Excel reports from web applications
Parsing and extracting data from existing XLSX templates
Automating spreadsheet manipulation in Node.js scripts
Building browser-based Excel file editors or viewers
Applying bulk formatting or data validation to workbooks
Creating password-protected Excel files programmatically

Not Ideal For

Applications requiring real-time Excel formula calculation or evaluation
High-performance processing of very large Excel files where speed is critical
Projects that depend on advanced Excel features like charts, pivot tables, or macros
Legacy browser environments without ES6 support, especially where encryption is needed

Pros & Cons

Pros

XML-Based Integrity

Manipulates XLSX files at the XML level, preserving all original content and styles even for unsupported features, ensuring no data loss during edits as stated in the philosophy section.

Fluent Method Chaining

Uses a jQuery/d3-style API for concise and readable code, demonstrated in examples like workbook.sheet(0).cell('A1').value('foo').style('bold', true).

Cross-Platform Compatibility

Runs in both Node.js and modern browsers, with built-in examples for Express serving and browser-based file handling, including encryption support.

Comprehensive Styling

Supports a wide range of formatting options including rich text, borders, fills, and data validation, detailed in the extensive style reference of the README.

Cons

No Formula Recalculation

Does not recalculate cell values based on formulas; only reads stored calculated values, which limits dynamic spreadsheet functionality as admitted in the parsing data section.

Incomplete Feature Coverage

The library openly acknowledges missing many XLSX format features in the 'Missing Features' section, which can block complex Excel operations.

Browser Performance Issues

Encryption and decryption in browsers are notably slow, particularly in Internet Explorer, affecting user experience for web applications as warned in the encryption section.

Frequently Asked Questions

Related Projects

markdown-it

Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed

Stars21,440

Forks1,818

Last commit1 month ago

remark

markdown processor powered by plugins part of the @unifiedjs collective

Stars8,878

Forks374

Last commit2 months ago

@parcel/css

An extremely fast CSS parser, transformer, bundler, and minifier written in Rust.

Stars7,528

Forks268