基本概念

安装 Univer Boards 前，请先了解贯穿其 API 和文档的四个概念。它们分别说明 Board 如何组装、存储、变更和控制。

基本概念

插件

Univer 通过插件提供功能。@univerjs-pro/boards 提供 Board 模型、命令和 UniverBoardsPlugin；@univerjs-pro/boards-ui 提供画布、编辑界面和 UniverBoardsUIPlugin。富文本、绘图、墨迹和形状编辑包是安装时需要注册的技术渲染依赖，并不要求你了解其他 Univer 品类。表格和思维导图元素由可选的 Board 插件提供。

只需注册应用实际使用的产品插件。安装指南列出了完整的浏览器端配置及其依赖。

快照和数据模型

IBoardData 是一个 Board 单元的持久化格式。它用 pages 保存页面、用 pageOrder 保存页面顺序；每个页面用 elements 保存元素、用 elementOrder 保存元素的渲染顺序。资源、主题、当前页面、缩放比例和 Board 设置也属于 Board 快照。

快照用于创建、保存或恢复 Board。单元运行后，不要直接修改快照对象。请阅读 Board 数据结构和 Board 元素了解具体结构。

命令

运行时变更通过命令执行。通过命令层或 Facade 层插入元素、修改元素变换、把元素移入容器或更改页面状态，可以让模型、画布、撤销/重做与协同路径保持一致。

应用代码应优先使用 Facade API。只有在 Facade 尚未提供所需能力、需要更底层集成时，才直接使用命令 ID。

Facade API

Facade API 使用 FBoard 和元素句柄封装 Board 的命令层与模型层。导入 @univerjs-pro/boards/facade，注册插件后再调用 FUniver.newAPI(univer) 创建 API。应用随后可以创建或查找 Board、读取当前页面和元素，以及管理容器和泳道。

接下来请阅读安装和基本使用，再通过 Boards Facade API 指南创建和编辑 Board 内容。