基本概念
安装 Univer PDFs 之前,请先了解构成 PDF 集成基础的四个概念:
- 插件 Plugin
- 快照与数据模型 Snapshot and Data Model
- 命令 Command
- Facade API
基本概念
插件
Univer PDFs 由插件组合而成。UniverPdfsPlugin 注册 UNIVER_PDF 单元模型和可持久化的 PDF 命令。UniverPdfsUIPlugin 提供浏览器查看器,并默认启用编辑控件。打印、交换或协同等可选包只需按产品需求添加。
这些插件运行在 Univer 共用的核心、渲染、设计和 UI 服务之上。它们是 PDF 应用的技术依赖,不要求你使用过其他 Univer 品类。
快照与数据模型
一个 PDF 单元以 IPdfUnitData 快照持久化。document 是导入的或空白的源基线,已接受的编辑则保存在 editState 中,不会直接重写该基线。
使用 pdf.save() 获取完整的当前快照。pdf.getDocument() 返回源基线,因此持久化用户编辑时应使用 save()。
命令
运行时的数据变更通过命令执行,使校验、视图更新、编辑历史和导出意图进入同一条变更链路。PDF Facade 方法会为你准备参数并执行对应命令。
注意
不要直接修改运行中 PDF 单元的快照或源文档。请使用 PDF Facade 方法或已注册的命令。
Facade API
在核心 Facade 入口之后导入 @univerjs-pro/pdfs/facade,即可把 PDF API 扩展到 FUniver。该入口提供 createPdf()、getActivePdf() 和 getPdf() 等方法。
完整配置与示例请参阅使用 PDF Facade API。
接下来阅读安装和基本使用。
你觉得这篇文档如何?