一、SpreadJS 简介

SpreadJS 是一款基于 HTML5 的纯 JavaScript 电子表格和网格功能控件,以“高速低耗、纯前端、零依赖”为产品特色,可嵌入任何操作系统,同时满足 .NET、Java、响应式 Web 应用及移动跨平台的表格数据处理和类 Excel 的表格应用开发,为终端用户带来亲切的 Excel 体验。本文将以xlsx文件格式为例,展示如何使用SpreadJS实现前端导入和导出excel文件。

  • SpreadJS 官网
  • 本文在线Demo示例
  • 导入导出Excel视频演示

  • 主要功能

    1. 功能、UI 与 Excel 高度类似
    2. 兼容 450 种以上的 Excel 公式
    3. 符合 UMD 规范,可按需加载
    4. 完善的数据可视化,支持形状、图表、迷你图
    5. 纯前端导入、导出 Excel 文件
    6. 使用 HTML5 图形(Canvas)绘制界面,具备高性能和响应速度
  • 安装包目录结构

    ├── Spread.Sheets SpreadJS产品包

    │ └── Designer SpreadJS 表格设计器

    │ ├── Spread.Sheets-Designer.12.0.0.AppImage [Mac]

    │ ├── Spread.Sheets-Designer.12.0.0.dmg
    [Linux]

    │ └── Spread.Sheets-Designer.12.0.0
    [Windows]

    │ └── Spread.Sheets.Docs.12.0.0 SpreadJS 表格接口文档

    │ ├── content

    │ └── index

    │ └── Spread.Sheets.Release.12.0.0 SpreadJS 表格 JavaScript 库/演示用例

    │ ├── css 样式文件

    │ ├── definition TS 引用文件

    │ ├── readme

    │ ├── samples
    示例代码(包括原生JS,Angular,Vue,React)

    │ ├── scripts JS文件

    │ ├── GrapeCity-EULA

    │ └── LICENSE

  • 如何使用

    1. Spread.Sheets不依赖任何第三方组件。它只需要引用下列文件:gc.spread.sheets.xx.x.x.css,gc.spread.sheets.all.xx.x.x.min.js。

      <link rel="styleSheet" href="gc.spread.sheets.xx.x.x.css" />
      <script src="gc.spread.sheets.all.xx.x.x.min.js" type="text/javascript"></script>
      <script src="gc.spread.sheets.resources.zh.xx.x.x.min.js" type="text/javascript"></script>
      
    2. 在页面的body元素中添加一个DOM元素作为它的容器。

      <div id="ss" style="width:100%; height:360px;border: 1px solid gray;"></div>
      
    3. 用代码“new GC.Spread.Sheets.Workbook(document.getElementById('ss'), {sheetCount: 1 })”来初始化Spread。

      window.onload = function () {
          var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
      };
      

    4. 初始化 SpreadJS在线示例

二、前端导入导出Excel

实现前端导入导出只需要引入gc.spread.excelio库,使用excelIO.open 和excelIO.save两个方法即可,不需要配置任何选项,代码十分简洁易懂。

具体步骤如下:

前端导入导出支持将Spread json导出为excel文件(.xlsx)和将excel文件导入为Spread json.

使用前端导入导出, 你需要将相关的js文件添加的document的head区域。例如:

<head>
   ...
   <script src='.../spreadjs/gc.spread.sheets.all.x.xx.xxxxx.x.min.js' type='text/javascript'></script>
   <script src='.../spreadjs/plugins/gc.spread.excelio.x.xx.xxxxx.x.min.js' type='text/javascript'></script>
</head>

初始化Workbook实例和ExcelIO实例:

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'));
var excelIo = new GC.Spread.Excel.IO();

接下来你就可以使用open方法将excel文件导入为spread json,使用 save 方法将spread json导出为excel文件。例如:

//import excel file to Spread.Sheets json
excelIo.open(excelFile, function (json) {
    var workbookObj = json;
    workbook.fromJSON(workbookObj);
}, function (e) {
    // process error
    console.log(e);
});
//export Spread.Sheets json to excel file
excelio.save(json, function (blob) {
    //do whatever you want with blob
    //such as you can save it
}, function (e) {
    //process error
    console.log(e);
});

同时,你还可打开或保存一个带有密码保护的excel文件,只需要在open和save方法中传入参数options{password:xxxx}即可。例如:

//import excel file to Spread.Sheets json
excelIo.open(excelFile, function (json) {
    var workbookObj = json;
    workbook.fromJSON(workbookObj);
}, function (e) {
    // process error
    console.log(e);
},{password:xxxx});
//export Spread.Sheets json to excel file
excelio.save(json, function (blob) {
    //do whatever you want with blob
    //such as you can save it
}, function (e) {
    //process error
    console.log(e);
},{password:xxxx});

前端导入导出Excel 的示例源码及数据源下载:

三、处理单元格合并

一般来说,前端生成excel而不是csv,其最主要的原因都是为了解决csv不能实现单元格合并的问题,假设我们要生成带有单元格格式的Excel文件,也可以通过SpreadJS内置属性实现:

调用 addSpan 方法来合并指定区域的单元格, 以此来构建一个新的更大的单元格, 参见以下示例代码:

// Merge cells and set label
sheet.addSpan(1, 4, 1, 7);
sheet.setValue(1, 4, "Goods");
// Merge cells across multi rows (3) and columns (4)
sheet.addSpan(20, 1, 3, 4);
sheet.getCell(20, 1).value("Demo").hAlign.vAlign;
调用 removeSpan 方法来分解指定包含合并的单元格:
sheet.removeSpan(20, 1);

Workbook的 allowUserDragMerge 选项表明是否允许通过鼠标拖拽来合并单元格。把 allowUserDragMerge 改为 true,在选择区域边缘处会出现一个特殊的标记。

// default value is false
spread.options.allowUserDragMerge = true;

备注: 确定你要展现在合并单元格中的信息在合并前处于合并区域的最左上单元格, 合并单元格中的其他单元格信息将被隐藏, 直到合并信息被分解(与Excel相同)。

处理单元格合并的示例源码及数据源下载:cellSpan.html

四、自定义Excel的文件样式

Spread.Sheets 提供一个样式的类, 其中包含很多可配置属性, 如前景色、背景色等。

你可以通过这些属性,构造一个样式并设置不同的参数, 示例代码如下:

var style = new GC.Spread.Sheets.Style();
style.backColor = 'red';
style.foreColor = 'green';
style.isVerticalText = 'true';

同样,你也可以将此样式设置给单元格, 行, 或者列:

//set style to cell.
sheet.setStyle(5, 5, style, GC.Spread.Sheets.SheetArea.viewport);

//set style to row.
sheet.setStyle(5, -1, style, GC.Spread.Sheets.SheetArea.viewport);

//set style to column.
sheet.setStyle(-1, 5, style, GC.Spread.Sheets.SheetArea.viewport);

样式在不同的层级结构中具有不同的优先级别: 单元格 > 行 > 列。

Spread.Sheets 支持给样式设置一个名称, 并将这个命名过的样式加入到表单的名称样式集合中。这样让样式的使用和管理更方便。

你可以构造一个名称样式, 并将此样式添加到表单或者 Spread 控件的名称样式集合中,如:

var style = new GC.Spread.Sheets.Style();
style.name = 'style1';
style.backColor = 'red';

//add to sheet's named style collection.
sheet.addNamedStyle(style);
//add to spread's named style collection.
spread.addNamedStyle(style)

当名称样式添加到表单名称样式集合中后, 可以通过样式的名称找到它:

sheet.getNamedStyle('style1');
spread.getNamedStyle('style1')

如果名称样式不再使用, 你也可以将其从名称集合中删除掉:

sheet.removeNamedStyle('style1');
spread.removeNamedStyle('style1')

自定义Excel文件样式的示例源码:style.html

五、数据绑定

Spread.Sheets 支持绑定数据源到表单(绑定类型有表单级别绑定和单元格级别绑定两种。)

你可以使用 setDataSourcegetDataSource 方法来设置获取数据源。 在设置数据源之前, 你可以使用 autoGenerateColumns 方法来控制是否自动生成绑定列。 例如:

var customers = [
   { ID:0, Name:'A', Info1:'Info0' },
   { ID:1, Name:'B', Info1:'Info1' },
   { ID:2, Name:'C', Info1:'Info2' },
];
sheet.autoGenerateColumns = true;
sheet.setDataSource(customers);

你也可以使用 getDataItem 方法来获取指定行的数据信息。

你按照如下方式将数据字段绑定到指定的列:

var datasource = [
   { name: 'Alice', age: 27, birthday: '1985/08/31', position: 'PM' }
];
// bindColumn one by one 
var nameColInfo = { name: 'name', displayName: 'Display Name', size: 70 };
var ageColInfo = { name: 'age', displayName: 'Age', size: 40, resizable: false };
var birthdayColInfo = { name: 'birthday', displayName: 'Birthday', formatter: 'd/M/yy', size: 120 };
var positionColInfo = { name: 'position', displayName: 'Position', size: 50, visible: false };
sheet.autoGenerateColumns = false;
sheet.setDataSource(datasource);
sheet.bindColumn(0, nameColInfo);
sheet.bindColumn(1, birthdayColInfo);
sheet.bindColumn(2, ageColInfo);
sheet.bindColumn(3, positionColInfo);

// or use bindColumns to bind all custom columns
var colInfos = [
   { name: 'position', displayName: 'Position', size: 50, visible: false },
   { name: 'name', displayName: 'Display Name', size: 70 },
   { name: 'birthday', displayName: 'Birthday', formatter: 'd/M/yy', size: 120 },
   { name: 'age', displayName: 'Age', size: 40, resizable: false },
];
sheet.autoGenerateColumns = false;
sheet.setDataSource(datasource);
sheet.bindColumns(colInfos);

数据绑定的示例源码:sheetLevelBinding.html

以上就是使用SpreadJS,实现前端导入和导出excel文件的具体步骤和示例代码,其他如Excel公式、图表、条件格式、JSON序列化与反序列化、状态栏等功能,可以在SpreadJS官网了解更多。


SpreadJS | 下载试用

纯前端表格控件SpreadJS,是市面上布局与功能都与 Excel 高度类似的一款表格控件,全中文操作界面,适用于.NET、Java、移动端等多个平台的类 Excel 数据开发,备受华为、中通、民航飞行学院等国内知名企业客户青睐。

您对SpreadJS产品的任何技术问题,都有技术支持工程师提供1对1专业解答,点击此处即可发帖提问