基本概念
有四个概念贯穿 Bases API 与 Bases 文档,分别说明 Base 如何组装、如何持久化、如何修改以及如何控制。安装 Univer Bases 之前,应先理解这四个概念。
基本概念
插件
Univer 的功能以插件形式提供。@univerjs-pro/bases 包含 Base 模型、其命令以及 UniverBasesPlugin;@univerjs-pro/bases-ui 包含独立工作台和 UniverBasesUIPlugin。模型插件还会使用公式引擎,因此公式字段会参与 Bases 的计算流程。
只注册应用实际需要的产品插件。安装和基本使用提供了完整的浏览器配置及其依赖的技术组件。
快照与数据模型
IBaseSnapshot 是单个 Base 单元的持久化格式。它包含表及其顺序,每张表包含字段、记录、视图以及各个集合的顺序。视图是同一批记录的不同投影,切换视图不会创建数据副本。
快照用于创建、保存或恢复 Base。单元开始运行后,不要直接修改快照对象。数据结构参见 Base 快照和表、字段与记录。
命令
运行时的修改都通过命令完成。创建表、更新字段、编辑记录或切换视图时,通过命令层或 Facade 层进行,可以使模型、UI、撤销/重做和协同链路保持一致。
应用代码应优先使用 Facade API。只有在需要 Facade 未暴露的底层集成时,才直接使用命令 ID。
Facade API
Facade API 在 Base 的命令层和模型层之上提供对象层:Base、表、字段、记录和视图。模型操作导入 @univerjs-pro/bases/facade,UI 状态操作导入 @univerjs-pro/bases-ui/facade,并在注册插件后调用 FUniver.newAPI(univer) 创建 API 对象。
接下来阅读安装和基本使用,然后按照 Bases Facade API 指南创建和编辑 Base 数据。
你觉得这篇文档如何?