如何在Web应用中添加一个JavaScript Excel查看器

在现代的Web应用开发中，处理和展示Excel文件是一项常见需求。为了提供更好的用户体验和功能，经常需要在Web应用中添加一个JavaScript Excel查看器。今天，将向大家展示如何利用葡萄城公司的纯前端表格控件——SpreadJS来创建一个前端Excel查看器。

发布于 2023/12/08 18:40

前言

在现代的Web应用开发中，处理和展示Excel文件是一项常见需求。为了提供更好的用户体验和功能，经常需要在Web应用中添加一个JavaScript Excel查看器。今天，将向大家展示如何利用葡萄城公司的纯前端表格控件——SpreadJS来创建一个前端Excel查看器。

项目结构

本项目由三部分构成：一个HTML文件、一个JavaScript文件以及一个CSS文件。

1.引入SpreadJS

（1）本地文件引入

SpreadJS可以从我们的网站下载并导入到程序中。下载后，我们可以解压ZIP包并将JS和CSS文件复制到代码包中，特别是这些文件。

  • gc.spread.sheets.all.xx.x.x.min.js

  • gc.spread.sheets.io.xx.x.x.min.js

  • gc.spread.sheets.excel2013white.xx.x.x.css

将它们放入我们程序的文件夹后，我们可以在代码中引用它们：

<link rel="stylesheet" type="text/css" href="./styles/gc.spread.sheets.excel2013white.css">
<script src="./scripts/gc.spread.sheets.all.min.js" type="text/javascript"></script>
<script src="./scripts/gc.spread.sheets.charts.min.js" type="text/javascript"></script>
<script src="./scripts/gc.spread.sheets.shapes.min.js" type="text/javascript"></script>
<script src="./scripts/gc.spread.sheets.io.min.js" type="text/javascript"></script>

下载的示例中，默认就是这种方式，不需要作出修改。

（2）NPM引用

另一种方式是通过NPM的方式有引用SpreadJS。可以用如下命令安装依赖：

npm install @grapecity/spread-sheets @grapecity/spread-sheets-io @grapecity/spread-sheets-charts @grapecity/spread-sheets-shapes

然后，就可以在代码中这样引用这些文件：

<link rel= "stylesheet" type= "text/css" href= "./node_modules/@grapecity/spread-sheets/styles/gc.spread.sheets.excel2013white.css" > 
<script src="./node_modules/ @grapecity/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script> 
<script src="./node_modules/@grapecity/spread-sheets-io /dist/gc.spread.sheets.io.min.js" type="text/javascript"></script> 
<script src="./node_modules/@grapecity/spread-sheets-charts/dist/gc.spread .sheets.charts.min.js" type="text/javascript"></script> 
<script src="./node_modules/@grapecity/spread-sheets-shapes/dist/gc.spread.sheets.shapes.min .js" type="text/javascript"></script>

2.创建HTML内容

一旦引用了这些文件，我们就可以组合HTML页面和CSS样式。对于样式，已经提前创建好了：

body {
    position: absolute;
    top: 0;
    bottom: 0;
    left: 0;
    right: 0;
}

.sample-tutorial {
    position: relative;
    height: 100%;
    overflow: hidden;
}

.sample-container {
    width: calc(100% - 280px);
    height: 100%;
    float: left;
}

.sample-spreadsheets {
    width: 100%;
    height: calc(100% - 25px);
    overflow: hidden;
}

.options-container {
    float: right;
    width: 280px;
    height: 100%;
    box-sizing: border-box;
    background: #fbfbfb;
    overflow: auto;
}

.sample-options {
    z-index: 1000;
}

.inputContainer {
    width: 100%;
    height: auto;
    border: 1px solid #eee;
    padding: 6px 12px;
    margin-bottom: 10px;
    box-sizing: border-box;
}

.settingButton {
    color: #fff;
    background: #82bc00;
    outline: 0;
    line-height: 1.5715;
    position: relative;
    display: inline-block;
    font-weight: 400;
    white-space: nowrap;
    text-align: center;
    height: 32px;
    padding: 4px 15px;
    font-size: 14px;
    border-radius: 2px;
    user-select: none;
    cursor: pointer;
    border: 1px solid #82bc00;
    box-sizing: border-box;
    margin-bottom: 10px;
    margin-top: 10px;
}

.settingButton:hover {
    color: #fff;
    border-color: #88b031;
    background: #88b031;
}

.settingButton:disabled {
    background: #e2dfdf;
    border-color: #ffffff;
}

.options-title {
    font-weight: bold;
    margin: 4px 2px;
}

#selectedFile {
    display: none;
}

select, input[type="text"], input[type="number"] {
    display: inline-block;
    margin-left: auto;
    width: 120px;
    font-weight: 400;
    outline: 0;
    line-height: 1.5715;
    border-radius: 2px;
    border: 1px solid #F4F8EB;
    box-sizing: border-box;
}

.passwordIpt {
    margin-top: 10px;
    height: 25px;
}

.passwordIpt[warning="true"] {
    border-color: red;
}

.passwordIpt[warning="true"]::placeholder {
    color: red;
    opacity: 0.8;
}

@keyframes shake {
    0% { transform: translate(1px, 1px) rotate(0deg); }
    10% { transform: translate(-1px, -2px) rotate(-1deg); }
    20% { transform: translate(-3px, 0px) rotate(1deg); }
    30% { transform: translate(3px, 2px) rotate(0deg); }
    40% { transform: translate(1px, -1px) rotate(1deg); }
    50% { transform: translate(-1px, 2px) rotate(-1deg); }
    60% { transform: translate(-3px, 1px) rotate(0deg); }
    70% { transform: translate(3px, 1px) rotate(-1deg); }
    80% { transform: translate(-1px, -1px) rotate(1deg); }
    90% { transform: translate(1px, 2px) rotate(0deg); }
    100% { transform: translate(1px, 1px) rotate(0deg); }
}

#warningBox {
    color: red;
}

接下来，我们可以添加这个网页需要的按钮和UI，主要包括：

  • SpreadJS的容器

  • 状态栏

  • 导入区域 (密码输入框/文件选择按钮/导入按钮)

  • 导出区域 (密码输入框/导出按钮)

添加HTML标签时，我们可以对每个元素使用合适的样式：

<body>
    <div class="sample-tutorial">
        <div class="sample-container">
            <div id="ss" class="sample-spreadsheets"></div>
            <div id="statusBar"></div>
        </div>
        <div class="options-container">
            <div class="option-row">
                <div class="inputContainer">
                    <div class="options-title">Import:</div>
                    <input class="passwordIpt" id="importPassword" type="password" placeholder="Password" disabled>
                    <br>
                    <div id="warningBox"></div>
                    <input id="selectedFile" type="file" accept=".xlsx" />
                    <button class="settingButton" id="selectBtn">Select</button>
                    <button class="settingButton" id="importBtn" disabled>Import</button>
                </div>
                <div class="inputContainer">
                    <div class="options-title">Export:</div>
                    <input class="passwordIpt" id="exportPassword" type="password" placeholder="Password">
                    <br>
                    <button class="settingButton" id="exportBtn">Export</button>
                </div>
            </div>
        </div>
    </div>
</body>

3.初始化

现在已经准备好了HTML内容和SpreadJS引用，可以开始初始化SpreadJS实例并在app.js文件中添加Excel导入的代码了。

window.onload = function () {
  let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
}

4.添加按钮和功能

为了实现这个应用的目标，可以添加以下变量：

const $ = selector => document.querySelector(selector);
const listen = (host, type, handler) => host.addEventListener(type, handler);

在window.onload函数中创建变量，引用不同的HTML元素：

const importPassword = $('#importPassword');
const selectBtn = $('#selectBtn');
const fileSelect = $('#selectedFile');
const importBtn = $('#importBtn');
const warningBox = $('#warningBox');
const exportPassword = $('#exportPassword');
const exportBtn = $('#exportBtn');

为文件选择按钮和按钮输入框添加事件和监听函数以及密码错误的提示：

listen(selectBtn, "click", () => fileSelect.click());

const fileSelectedHandler = () => {
    importPassword.disabled = false;
    importBtn.disabled = false;
}

listen(fileSelect, 'change', fileSelectedHandler);

const wrongPasswordHandler = message => {
    importPassword.setAttribute('warning', true);
    importPassword.style.animation = "shake 0.5s";
    setTimeout(() => importPassword.style.animation = "", 500);
    warningBox.innerText = message;
    importPassword.value = '';
};

listen(importPassword, 'focus', () => {
    warningBox.innerText = '';
    importPassword.removeAttribute('warning');
});

5.导入Excel文件

现在可以写导入Excel文件到SpreadJS实例的代码了。因为我们可能会导入被密码保护的文件，因此在调用SpreadJS的[import函数](https://demo.grapecity.com.cn/spreadjs/help/api/classes/GC.Spread.Sheets.Workbook" \l "import)时需要考虑到这一点。我们可以在写import时添加事件处理程序：

const importFileHandler = () => {
    let file = fileSelect.files[0];
    if (!file) return ;
    spread.import(file, console.log, error => {
        if (error.errorCode === GC.Spread.Sheets.IO.ErrorCode.noPassword || error.errorCode === GC.Spread.Sheets.IO.ErrorCode.invalidPassword) {
            wrongPasswordHandler(error.errorMessage);
        }
    }, {
        fileType: GC.Spread.Sheets.FileType.excel,
        password: importPassword.value
    });
};
listen(importBtn, 'click', importFileHandler);

6.导出Excel文件

与导入类似，我们可以支持用户在导出Excel时输入保护密码，所以我们只需要将密码传入SpreadJS的[export函数](https://demo.grapecity.com.cn/spreadjs/help/api/classes/GC.Spread.Sheets.Workbook" \l "export)。我们同样为它添加事件处理程序：

const exportFileHandler = () => {
    let password = exportPassword.value;
    spread.export(blob => saveAs(blob, (password ? 'encrypted-' : '') + 'export.xlsx'), console.log, {
        fileType: GC.Spread.Sheets.FileType.excel,
        password: password
    });
};
listen(exportBtn, 'click', exportFileHandler);

7.数据保护

我们同样可以保护数据，阻止用户改变它。为了实现这一点，我们可以添加一个按钮来保护工作簿当前的表单。稍作修改，此功能就可以适配于多种不同的需求，但对于此示例，我们仅保护活动表单。与其他按钮类似，我们需要添加点击按钮的事件处理程序，对于SpreadJS，我们可以添加保护的选项：

const protectHandler = () => {
    var option = {
        allowSelectLockedCells:true,
        allowSelectUnlockedCells:true,
        allowFilter: true,
        allowSort: false,
        allowResizeRows: true,
        allowResizeColumns: false,
        allowEditObjects: false,
        allowDragInsertRows: false,
        allowDragInsertColumns: false,
        allowInsertRows: false,
        allowInsertColumns: false,
        allowDeleteRows: false,
        allowDeleteColumns: false,
        allowOutlineColumns: false,
        allowOutlineRows: false
    };
    spread.getActiveSheet().options.protectionOptions = option;
    spread.getActiveSheet().options.isProtected = true;
};
listen(protectBtn, 'click', protectHandler);

8.运行程序

现在剩下的就是运行程序了。因为我们是用纯JS和HTML写的，我们可以直接在浏览器打开HTML文件：


我们可以点击"Select"按钮来选择Excel文件来加载，然后点击"Import"按钮将其导入到SpreadJS：


接下来，我们可以在导出的密码输入框键入密码，点击"Export"按钮：


如果您想查看完整的源码，可以点击这个https://gitee.com/GrapeCity/java-script-excel" title="">Gitee地址。

总结

以上就是如何在Web应用中添加一个JavaScript Excel查看器的全过程，如果您想了解跟多信息，欢迎查看产品文档和

关于葡萄城

葡萄城是专业的软件开发技术和低代码平台提供商，以“赋能开发者”为使命，致力于通过表格控件、低代码和BI等各类软件开发工具和服务，一站式满足开发者需求，帮助企业提升开发效率并创新开发模式。葡萄城开发技术始于1980年，40余年来始终聚焦软件开发技术，有深厚的技术积累和丰富的产品线。是业界能够同时赋能软件开发和低代码开发的企业。凭借过硬的产品能力、活跃的用户社区和丰富的伙伴生态，与超过3000家合作伙伴紧密合作，产品广泛应用于信息和软件服务、制造、交通运输、建筑、金融、能源、教育、公共管理等支柱产业。

热门博客分类
ComponentOne Enterprise SpreadJS ActiveReports 活字格 Wyn 商业智能 WijmoJS GcExcel ActiveReportsJS 行业动态
推荐相关案例
京东物流 - 表格技术在物流行业的敏捷应用实践

物流大促期间出库单量积压场景下，不同仓的生产操作人员需要在统一数据源基础上进行基于自身仓情况的个性化查询分析，从而能够实时监控客单情况，防止积压。要想实现这样的功能，对数据分析平台的要求就非常高。在引入SpreadJS之后，Udata平台可以为客户提供更高效的数据查询方案。

网易 - 灵犀办公文档

为了在前端解析Excel文档，实现多人在线协同编辑，灵犀文档的数据集处理模块完全基于葡萄城的纯前端表格控件SpreadJS进行开发。通过嵌入SpreadJS，文档系统完美复刻了Excel的UI架构，并有效提升了系统多人协作和数据处理效率。

中联教育 - 嵌入式BI助力财经数据分析服务

通过与Wyn 商业智能的深度集成，实现了各个考场、考试场次、学生考试数据的隔离与考试平台数据集成，实现了考生自动授权登录、考试计划的制定，并能够进行在线大数据分析学习、实训、考试。

上海市政 - Wyn助力打造智慧道路交通数字孪生平台

在智慧道路交通平台的开发过程中，Wyn可以媲美一些数据中台产品，可以说就是一个小数据中台。不但能够实现数据的可视化，同时也具备数据多源融合分析的能力。

北京筑龙 - 为企业打造非凡数字化采购体验

北京筑龙已经将Wyn商业智能成功的应用于采购供应链相关服务及产品中，直观快速地解决了数据分析的需求。

查看更多精彩案例
推荐相关资源
《企业级低代码技术及应用白皮书》

在当今数字化时代，企业面临着前所未有的机遇和挑战。随着技术的不断进步和市场竞争的加剧，企业需要以更快的速度来适应变革、提供创新的解决方案。在此背景下，低代码技术崭露头角，凭借其低门槛、高效率的特性备受用户青睐，逐步成为数字化转型的重要驱动力。

《工程项目管理信息化低代码技术应用实践白皮书》

随着工程行业规模的不断扩大，市场竞争也变得更加激烈，利润空间逐步缩小，承包商面临的风险不断增加。在此背景下，工程企业必须增强内部发展动力，采用新技术、新方法和新模式来提升项目的综合管理水平。低代码技术的出现，为工程项目管理应用的高效落地带来新的机遇。

《低代码助力中小企业精益数字化转型白皮书》

在数字化转型方面，中小企业面临着不少挑战。在国家明确提出要促进数字经济发展、加强数字中国建设、完善数字经济治理的大背景下，企业数字化需求呈现井喷状态，而从市场上下游需求来看，大型企业数字化应用的完善对供应链管理提出了更高的要求，推动了中小企业配合数字化业务的需求。

铁路行业数字化应用建设方案白皮书

铁路行业数字化转型是一项复杂的系统工程，涉及业务流程优化、信息系统升级、数据资源整合等多方面内容。面对铁路业务需求多样化、业务变化快、个性化需求强等特点，传统的信息化建设模式已难以适应新形势下铁路高质量发展的要求。同时，铁路行业现有的信息系统存在数据分散、数据孤岛、分析能力不足、IT人才匮乏等诸多问题，这些因素都制约着铁路数字化转型的进程。 本白皮书以铁路数字化应用建设为主题，系统梳理了铁路行业数字化转型的现状与趋势，深入分析了铁路行业数字化应用建设面临的机遇和挑战。针对存在的主要问题，白皮书提出了一套切实可行的解决方案：一是利用低代码技术高效构建自主可控的数字化应用，匹配铁路行业个性化需求；二是打破数据壁垒，实现数字资源的统一管理和共享，促进业务系统深度融合；三是引入先进的表格技术和嵌入式BI工具，提升数据分析与价值挖掘能力。

IDC《中国低代码开发平台技术评估，2024》

在数字化转型的大潮中，低代码开发平台正成为企业快速构建和部署应用的新引擎。随着企业对敏捷开发和技术创新的需求日益增长，低代码平台的市场规模和影响力不断扩大。IDC 预测，到 2027 年，中国低代码/无代码软件市场规模将达到 106.3 亿元人民币，未来 5 年市场年复合增长率（CAGR）为32.3%。本次报告主要围绕低代码开发平台开展，IDC 定义的低代码/无代码开发平台是一种同时适用于专业开发人员和非 IT 开发人员的数字化开发平台，它通常提供可视化的开发工具、拖拽式开发界面、预构建的代码组件和模板，以及用于建模和集成流程和数据的工具，以加速和简化定制数字解决方案的设计和开发。

查看更多实用资源
关注微信
葡萄城社区二维码

关注“葡萄城社区”

活字格低代码二维码

关注“活字格低代码”

想了解更多信息，请联系我们, 随时掌握技术资源和产品动态

葡萄城热门产品

活字格
打通现有软件，快速定制面向未来的个性化应用
免费试用 产品详情
SpreadJS
可嵌入您系统的在线Excel的纯前端表格控件
免费试用 产品详情
Wyn商业智能
可与企业自有系统深度集成，增强数据分析的 BI 工具
免费试用 产品详情