使用 SpreadJS 实现 JavaScript 中导入和导出 Excel 文件

2019-07-05 15:00:45 +08:00
 powertoolsteam

JavaScript 是一个涵盖多种框架、直译式、可以轻松自定义客户端的脚本语言,在 Web 应用程序中,更加易于编码和维护。而 Excel 作为一款深受用户喜爱的电子表格工具,借助其直观的界面、出色的计算性能和图表工具,已经成为数据统计领域不可或缺的软件之一。

如果有一款产品,能够将二者完美融合,将在前端表格数据处理、数据填报、数据可视化、在线文档等领域大放异彩。SpreadJS,正是这样一款功能布局与 Excel 高度类似,无需大量代码开发和测试即可实现数据展示、前端 Excel 导入导出、图表面板、数据绑定等业务场景的纯前端表格控件。

使用 JavaScript 实现 Excel 的导入和导出

通过纯 JavaScript,您完全可以实现导入和导出 Excel 文件功能,并为最终用户提供与这些文件进行 I/O 交互的界面。在本篇教程中,我将向您展示如何借助 SpreadJS,在 JavaScript 中轻松实现导入和导出 Excel 文件的操作,以及将 SpreadJS 组件添加到 HTML 页面是多么的容易。

工欲善其事,必先利其器

请下载SpreadJS 纯前端表格控件,以便同步体验

设置 JavaScript 的电子表格项目

创建一个新的 HTML 页面并添加对 SpreadJS 下载包中 Spread.Sheets 脚本和 CSS 文件的引用:

<!DOCTYPE html>  
<html>  
<head>  
    <title>SpreadJS ExcelIO</title>  

    <script src="http://code.jquery.com/jquery-2.1.3.min.js" type="text/javascript"></script>  
    <script src="http://code.jquery.com/ui/1.11.4/jquery-ui.min.js" type="text/javascript"></script>  

    <link href="http://cdn.grapecity.com/spreadjs/hosted/css/gc.spread.sheets.excel2013white.10.1.0.css" rel="stylesheet" type="text/css" />  
    <script type="text/javascript" src="http://cdn.grapecity.com/spreadjs/hosted/scripts/gc.spread.sheets.all.10.1.0.min.js"></script>  
    <script type="text/javascript" src="http://cdn.grapecity.com/spreadjs/hosted/scripts/interop/gc.spread.excelio.10.1.0.min.js"></script>  

</head>  
<body>  
    <div id="ss" style="height:600px ; width :100%; "></div>  
</body>  
</html>  

然后在初始化 Spread.Sheets 组件的页面中添加一个脚本,并使用 div 元素来包含它(因为 SpreadJS 电子表格组件使用了 Canvas 绘制界面,所以这是初始化组件所必需的一步):

<script type="text/javascript">  
    $(document).ready(function () {  
        var workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));  
    });  
</script>  
</head>  
<body>  
<div id="ss" style="height:600px ; width :100%; "></div>  
</body>  

添加 Excel 导入代码

我们需要创建一个客户端 ExcelIO 组件的实例,并用它来实际打开 Excel 文件:

var excelIO = new GC.Spread.Excel.IO();  

然后我们需要添加一个导入文件的函数。在此示例中,我们导入本地文件,但您可以对服务器上的文件执行相同的操作。如果要从服务器端导入文件,则需要引用该位置。以下是输入元素的示例,用户可以在其中输入文件的位置:

<input type="text" id="importUrl" value="http://www.testwebsite.com/files/TestExcel.xlsx" style="width:300px" />  

完成上述步骤后,您可以直接在脚本代码中访问该值:

var excelUrl = $("#importUrl").val();  

以下导入函数的代码只使用本地文件作为“ excelUrl ”变量:

function ImportFile() {  
    var excelUrl = "./test.xlsx";  

    var oReq = new XMLHttpRequest();  
    oReq.open('get', excelUrl, true);  
    oReq.responseType = 'blob';  
    oReq.onload = function () {  
        var blob = oReq.response;  
        excelIO.open(blob, LoadSpread, function (message) {  
            console.log(message);  
        });  
    };  
    oReq.send(null);  
}  
function LoadSpread(json) {  
    jsonData = json;  
    workbook.fromJSON(json);  

    workbook.setActiveSheet("Revenues (Sales)");  
} 

无论您是在服务器上还是在本地引用文件,都需要在 $( document ).ready 函数内的脚本中添加以下内容:

$(document).ready(function () {  
    $.support.cors = true;  
    workbook = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));  
    //...  
});  

将数据添加到 Excel 文件

在本教程中,我们以导入一个名为 “ Profit loss statement ” 的 Excel 模板为例。

现在我们可以使用 Spread.Sheets 脚本在此文件中添加另一个收入行。让我们在页面上添加一个按钮来执行此操作:

<button id="addRevenue">Add Revenue</button>  

我们可以为该按钮的 click 事件绑定一个函数,用以执行添加行并复制上一行的样式。要复制样式,我们需要使用 copyTo 函数并传入:

document.getElementById("addRevenue").onclick = function () {  
    var sheet = workbook.getActiveSheet();  
    sheet.addRows(11, 1);  
    sheet.copyTo(10, 1, 11, 1, 1, 29, GC.Spread.Sheets.CopyToOptions.style);  
}  

用于添加数据和 Sparkline 的所有以下脚本代码都将包含在此按钮单击事件处理程序中。对于大多数数据,我们可以使用 setValue 函数。这允许我们通过传入行索引、列索引和值在 Spread 中的工作表上设置值:

sheet.setValue(11, 1, "Revenue 8");  

for (var c = 3; c < 15; c++) {  
    sheet.setValue(11, c, Math.floor(Math.random() * 200) + 10);  
}  

在 P 列中设置 SUM 公式以匹配其他行,并为 Q 列设置百分比:

sheet.setFormula(11, 15, "=SUM([@[Jan]:[Dec]])")  
sheet.setValue(11, 16, 0.15);  

最后,我们可以再次使用 copyTo 函数将前一行中的公式复制到 R 到 AD 列的新行,这次使用

CopyToOptions.formula:
sheet.copyTo(10, 17, 11, 17, 1, 13, GC.Spread.Sheets.CopyToOptions.formula);  

添加迷你图

现在我们可以添加一个迷你图来匹配其他数据行。要做到这一点,我们需要提供一系列单元格来获取数据和一些迷你图设置。在这种情况下,我们可以指定:

var data = new GC.Spread.Sheets.Range(11, 3, 1, 12);  
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();  
setting.options.seriesColor = "Text 2";  
setting.options.lineWeight = 1;  
setting.options.showLow = true;  
setting.options.showHigh = true;  
setting.options.lowMarkerColor = "Text 2";  
setting.options.highMarkerColor = "Text 1";  

然后,我们调用 setSparkline 方法并指定:

sheet.setSparkline(11, 2, data, GC.Spread.Sheets.Sparklines.DataOrientation.horizontal, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);  

如果您现在尝试运行代码,可能会很慢,这是因为每次更改数据和添加样式时工作簿都会重新绘制。为了大幅提升速度和性能,Spread.Sheets 提供了暂停绘画和计算服务的功能。让我们通过代码在添加行和数据之前暂停两者,并在完成数据加载后恢复:

workbook.suspendPaint();  
workbook.suspendCalcService();  
//...  
workbook.resumeCalcService();  
workbook.resumePaint();  

在添加该代码后,我们可以在 Web 浏览器中打开页面,并将 Excel 文件加载到 Spread.Sheets 中,并实现添加行的功能。

重要提示:请注意,Chrome 出于安全目的不允许您打开本地文件,因此您需要使用 Firefox 等网络浏览器才能成功运行此代码。当然,如果您从网站 URL 加载文件时,在任何浏览器中都可以打开。

添加 Excel 导出代码

我们还可以实现:在网页中将带有添加行功能的 Spread.Sheets 导出成 Excel 文件。在这里,我们使用 Spread.Sheets 中内置的客户端 ExcelIO 代码:

function ExportFile() {  
    var fileName = $("#exportFileName").val();  
    if (fileName.substr(-5, 5) !== '.xlsx') {  
        fileName += '.xlsx';  
    }  
    var json = JSON.stringify(workbook.toJSON());  

    excelIO.save(json, function (blob) {  
        saveAs(blob, fileName);  
    }, function (e) {  
        if (e.errorCode === 1) {  
            alert(e.errorMessage);  
        }  
    });  
}  

该代码从 exportFileName 的输入元素中直接获取导出的文件名。我们可以定义它并让用户以这样的方式命名文件:

<input type="text" id="exportFileName" placeholder="Export file name" value="export.xlsx" />  

在这里,我们继续为调用此函数添加一个按钮:

<button id="export">Export File</button>  
document.getElementById("export").onclick = function () {  
    ExportFile();  
}  

在实现添加行功能后,可以使用“导出文件”的按钮导出 Excel。请确保添加 FileSaver 外部库,以便用户将文件保存到他们本地:

<script src="https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/2014-11-29/FileSaver.min.js"></script>  

成功导出文件后,您可以使用 Excel 打开它,这时你会发现,在 Excel 中打开的模板除了之前导入的内容外,还增加了新的“收入行”。

通过这个示例,向您展示了如何使用 SpreadJS 纯前端表格控件,将 Excel 数据导入到网页中,在网页进行数据更新后,又通过简单的几行 JavaScript 代码将它们重新导出成 Excel 文件。您可以在SpreadJS 产品官网,查看本篇教程并下载 Demo 示例。

本篇教程,仅展示了 SpreadJS 的部分功能,即前端导入、导出 Excel 文件,更多的功能如数据分析、打印、导出 PDF、自定义公式函数等,请前往 SpreadJS 产品官网了解更多。

1092 次点击
所在节点    推广
0 条回复

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/580316

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX