nodejs workbook.xlsx中设置列宽无效|极客笔记

nodejs workbook.xlsx中设置列宽无效

在使用Node.js处理Excel文件时，有时会遇到需要设置工作簿中列的宽度的需求。然而，在部分情况下，我们会发现使用xlsx库进行设置列宽操作时，无效的情况。本文将详细讨论在Node.js中使用xlsx库时，设置工作簿中列宽无效的原因及解决方法。

背景

在Node.js中，我们可以使用xlsx库来读写Excel文件，包括设置工作表中列的宽度。通常情况下，设置列宽的代码如下所示：

const XLSX = require('xlsx');
const workbook = XLSX.utils.book_new();
const ws_data = [
  ['Column 1', 'Column 2', 'Column 3'],
  [1, 2, 3],
  ['foo', 'bar', 'baz']
];
const ws = XLSX.utils.aoa_to_sheet(ws_data);
ws['!cols'] = [{wch: 20}, {wch: 30}, {wch: 10}]; // 设置列宽
XLSX.utils.book_append_sheet(workbook, ws, "Sheet1");

XLSX.writeFile(workbook, "workbook.xlsx");

以上代码中，我们通过ws['!cols']来设置工作表中每一列的宽度。在这段代码中，我们分别将第一列设置为宽度为20，第二列设置为宽度为30，第三列设置为宽度为10。

问题

然而，在一些情况下，即使我们按照上述代码设置了列宽，却发现生成的Excel文件列宽并没有被正确设置。此时，我们需要深入了解xlsx库中设置列宽的机制，找出问题所在并进行解决。

原因及解决方法

原因一：`!cols`被重写

在xlsx库中，当我们将一个工作表对象通过XLSX.utils.sheet_to_json()等方法转换成JSON对象时，!cols对象可能会被重写。这样一来，我们在设置列宽后，转换成JSON对象时，!cols的设置就会被丢失。

针对这个问题，我们可以在设置列宽后，再将!cols对象重新赋值给工作表对象，代码示例如下：

const ws = XLSX.utils.aoa_to_sheet(ws_data);
ws['!cols'] = [{wch: 20}, {wch: 30}, {wch: 10}]; // 设置列宽
// 设置列宽后，需要再次将!cols对象赋值给工作表对象
ws['!cols'] = ws['!cols'];
XLSX.utils.book_append_sheet(workbook, ws, "Sheet1");

原因二：列宽单位错误

在!cols中设置列宽时，需要注意单位是wch，代表1个字符的宽度。如果将单位设置为像素或其他单位，则会导致列宽无效。因此，需要保证单位为字符宽度。

原因三：其他属性影响列宽

在实际使用xlsx库时，有些单元格的属性设置可能会影响到列宽的显示。比如，单元格的自动换行属性、文本对齐方式等，可能会影响到列宽的最终呈现效果。因此，在设置列宽时，需要综合考虑各种属性的影响。

示例代码及验证

为了验证列宽设置是否有效，我们可以读取生成的Excel文件，并查看每一列的宽度是否符合预期。以下是一个完整的示例代码：

const XLSX = require('xlsx');
const workbook = XLSX.utils.book_new();
const ws_data = [
  ['Column 1', 'Column 2', 'Column 3'],
  [1, 2, 3],
  ['foo', 'bar', 'baz']
];
const ws = XLSX.utils.aoa_to_sheet(ws_data);
ws['!cols'] = [{wch: 20}, {wch: 30}, {wch: 10}]; // 设置列宽
// 设置列宽后，需要再次将!cols对象赋值给工作表对象
ws['!cols'] = ws['!cols'];
XLSX.utils.book_append_sheet(workbook, ws, "Sheet1");

XLSX.writeFile(workbook, "workbook.xlsx");

// 读取生成的Excel文件，验证列宽设置是否有效
const wb = XLSX.readFile("workbook.xlsx");
const ws2 = wb.Sheets[wb.SheetNames[0]];
console.log(ws2['!cols']); // 输出设置的列宽

在以上代码中，我们通过读取生成的Excel文件，并输出设置的列宽，来验证列宽设置是否有效。如果输出的列宽与预期设置一致，则表示设置列宽操作成功。