API 參考

API 概覽

查找 API、設定功能套件,開始使用 Univer Office SDK。

透過 Facade API 在應用程式中讀取與修改 Office 內容。你可以依產品查找介面,也可以從下方的初始化與外掛設定入口開始。

試用 API

先完成安裝與基本使用。初始化 Sheets 編輯器並取得 createUniver 傳回的 univerAPI 後,下列程式碼會向 A1 儲存格寫入內容:

TypeScript
const workbook = univerAPI.getActiveWorkbook()const worksheet = workbook?.getActiveSheet()worksheet?.getRange('A1').setValue('Hello, Univer!')

univerAPI 是 FUniver 執行個體。在 Sheets 中,從活頁簿進入工作表,再取得儲存格範圍。外掛模式的初始化方式與功能套件的 Facade 匯入方式,請見 Facade API 基礎。

依用途查找

用途參考文件
執行個體、生命週期與通用操作FUniver
活頁簿、工作表與儲存格FWorkbook · FWorksheet · FRange
文件與文字FDocument
簡報Slides
畫板Boards
多維表格Bases
PDF 內容PDF
事件Events
協同編輯Collaboration
留言Comments
儲存格值、範圍、樣式與產品快照資料型別
內容格式與初始化常數常用列舉 · Facade 列舉目錄

初始化與設定

Univer 提供預設模式與外掛模式兩種整合方式。預設模式透過預先組合好的外掛簡化設定,更容易上手;如果需要深度擴充,建議使用外掛模式,依需求組合與設定外掛。

在側欄 功能套件 → Plugins 中查看各外掛的設定。createUniver 與 Presets 仍可用於便捷地載入預先組合好的外掛。

伺服器端與 AI 整合

後端協同與檔案轉換請從 Server SDK 開始;CLI 工作流程與 AI Agent 內容操作請從 AI SDK 開始。

你覺得這篇文檔如何?

© 2026 DreamNum Co., Ltd.