Univer Boards API

Facade API 在 Univer 服务和单元模型之上提供了面向应用的接口层。你可以用它执行常见的 Board 操作，例如创建画板、读取当前页面、添加元素、更新容器和管理泳道。

启用 Facade 入口

Boards 以 Web SDK 插件的形式分发。请为应用所使用的 Board 功能导入对应的 Facade 入口：

import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'

注册 Univer 实例和所需插件后，创建 API 对象：

const univerAPI = FUniver.newAPI(univer)

创建和读取画板

使用 createBoard 通过 Facade 层创建 Board 单元。在底层初始化代码中，请使用 univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot) 创建该单元。

const board = univerAPI.createBoard({  id: 'board-demo',  name: 'Board Demo',})const activeBoard = univerAPI.getActiveBoard()const sameBoard = univerAPI.getBoard(board.getId())

继续了解核心功能

返回的 FBoard 对象是访问当前页面及其内容的入口。详细操作请继续阅读对应指南：

• 元素介绍如何读取、插入、连接、变换、排列和删除 Board 元素。
• 容器与泳道介绍带边框分组、元素归属和泳道结构。

参考资料

• 通用 API
• Boards Facade 参考
• Board 数据模型
• Board 元素