新手入门-在Vue框架中嵌入前端Excel表格插件(上)

发布时间:2023/06/02 10:06 发布者:Leo

返回博客中心

前言

在现今互联网时代,Excel成为了优秀的打工人们必不可少的办公软件。然而,随着越来越多的公司采用各种基于浏览器/服务器架构(B/S)的系统来处理表格数据文件,人们开始寻求一种能够在浏览器中直接使用的Excel插件来处理数据的解决方案。幸运的是,我们找到了答案!在本文中,我将向大家介绍如何在Vue框架中集成SpreadJS在线表格插件(以下简称为"SpreadJS"),以及如何使用在线表格编辑器(类似于Excel的浏览器插件),实现在浏览器中直接处理Excel数据的功能。

SpreadJS是一款强大的在线表格插件,它可以无缝集成到Vue框架中。通过使用SpreadJS,我们可以在浏览器中创建、编辑和处理Excel表格数据,就像在使用Excel软件一样。此外,SpreadJS还提供了前端Excel导出的功能,使我们能够将处理过的表格数据导出为Excel文件,并进行下载或分享。

要在Vue项目中使用SpreadJS,只需要简单的几步。首先在项目中引入SpreadJS的相关库文件。可以通过将SpreadJS的脚本文件引入到Vue组件中来实现这一点。引入了SpreadJS之后,我们就可以在Vue组件中创建一个表格实例,并在浏览器中显示。

此外,如果我们需要提供类似Excel的功能,比如单元格编辑、公式计算、数据筛选等,我们可以使用在线表格编辑器。在线表格编辑器可以作为一个类似Excel的浏览器插件嵌入到Vue项目中,为最终用户提供直观和便捷的表格编辑功能。通过在线表格编辑器,最终用户可以在浏览器中对表格数据进行实时编辑和处理。

综上,通过在Vue框架中集成SpreadJS在线表格插件和在线表格编辑器,我们可以在浏览器中直接使用Excel插件来处理数据,并实现前端Excel导出的功能。这种解决方案为打工人们提供了更加灵活和便捷的办公工具,使得处理和编辑表格数据变得更加高效和方便。无论是在个人工作还是团队合作中,这样的解决方案都将大大提升工作效率和用户体验。

友情提示:在本教程中,我们将使用node.js,请确保已安装最新版本,除此之外还需要使用Visual Studio Code(以下简称“VSCode”)作为编程环境。

如何在Vue框架中集成表格插件(SpreadJS)

在本节中,我将向大家展示如何在Vue框架中引入SpreadJS资源,并实现简单的文件上传和下载两个功能。

在Vue中集成SpreadJS:

1.首先使用管理员权限打开VSCode,并打开初始代码文件(详见文末资源包)或者如果你已经对于Vue框架很熟悉,也可以选择自己创建一个Vue项目,相关创建语法如下:

# npm 6.x

npm create vite@latest Vue3-spread-ts --template Vue-ts
# npm 7+, extra double-dash is needed:
npm create vite@latest Vue3-spread-ts --template Vue-ts
# yarn
yarn create vite Vue3-spread-ts --template Vue-ts
# pnpm
pnpm create vite Vue3-spread-ts -- --template Vue-ts

2.打开项目中的package.json文件夹,这个时候我们需要在文件夹中引入SpreadJS组件,具体如下所示:

{

"name": "vue3-spread-ts",
"private": true,
"version": "0.0.0",
"scripts": {
"dev": "vite",
"build": "vue-tsc --noEmit && vite build",
"preview": "vite preview"
},
"dependencies": {
"@grapecity/spread-excelio": "latest",
"@grapecity/spread-sheets": "latest",
"@grapecity/spread-sheets-barcode": "latest",
"@grapecity/spread-sheets-charts": "latest",
"@grapecity/spread-sheets-languagepackages": "latest",
"@grapecity/spread-sheets-pdf": "latest",
"@grapecity/spread-sheets-pivot-addon": "latest",
"@grapecity/spread-sheets-print": "latest",
"@grapecity/spread-sheets-resources-zh": "latest",
"@grapecity/spread-sheets-shapes": "latest",
"@grapecity/spread-sheets-tablesheet": "latest",
"@grapecity/spread-sheets-vue": "latest",
"element-plus": "^2.2.5",
"file-saver": "^2.0.5",
"vue": "^3.2.25"
},
"devDependencies": {
"@vitejs/plugin-vue": "^2.3.3",
"typescript": "^4.5.4",
"vite": "^2.9.9",
"vue-tsc": "^0.34.7"
}
}

引入这些组件后,请运行npm install命令(第一次下载可能需要一些时间)。下载完成之后使用命令npm run dev启动项目,如果在浏览器中能够正常打开则表示项目初始化成功。

3.项目启动后,打开srccomponents目录下的OnlineSpread.vue文件,这个文件是Vue框架集成SpreadJS主要代码的存放位置。(如果想使用自定义.vue文件,需注意修改app.vue文件中的代码import onlineSpread from './components/OnlineSpread.vue'为自定义的文件名称)。

3.1引入SpreadJS资源:

为了将SpreadJS集成到Vue框架中,还需要额外的引入一些资源到项目中,这些资源包含了SpreadJS的主要资源、文件导入导出等。

import {defineComponent} from 'Vue'

// SpreadJS组件运行时资源
import * as GC from "@grapecity/spread-sheets"
// 引入契合自己项目主题的样式
import "@grapecity/spread-sheets/styles/gc.spread.sheets.excel2013white.css"
// 使用中文资源包
import "@grapecity/spread-sheets-resources-zh"
// 引入导入导出文件相关的资源
import * as ExcelIO from "@grapecity/spread-excelio"
//引入文件导出
import {saveAs} from 'file-saver'
//引入打印相关资源
import "@grapecity/spread-sheets-print"
//引入导出pdf资源
import "@grapecity/spread-sheets-pdf"

// 设置语言资源为中文
GC.Spread.Common.CultureManager.culture('zh-cn')

3.2 引入资源后,可以看到在浏览器中显示的表格内容只有一行,这是因为表格的格式尚未设置,需要用SpreadJS的hostStyle标签和workbookInitialized标签来设置表格的大小和宽度。具体设置方法是先在div标签中设置hostStyle的格式(注意不要忘了return hostStyle标签),然后在setup方法中设置高度格式即可。

// 引入组件

components:{
'gc-spread-sheets':GcSpreadSheets
}
// div标签
<gc-spread-sheets :hostStyle="hostStyle" @workbookInitialized="initWorkbook">
</gc-spread-sheets>
//设置高度格式,写在setup方法中
const hostStyle={
height:'90vh'
}
return{
hostStyle
}

上传文件和下载文件:

上传文件、下载文件的方法与设置表格大小的方法一样,首先也是在div标签中设置对应的按钮,

<el-upload

class="upload-demo"
accept=".xlsx"
:before-upload="importFile"
action=''
>
<el-button type="primary">上传文件</el-button>
</el-upload>
<el-button type="primary" @click="downloadFile">下载文件
</el-button>

然后在setup方法中设置上传文件和下载文件的方法(具体可以参考SpreadJS的API参考文档)。

//文件上传的方法

const importFile = (file) => {
let io = new ExcelIO.IO()
// excelio打开文件,回调函数中的参数时SpreadJS支持的json格式
io.open(file,(fileJSON) => {
// fromJSON中第二个参数为导入文件的控制参数,默认均为false,根据自己的需求添加,都不要修改时可不传
spread.fromJSON(fileJSON,{
ignoreFormula: false, //导入忽略公式
ignoreStyle: false, //导入忽略样式
frozenColumnsAsRowHeaders: false, //将冻结列当作行头
frozenRowsAsColumnHeaders: false, //将冻结行作为列头
// 导入文件不立即计算. Excel文件保存时会自动计算,当文件比较大时,可以导入后不计算,提高导入效率.
doNotRecalculateAfterLoad: false
})
})
return false
}
//文件下载的方法
const downloadFile = () => {
//获取当前工作簿json,toJSON也可以根据需求设置参数,参考学习指南导入导出json
let fileJson = spread.toJSON()
//创建文件IO实例
let io = new ExcelIO.IO()
//保存文件
io.save(fileJson,(blob)=>{
// excelIO将文件转化为blob,传递给回调函数,然后执行file-saver的saveAs保存excel文件.
saveAs(blob,'导出文件.xlsx')
},(e) => {
console.log(e)
})
}

做完这些之后便可以在浏览器中实现上传文件、修改文件内容并下载文件的操作了,同时还可以体验和使用表格插件(用法和Excel高度相似)。

PS:细心的网友可能已经注意到了,在今天介绍的步骤完成后,浏览器中只显示了表格,并没有显示Excel中上方的编辑器(Ribbon Bar)内容。下一篇文章将会着重介绍如如何在Vue中集成在线编辑器的内容。

本文提到的完整源码:


更多参考资料:

本文对应的视频教程

表格控件技术资料文档

>>>>>扩展资料:

使用纯前端类Excel表格控件SpreadJS构建企业现金流量表

前端必读:如何在 JavaScript 中使用SpreadJS导入和导出 Excel 文件

SpreadJS表格控件:打造预算编制模块的秘诀,超级财务总监都在用!


SpreadJS | 下载试用

纯前端表格控件SpreadJS,兼容 450 种以上的 Excel 公式,具备“高性能、跨平台、与 Excel 高度兼容”的产品特性,备受华为、苏宁易购、天弘基金等行业龙头企业的青睐,并被中国软件行业协会认定为“中国优秀软件产品”。SpreadJS 可为用户提供类 Excel 的功能,满足表格文档协同编辑、 数据填报、 类 Excel 报表设计等业务场景需求,极大的降低企业研发成本和项目交付风险。

如下资源列表,可以为您评估产品提供帮助: