基本概念
以下四个概念出现在每一处 PDF 集成中,安装 Univer PDFs 之前应先了解:
- 插件 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,即可为 FUniver 添加 PDF API。该入口提供 createPdf()、getActivePdf()、getPdf() 等方法。
完整的配置方式和示例见使用 PDF Facade API。
接下来请阅读安装和基本使用。
你觉得这篇文档如何?