快速開始

安裝 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 內容。

你覺得這篇文檔如何?

© 2026 DreamNum Co., Ltd.