2 Star 8 Fork 2

Reky / sheet

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

OpenHarmonySheet

基于 Canvas 实现的高性能 Excel 表格引擎组件 OpenHarmonySheet

由于大部分前端项目渲染层是使用框架根据排版模型树结构逐层渲染的,整棵渲染树也是与排版模型树一一对应。因此,整个渲染的节点也非常多。项目较大时,性能会受到较大的影响。

为了提升渲染性能,提供更优质的编辑体验从 DOM 更换成 Canvas 渲染,方便开发者构建重前端大型在线文档项目,在国内外实现类似引擎的公司仅仅只有几家,如:腾讯文档,金山文档和谷歌文档等。

在项目中引入 <Sheet></Sheet> 组件即可,使用方法如下:

<element name="Sheet" src="../../components/index.hml"></element>

<Sheet
  sheet="{{sheet}}"
  @sheet-show="sheetShow"
  @sheet-hide="sheetHide"
  @click-cell-start="clickCellStart"
  @click-cell-end="clickCellEnd"
  @click-cell-longpress="clickCellLongpress"
  @change="change"
></Sheet>

生命周期和事件

  • sheet 表格数据
  • @sheet-show 表格显示
  • @sheet-hide 表格隐藏
  • @click-cell-start 单元格点击前
  • @click-cell-end 单元格点击后
  • @click-cell-longpress 长按表格
  • @change 修改单元格数据

比如,我们在示例中可以监听 长按 事件,当用户 长按 的时候弹出 对话框,示例代码如下:

clickCellLongpress(evt) {
    prompt.showDialog({
        buttons: [{
            text: '测试',
            color: '#666666',
        }],
    });
}

以上所有的接口都会返回一个详细的 sheet 对象,里面含有以下信息:

  • el 表格的节点
  • textarea 单元格输入框节点
  • viewport 单元格高亮选框
  • table 单元格操作对象
sheetShow(sheet) {
    this.el = sheet.detail.el;
    this.textarea = sheet.detail.textarea;
    this.viewport = sheet.detail.viewport;
    this.table = sheet.detail.table;
}

API 接口

渲染引擎封装好了常用的表格数据操作等接口。

  • this.table.xxx

用于帮助你操作单元格的所有数据和格式,也极大方便你自定义一个功能完整的工具栏:

  • this.viewport.xxx

用于帮助你操作单元格上层的高亮选框。

  • this.textarea.xxx

this.textarea 是对鸿蒙的原生 <textarea> 组件的封装接口,用于帮助你接受用户在界面中的输入,然后配合 this.table.xx 将数据层的数据渲染到表格渲染层,这里的输入需要真机调试,因为真机有自带输入法,实测 Previewer 无效。

初始化表格渲染层

import Table from "./sheet/";
this.el = this.$refs.canvas;
this.table = Table.create(this.el, 850, 800).render();

初始化选区层

viewport 用于创建和控制单元格高亮选框,绘制在单元格上层,输入框下层,支持列选择,行选择和范围选择。

this.viewport = new Viewport(this.table).render();

初始化表格数据

在任何情况,你都可以使用 .cell 方法全局更新任一位置的数据。

this.table.cell((ri, ci) => `${ri}-${ci}`).render();

合并单元格

在表格中这是一个常用的方法,我们可以打碎局部单元格做合并操作。

this.table.merges(["G9:H11", "B9:D11"]).render();

设置列表行头

可以设置你的列表行头和其高度。

this.table.colHeader({ height: 50, rows: 2 }).render();

冻结区域

某些情况,我们在查阅表格的时候,我们可能需要固定某些行和某些列的单元格来提高表格阅读性,此时 .freeze 就可以派上用场。

this.table.freeze("C6").render();

滚动区域

一般配合冻结区域使用,让冻结区域以外的选区可以做滚动操作。

this.table.scrollRows(2).scrollCols(1).render();

设置选区

非特殊情况你不需要花费时间去操作单元格选框,正常情况选框接受你单元格的相对位置来绘制。

const range = this.viewport.range(
  evt.changedTouches[0].localX,
  evt.changedTouches[0].localY
);
this.table.selection(range);
this.viewport.render(this.table.$draw);

单元格,行和列接口

单元格,行和列表格结构如下:

col 列 col 列
row 行 cell 单元格 cell 单元格
row 行 cell 单元格 cell 单元格

我们可以使用以下方法更新单元格第二行第二列的数据为 8848,颜色为红色:

this.table
  .cell((ri, ci) => {
    if (ri === 2 && ci === 2) {
      return {
        text: "8848",
        style: {
          color: "red",
        },
      };
    }
    return this.sheet?.[ri]?.[ci] || "";
  })
  .render();

当然你可以精心定制每一个单元格的数据,这些数据可以来自于你的后端服务器,也可以来自于客户端的输入,配合客户端和服务端的存储能力,将数据持久化保存。

this.sheet = [
  ["💣", "💣", "💣"],
  ["💣", "🙉", "💣"],
  ["💣", "💣", "💣"],
];
this.table.cell((ri, ci) => this.sheet?.[ri]?.[ci] || "").render();

如果想操作更多单元格,行和列的数据和样式结构,比如行高度,列高度,单元格边框,字体排版,内外边距,下划线,背景色和旋转角度等,具体可以参考以下接口,支持各种丰富的多样的改动:

{
  row: { height, hide, autoFit },
  col: { width, hide, autoFit },
  cell: {
    text,
    style: {
      border, fontSize, fontName,
      bold, italic, color, bgcolor,
      align, valign, underline, strike,
      rotate, textwrap, padding,
    },
    type: text | button | link | checkbox | radio | list | progress | image | imageButton | date,
  }
}

其他接口

除此之外还提供其他完整的表格操作接口等待你的探索:

  • scrollRows
  • scrollCols
  • cell
  • row
  • cellStyle
  • freeze
  • merges
  • colHeader
  • render
  • selection
  • onClick
  • onSelected
  • focus
  • selectionStyle
  • headerCellStyle
  • freezeLineStyle
  • headerLineStyle
  • target
  • scrollCols
  • scrollRows
  • startCol
  • startRow

效果演示

我们将上面常见的接口做了一些演示,运行 OpenHarmonySheet长按任一单元格弹出对话框并点击对应选项即可查看常用接口的运行结果,此演示仅供参考,更多实际使用场景请参考文档实现:

实现方案

在谈谈实现方案之前,我们先讲讲表格渲染有多复杂,表格的渲染一般来说有两种实现方案:

  • DOM 渲染。
  • Canvas 渲染。

业界比较出名的 handsontable 开源库就是基于 DOM 实现渲染,同等渲染结果,需要对 DOM 节点进行精心的设计与构造,但显而易见十万、百万单元格的 DOM 渲染会产生较大的性能问题。因此,如今很多在线表格实现都是基于 Canvas 和叠加 DOM 来实现的,但使用 Canvas 实现需要考虑可视区域、滚动操作、画布层级关系,也有 Canvas 自身面临的一些性能问题,包括 Canvas 如何进行直出等,对开发的要求较高,但为了更好的用户体验,更倾向于 Canvas 渲染的实现方案。

我们通过分类收集视图元素,再进行逐类别渲染的方式,减少 Canvas 绘图引擎切换状态机的次数,降低性能损耗,优化渲染耗时,整个核心引擎代码控制在 1500 行左右,另补充演示代码 500 行,方便大家理解阅读和进行二次开发。

顶层
DOM 容器插件输入框等
Canvas 高亮选区等
Canvas 内容字体背景色等
底层

开发

本项目基于 OpenHarmony 下的 JavaScript UI 框架,运行环境请参考 OpenHarmony 项目配置方法 进行项目配置和运行。

如果你不熟悉 OpenHarmonyJavaScript 开发,请参考该官方文档

运行

  1. 下载 OpenHarmonySheet 项目工程,将工程导入 DevEco Studio 进行编译构建及运行调试。
  2. 进行编译构建,生成一个 HAP 应用安装包,生成 HAP 应用安装包。
  3. 安装运行后,即可在设备上查看应用示例运行效果,以及进行相关调试。

鸣谢

最后写点总结吧,不喜请轻喷,想起外网知乎有过类似的讨论,中国要用多久才能研发出类似 Excel,且功能涵盖 Excel 95% 功能的替代软件?,这条路很崎岖很艰难,引用最高赞一些大 V 的回答吧:

  • 微软轮子哥:做不出来的,那么多东西,要把需求文档写好都得好几年。
  • 微软的 Belleve:各位程序员可以试试先实现下 recalc(根据公式更新单元格数值),就知道难度了,文档项目作为国内最复杂的 C++ 项目绝非浪得虚名。
  • 微软的妖怪弟弟:作为 Excel 的工程师,哥认真的答一个,不能,因为我们隔壁组已经尝试过了,两年大概覆盖了 40%上下吧。
  • IBM 的 Caspar Cui:如果是开发常用的 Excel 功能的话, WPS 已经是很好的替代品了。而且微软和金山也有交叉授权。但是说要提到 95%功能的 Excel 已经做到了这种事儿。。。还是有点小瞧 Excel 了。就一个帮助文档量,WPS 也得多努力。
  • 中科大的 Sixue:假如微软脑抽,把 Excel 源码弄丢了,不可恢复了。那就是世界末日,大家一起完蛋。哪怕微软把 Excel 团队原班人马找回来,离职的反聘,英年早逝的复活,然后重新开发一个 Excel。他也没办法保证把 Excel 的功能恢复到 95%,没法保证 95%的 Excel 文件正常打开。
  • Bbcallen:不可能的,微软自己都做不到。

不管任何人怎么说,这条路我们也必须走,我们也必须迈出每一步,每一个坎每一个坑都值得留下一个中国人的脚印 🇨🇳

不积跬步,无以至千里,不积小流,无以成江海

从技术和目标角度理性去看,我们更应该实现的不是已经固化了市场和用户习惯的本地个人文档而是在线协同文档,本地文档只需考虑个人,不需要考虑多人协同场景,只需要考虑离线,不需要考虑在线场景,只需要考虑客户端场景,不需要考虑服务器场景等...

在线文档的宿主环境是浏览器,本地文档背后是系统,国内任何在线文档背后都没有像谷歌文档基于谷歌浏览器的支持,没有微软 Office 基于微软 Windows 系统的支持,事实上基于这一切我们也该清醒认识到,做到 95% 是很难的。要知道谷歌为了开发浏览器前后投入了十几年上千人上百亿,微软 Windows 系统就更不用说了,在国内我们可能拥有不了这样的技术背景,但我们仍在努力缩小差距顽强追赶,或许我们可能出生不在最好的国家,但我们可以努力把它成为最好的国家。

这一切我希望鸿蒙能给到,也衷心希望你能成功!

长风破浪会有时,直挂云帆济沧海

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

📊OpenHarmony Sheet 展开 收起
JavaScript 等 3 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/rekyone/sheet.git
git@gitee.com:rekyone/sheet.git
rekyone
sheet
sheet
main

搜索帮助