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

前语

在现代的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函数时需求考虑到这一点。咱们能够在写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函数。咱们同样为它增加事情处理程序：

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”按钮：

假如您想检查完好的源码，能够点击这个Gitee地址。

总结

以上便是怎么在Web使用中增加一个JavaScript Excel检查器的全过程，假如您想了解跟多信息，欢迎检查产品文档和在线demo。