awesome-excel
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

awesome-excel

js简单导出excel,基于exceljs

安装

npm install awesome-excel

示例

基础

import AwesomeExcel from 'awesome-excel';

// 初始化
const awesomeExcel = new AwesomeExcel();

// 设置表格头
awesomeExcel.setHeader([
{ header: "姓名", key: "name", width: 10 },
{ header: "年龄", key: "age", width: 10 },
{ header: "工作", key: "work", width: 100 },
]);

// 设置表格内容
awesomeExcel.setRows([{ name: "小明", age: "16", work: "student" },{ name: "小李", age: "22", work: "student" }]);

// 导出
awesomeExcel.exportExcel({ filename: '工作表', align: "center" });

好了,你已经完全学会这个工具,快去使用吧!

不设置Header行

// 设置表格内容
awesomeExcel.setRows([{ name: "小明", age: "16", work: "student" },{ name: "小李", age: "22", work: "student" }]);

// 导出
awesomeExcel.exportExcel({ filename: '工作表', align: "center", useHeaderKey: false });

选项

getWorkbook

获取工作簿

  • 返回值

    ExcelJS.Workbook

setSheetName

设置工作表名称

  • 参数

    名称 说明 类型 默认值
    name 工作表名称 String 'sheet1'
  • 返回值

    void

setHeader

设置表格头部

  • 参数

    名称 说明 类型 默认值
    header 表头数据 Array<Partial<Column>> []
  • 返回值

    void

setRows

设置表格内容

  • 参数

    名称 说明 类型 默认值
    table 表格数据 Array<ObjectType> []
  • 返回值

    void

exportExcel

导出表格文件

  • 参数

    名称 说明 类型 可选项 默认值
    data 设置导出参数 Object undefined
    data.filename 表格的文件名 String
    data.align 单元格水平对齐 String 'left' 'center' 'right' 'fill' 'justify' 'centerContinuous' 'distributed'
    data.useHeaderKey 使用表头的键关联,是否使用header中的key Boolean true
  • 返回值

    void

Package Sidebar

Install

npm i awesome-excel

Weekly Downloads

4

Version

1.0.6

License

MIT

Unpacked Size

58 kB

Total Files

9

Last publish

Collaborators

  • fenglekai