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.