xlsx-populate 技术文档

xlsx-populate 技术文档

xlsx-populate 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. 项目地址: https://gitcode.com/gh_mirrors/xl/xlsx-populate

xlsx-populate 是一个基于 JavaScript 的 Excel XLSX 文件解析与生成库，兼容 Node.js 和浏览器环境。该工具提供了类似 jQuery 或 d3 的链式操作方法，支持加密功能，并能在处理 Excel 工作簿时保留原有的样式和特性不变。

安装指南

Node.js 环境安装

在使用前，请确保您的 Node.js 版本为 v4 或更高版本。安装可通过npm完成：

npm install xlsx-populate

浏览器环境集成

对于浏览器端的应用，xlsx-populate需要通过转换以适应浏览器环境。您可以通过以下方式之一集成：

1. 访问仓库中的 examples/browser/index.html 示例文件作为参考。
2. 直接从仓库的 browser 目录下载合并压缩后的代码，或者使用 bower 进行安装：

   bower install xlsx-populate
   

   完成后，在浏览器中全局可访问 XlsxPopulate 对象。
3. 使用 browserify 配合 babelify 和 babel-preset-env 来处理ES6语法，使xlsx-populate可以在现代浏览器中运行。

使用说明

xlsx-populate提供了丰富的方法来操作Excel工作簿，下面简述几个关键点：

初始化和填充数据

首先，加载新工作簿或现有工作簿，然后修改并保存：

const XlsxPopulate = require('xlsx-populate');

XlsxPopulate.fromBlankAsync()
  .then(workbook => {
    workbook.sheet("Sheet1").cell("A1").value("示例文本");
    return workbook.toFileAsync("output.xlsx");
  });

解析数据

加载现有文件并读取单元格值：

XlsxPopulate.fromFileAsync("example.xlsx")
  .then(workbook => {
    console.log(workbook.sheet("Sheet1").cell("A1").value());
  });

处理范围(Ranges)

xlsx-populate允许批量操作多个单元格：

const range = workbook.sheet(0).range("A1:C3");
range.value([["一", "二", "三"], ["四", "五", "六"], ["七", "八", "九"]]);

行与列管理

您可以调整行列属性，如隐藏、宽度等：

workbook.sheet("Sheet1").column("B").width(25).hidden(false);

管理工作表(Sheets)

添加、重命名、移动或删除工作表是基本操作：

let newSheet = workbook.addSheet("新建");
newSheet.name("新的名字");
workbook.moveSheet(newSheet.name(), "Sheet1"); // 移动到Sheet1之前
workbook.deleteSheet("新的名字");

项目API使用文档

完整的API文档请参见项目官方文档，其中包括了对每个方法的详细介绍，例如：

• Cell.value: 获取或设置单元格的值。
• Sheet.cell: 根据地址获取单元格对象。
• Workbook.addSheet: 添加新工作表。
• Sheet.range: 选取指定的单元格区域。
• 更多API细节涉及样式设置、数据验证、方法链使用等，都可在API参考部分找到详细说明。

项目安装方式

已总结于上述“安装指南”部分。

此文档概述了xlsx-populate的基本安装和使用流程，以及一些高级功能的入门指导。在进行更复杂的数据处理和格式化时，建议查阅官方文档以获得详尽的指导。

xlsx-populate 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. 项目地址: https://gitcode.com/gh_mirrors/xl/xlsx-populate