Univer Boards API

瞭解如何在 Univer Boards 應用程式中使用 Facade API。

Facade API 在 Univer 服務和單元模型之上提供一層供應用程式使用的介面。您可以使用它執行常見的 Board 操作,例如建立畫板、讀取作用中頁面、新增元素、更新容器及管理泳道。

注意

Board 變更 API 是同步的,並回傳 boolean 或可為空的控制代碼。讀取結果前請檢查回傳值。

啟用 Facade 進入點

Boards 以 Web SDK 外掛程式的形式發行。請匯入應用程式所用 Board 功能的 Facade 進入點:

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

建立 Univer 執行個體並註冊必要的外掛程式後,再建立 API 物件:

TypeScript
const univerAPI = FUniver.newAPI(univer)

建立及讀取畫板

使用 createBoard 透過 Facade 層建立 Board 單元。在較底層的設定程式碼中,請使用 univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot) 建立單元。

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

繼續瞭解核心功能

回傳的 FBoard 物件是存取目前頁面及其內容的入口。詳細操作請繼續閱讀對應指南:

  • 元素介紹如何讀取、插入、連接、變形、排列和刪除 Board 元素。
  • 容器與泳道介紹帶邊框群組、元素隸屬和泳道結構。

參考資料

你覺得這篇文檔如何?

© 2026 DreamNum Co., Ltd.