Univer Boards 簡介
Univer Boards 提供可用於白板、圖表、表格及心智圖的畫布工作區。
Univer Boards 是什麼
Univer Boards 是 Univer Office SDK 中的畫板產品。當文件不再是網格、頁面或投影片,而是自由形式的工作區時,就適合使用 Univer Boards:白板、圖表、便利貼、連接線、嵌入式表格和心智圖都能在此使用。
Univer Office SDK 包含三個 SDK:Web SDK 提供嵌入式編輯器和無頭內容處理能力,Server SDK 提供協同與檔案匯入匯出能力,AI SDK 提供 Agent 工作流程能力。
Boards 是以獨立的 Web SDK 單元類型實作。執行時,請建立 UniverInstanceType.UNIVER_BOARD 單元,再依據要支援的元素註冊所需的模型與 UI 外掛。
瀏覽器相容性
Web SDK 的編譯目標是 Chrome 88,但這並不意味著 Web SDK 能夠完全支援所有主流環境。我們會盡力確保 Web SDK 在以下瀏覽器和 Node.js 環境中能夠正常運行:
| Edge | Firefox | Chrome | Safari | Electron |
|---|---|---|---|---|
| >=88 | >=90 | >=88 | >=14.1 | >=12 |
Web SDK 依賴 Intl.Segmenter,如果你的瀏覽器或執行環境暫不支援它,請先補上對應的 polyfill。我們推薦使用
@formatjs/intl-segmenter。
如果遇到無法相容的情況,請先借助對應的 polyfill 來解決,如果仍然無法解決,請提交 issue。
Node.js 相容性
以下僅適用於在 Node.js 環境中運行 Web SDK 的情況,並不適用於那些基於 Node.js 使用建構工具在瀏覽器中運行 Web SDK 的情況。
Web SDK 可以在 Node.js 環境中運行,支援的版本為 v18.17.0 及之後的版本。
主要功能
- 頁面與元素順序:頁面儲存在
pages中,可繪製物件儲存在每個頁面的elements中,兩個層級都使用明確的順序陣列。 - 畫布元素:處理文字、圖形、圖片、連接線、群組、容器與泳道圖。
- 命令驅動的編輯:讓元素變更、順序與父子關係統一經過命令層,並提供權限及選用歷程與協同作業整合所需的掛鉤。
- 瀏覽器畫布:算繪元素,並提供選取、變形、剪貼簿、文字編輯、檢視區控制與面板功能。
- 可擴充的配接器:加入表格、心智圖、圖表、資源、列印與交換等選用 Boards 功能。
- 持久化:建立、還原與儲存包含頁面、資源、主題及使用中頁面狀態的
IBoardData快照。
如何使用這些文件
在螢幕的左側是文件導航欄。文件頁面按從基礎到高階的順序組織,你可以按照這個順序循序漸進地瞭解 Web SDK,或者跳到你感興趣的章節。你還可以在側邊欄的頂部切換 Univer Boards 的文件。
螢幕的右側是當前頁面的大綱。如果你需要快速找到頁面,可以使用頂部的搜尋欄或搜尋快捷鍵(Ctrl+K 或 Cmd+K)。
我們推薦從 快速開始 出發瞭解 Web SDK。
前置知識
儘管我們已經盡力使得文件對新手也易於理解,但是我們必須假設你在開始閱讀之前已經瞭解了一些基礎知識,以便我們的文件可以專注於 Web SDK。
為了充分利用我們的文件,建議你對 JavaScript 及其生態系統有基本的瞭解。
如果你有興趣在 Node.js 上執行 Web SDK,你還應該對 Node.js 有基本的瞭解。
需要協同編輯、共享歷史或評論、檔案轉換時,請在業務後端按需組合 Univer Server SDK 模組,並自行接入身分驗證、權限、儲存及部署。僅使用瀏覽器編輯功能時,無需建立這些服務。
擴充 Univer Boards
在設計之初,Web SDK 就被設計為高度可擴充的,因此你可以根據自己的需求來客製化它。
你覺得這篇文檔如何?