快速上手

简述

作者：myliang

这是一个基于 Web(es6) canvas 构建的轻量级 Excel 开发库

像这样

demo

或者查看 demo

快速入门开发

CDN

你可以直接在 html 静态文件中引入

  1. <link rel="stylesheet" href="https://unpkg.com/x-data-spreadsheet@1.1.9/dist/xspreadsheet.css">
  2. <script src="https://unpkg.com/x-data-spreadsheet@1.1.9/dist/xspreadsheet.js"></script>
  4. <script>
  5.   x_spreadsheet('#xspreadsheet');
  6. </script>

NPM

你可以使用 npm 包的形式安装

  1.   # 基于项目构建
  2.   npm install x-data-spreadsheet

在 html 中

  1. <div id="x-spreadsheet-demo"></div>

在 js 中

  1. import Spreadsheet from "x-data-spreadsheet";
  2. // If you need to override the default options, you can set the override
  3. // const options = {};
  4. // new Spreadsheet('#x-spreadsheet-demo', options);
  5. const s = new Spreadsheet("#x-spreadsheet-demo")
  6.   .loadData({}) // load data
  7.   .change(data => {
  8.     // save data to db
  9.   });
  11. // data validation
  12. s.validate()

默认配置

  1. {
  2.   mode: 'edit', // edit | read
  3.   showToolbar: true,
  4.   showGrid: true,
  5.   showContextmenu: true,
  6.   view: {
  7.     height: () => document.documentElement.clientHeight,
  8.     width: () => document.documentElement.clientWidth,
  9.   },
  10.   row: {
  11.     len: 100,
  12.     height: 25,
  13.   },
  14.   col: {
  15.     len: 26,
  16.     width: 100,
  17.     indexWidth: 60,
  18.     minWidth: 60,
  19.   },
  20.   style: {
  21.     bgcolor: '#ffffff',
  22.     align: 'left',
  23.     valign: 'middle',
  24.     textwrap: false,
  25.     strike: false,
  26.     underline: false,
  27.     color: '#0a0a0a',
  28.     font: {
  29.       name: 'Helvetica',
  30.       size: 10,
  31.       bold: false,
  32.       italic: false,
  33.     },
  34.   },
  35. }

导入和导出

关于如何导出，请查看 如果需要自定义导出，可以使用 SheetJs 来完成导出，并且再次感谢

绑定事件

简单的事件绑定

  1.   const s = new Spreadsheet("#x-spreadsheet-demo")
  2.   // event of click on cell
  3.   s.on('cell-selected', (cell, ri, ci) => {});
  4.   s.on('cells-selected', (cell, { sri, sci, eri, eci }) => {});
  5.   // edited on cell
  6.   s.on('cell-edited', (text, ri, ci) => {});

快速设定单元格值

通过instance.cellText(ri,ci,text)来设定值，调用reRender()来刷新，你将会看到数据的变化

  1.   const s = new Spreadsheet("#x-spreadsheet-demo")
  2.   s.cellText(5, 5, 'xxxx').cellText(6, 5, 'yyy').reRender();

获取选定表格中单元的样式和值

  1. const s = new Spreadsheet("#x-spreadsheet-demo")
  2. // cell(ri, ci, sheetIndex = 0)
  3. s.cell(ri, ci);
  4. // cellStyle(ri, ci, sheetIndex = 0)
  5. s.cellStyle(ri, ci);

快速本地化

如果是在 js 中引入

如果遇到更多问题，可以查看 issue #281

  1.   // npm
  2.   import Spreadsheet from 'x-data-spreadsheet';
  3.   import zhCN from 'x-data-spreadsheet/dist/locale/zh-cn';
  5.   Spreadsheet.locale('zh-cn', zhCN);
  6.   new Spreadsheet(document.getElementById('xss-demo'))

可以使用 CDN

  1. <!-- Import via CDN -->
  2. <link rel="stylesheet" href="https://unpkg.com/x-data-spreadsheet@1.1.9/dist/xspreadsheet.css">
  3. <script src="https://unpkg.com/x-data-spreadsheet@1.1.9/dist/xspreadsheet.js"></script>
  4. <script src="https://unpkg.com/x-data-spreadsheet@1.1.9/dist/locale/zh-cn.js"></script>
  6. <script>
  7.   x_spreadsheet.locale('zh-cn');
  8. </script>

加入开发者

  1.   # 拉取<repo>
  2.   git clone https://github.com/myliang/x-spreadsheet.git
  3.   # 进入项目开发目录
  4.   cd x-spreadsheet
  5.   # 安装相关依赖
  6.   npm install
  7.   # just do it
  8.   npm run dev

浏览器支持

chrome, firefox, Safari

许可申明

MIT 协议

联系我们

:::tip 联系方式 QQ群(1已满): 980597168

QQ群(2):904361146 :::