Univer PDFs API
通过 PDF Facade API 创建、查找、保存、进入和卸载 PDF 单元。
PDF Facade 为 FUniver 增加了 PDF 单元和页面入口。创建 API 对象之前,应先导入副作用入口。
启用 PDF Facade
TypeScript
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/pdfs/facade'const univerAPI = FUniver.newAPI(univer)在 Univer 实例上注册 UniverPdfsPlugin,应用即可承载 PDF 单元。
创建、查找和保存 PDF 单元
省略 document 时,createPdf() 会创建一个仅含一张空白 A4 页面的单元。如需恢复单元,应传入之前 save() 返回的快照。
TypeScript
const pdf = univerAPI.createPdf({ id: 'project-brief', name: 'Project brief',})const activePdf = univerAPI.getActivePdf()const samePdf = univerAPI.getPdf(pdf.getId())const snapshot = pdf.save()更新运行中的 PDF 时,应使用 Facade 方法或命令。保存的快照是独立的持久化数据。
进入页面
FPdfPage 是访问页面可编辑叠加层和导入原生文本的常用入口:
TypeScript
const firstPage = pdf.getPageByIndex(0) ?? pdf.insertPage()const elements = firstPage.getElements()const nativeText = firstPage.getTextSpans()具体操作请参阅页面与元素、文本与列表、表格、图片与分隔线或批注与原生文本。
卸载 PDF 单元
不再需要某个 PDF 单元时,应按 ID 卸载。仅在销毁整个应用时,才释放根 univer 实例。
TypeScript
const pdf = univerAPI.getActivePdf()if (pdf) { univerAPI.disposeUnit(pdf.getId())}准确的签名与返回类型请参阅 PDF Facade 参考。
你觉得这篇文档如何?