js-xlsx excel导出学习记录2 样式

上一次已经初步学会了通过workbook配置,实现简单excel导出,但是excel不是简单的表格光有数据就完了,如果是那样我直接用逗号分隔符创建csv就好了。
这次,我来看看如何实现样式,我要实现的功能有

1.单元格合并
2.列宽设置
3.样式设置 对齐方式 字体/背景颜色 边框

我先用excel做了包含这些功能的简单范本,最终希望用js-xlsx重现


但是经过尝试,已经确认SheetJS/xlsx 导出excel时cells样式配置是无效的,他们提供了一个Pro Version
,似乎只有使用这个专业版才能实现这个功能。

不过我很快找到了替代品 protobi/js-xlsx

npm install xlsx-style

斯巴达,我的项目一引用这个包就无法正常运行了


会抛出这个错误,不知道是这个包有问题还是我的环境有问题,已经尝试在项目上安装fs dev也安装fs依然没解决。

使用protobi/js-xlsx

我只能采用传统页面加载方式来使用,从他们的git上clone了项目,在页面上加载xlsx.core.min.js文件,因为用前端加载,同时也要引入Blobfile-saver ,我在搜索引擎上找到了一个简单的函数来实现 file-saver 的功能,当前项目代码如下

<script type="text/javascript" src="./xlsx-style/dist/xlsx.core.min.js"></script>
<script type="text/javascript" src="./Blob.js"></script>

<script>
  const saveAs = (obj, fileName)=>{
    const a = document.createElement('a');
    a.download = fileName || '下载';
    a.href = URL.createObjectURL(obj);     
    a.click();                           
    setTimeout(()=> {                     
      URL.revokeObjectURL(obj);     
    }, 100);
  };

  const s2ab = s => {
    let buf = new ArrayBuffer(s.length);
    let view = new Uint8Array(buf);
    for (let i = 0; i !== s.length; ++i) view[i] = s.charCodeAt(i) & 0xFF;
    return buf;
  };

  const workbook = {   //本次学习只对这个对象做修改,其他代码块保持不动
    SheetNames: ['Sheet1'],
    Sheets: {
      Sheet1: {
      }
    }
  };

  const workbookOut = XLSX.write(workbook, {
    bookType: 'xlsx',
    bookSST: false,
    type: 'binary'
  });

  saveAs(new Blob([s2ab(workbookOut)], {
    type: 'application/octet-stream'
  }), 'export.xlsx')

</script>

因为只是学习测试,我直接用简练的es6语法,实现功能为主,不考虑浏览器兼容性问题

1.单元格合并sheet['!merges']

回顾官方文档,sheet提供了一个配置项!merges用来实现单元格合并
使用之前先了解它的用法,sheet['!merges']接受一个数组参数,数组对象的格式如下

[
  {
    s: { //s start 开始
      c: 1,//cols 开始列
      r: 0 //rows 开始行
    },
    e: {//e end  结束
      c: 4,//cols 结束列
      r: 0 //rows 结束行
    }
  }
]

为了实现合并A1:D1我给sheet['!merges']增加对应配置,现在的workbook如下

const workbook = {
  SheetNames: ['Sheet1'],
  Sheets: {
    Sheet1: {
      '!ref': 'A1:D4',
      '!merges': [{
        s: {c: 0, r: 0},
        e: {c: 3, r: 0}
      }],
      A1: {v: '采购单', t: 's'},
    }
  }
};

运行导出,成功


2.列宽设置 sheet['!cols']

sheet提供了一个配置项!cols用来实现设置列宽

[          
  {
    hidden? : boolean, //列的显示true或隐藏false
    /* column width is specified in one of the following ways: */
    wpx? : number, // 列宽 单位是像素
    width? : number,  // width in Excel's "Max Digit Width", width*256 is integral
    wch? : number,  // width in characters
    /* other fields for preserving features from files */
    MDW? : number,  // Excel's "Max Digit Width" unit, always integral
  }
]

我的示例中的单元格宽度是 45px 165px 45px 45px
配置一下
'!cols': [{wpx: 45}, {wpx: 165}, {wpx: 45}, {wpx: 45}]
运行导出


可以看到列宽有被正确配置,但是产生的宽度是 51px 189px 51px 51px,虽然有误差,不过配置项有效,误差原因就不深究了

清注意,下面的功能由xlsx-style实现 ,对xlsx无效

样式配置表

样式属性 子属性 参数
fill patternType "solid" or "none"”
fgColor COLOR_SPEC
bgColor COLOR_SPEC
font name "Calibri" // default
sz "11" // font size in points
color COLOR_SPEC
bold true or false
underline true or false
italic true or false
strike true or false
outline true or false
shadow true or false
vertAlign true or false
numFmt "0" // integer index to built in formats, see StyleBuilder.SSF property
"0.00%" // string matching a built-in format, see StyleBuilder.SSF
"0.0%" // string specifying a custom format
"0.00%;\(0.00%\);\-;@" // string specifying a custom format, escaping special characters
"m/dd/yy" // string a date format using Excel's format notation
alignment vertical "bottom" or "center" or "top"
horizontal "bottom" or "center" or "top"
wrapText true or false
readingOrder 2 // for right-to-left
textRotation Number from 0 to 180 or 255 (default is 0)
90 is rotated up 90 degrees
45 is rotated up 45 degrees
135 is rotated down 45 degrees
180 is rotated down 180 degrees
255 is special, aligned vertically
border top { style: BORDER_STYLE, color: COLOR_SPEC }
bottom { style: BORDER_STYLE, color: COLOR_SPEC }
left { style: BORDER_STYLE, color: COLOR_SPEC }
right { style: BORDER_STYLE, color: COLOR_SPEC }
diagonal { style: BORDER_STYLE, color: COLOR_SPEC }
diagonalUp true or false
diagonalDown true or false

COLOR_SPEC: 填充、字体和边框的颜色对象:

  • { auto: 1}指定自动值
  • { rgb: "FFFFAA00" } 指定16进制的ARGB
  • { theme: "1", tint: "-0.25"} 指定主题颜色和色调的整数索引(默认值为0)
  • { indexed: 64} 默认值 fill.bgColor

BORDER_STYLE: 边框样式是一个字符串值,它可以是以下值之一:

  • thin
  • medium
  • thick
  • dotted
  • hair
  • dashed
  • mediumDashed
  • dashDot
  • mediumDashDot
  • dashDotDot
  • mediumDashDotDot
  • slantDashDot

2.样式设置

我的测试范例中标题“采购单”是水平居中对齐,18号加粗字体
给A1增加对应配置

A1: {
  v: '采购单',
  t: 's',
  s: {
    font: {
      sz: 18,                //18号字体
      bold: true             //加粗
    },
    alignment: {
      horizontal: 'center'   //水平居中对其
    }
  }
}

运行导出


配置有效!我很快就按配置表写出下面的workbook

const borderAll = {  //单元格外侧框线
  top: {
    style: 'thin'
  },
  bottom: {
    style: 'thin'
  },
  left: {
    style: 'thin'
  },
  right: {
    style: 'thin'
  }
};

const workbook = {
  SheetNames: ['Sheet1'],
  Sheets: {
    Sheet1: {
      '!ref': 'A1:D4',
      '!cols': [{wpx: 45}, {wpx: 165}, {wpx: 45}, {wpx: 45}],
      '!merges': [{
        s: {c: 0, r: 0},
        e: {c: 3, r: 0}
      }],
      A1: {
        v: '采购单',
        t: 's',
        s: {
          font: {
            sz: 18,
            bold: true
          },
          alignment: {
            horizontal: 'center'
          }
        }
      },
      A2: {
        v: '序号',
        t: 's',
        s: {
          border: borderAll
        }
      },
      B2: {
        v: '商品名称',
        t: 's',
        s: {
          border: borderAll
        }
      },
      C2: {
        v: '数量',
        t: 's',
        s: {
          border: borderAll
        }
      },
      D2: {
        v: '颜色',
        t: 's',
        s: {
          border: borderAll
        }
      },
      A3: {
        v: 1,
        t: 'n',
        s: {
          border: borderAll
        }
      },
      B3: {
        v: '商品1',
        t: 's',
        s: {
          border: borderAll
        }
      },
      C3: {
        v: 100,
        t: 'n',
        s: {
          border: borderAll,
          font: {
            color: {
              rgb: 'FF4F81BD'  //字体颜色
            }
          }
        }
      },
      D3: {
        v: '',
        s: {
          border: borderAll,
          fill: {
            fgColor: {
              rgb: 'FFC0504D'  //背景颜色
            }
          }
        }
      }
    }
  }
};

运行



到此,本次对使用js-xlsx导出excel的学习基本告一段落,可以准备投入生产了

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,045评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,114评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,120评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,902评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,828评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,132评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,590评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,258评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,408评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,335评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,385评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,068评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,660评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,747评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,967评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,406评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,970评论 2 341