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)

アプリケーションで PDF ユニットを扱えるように、Univer インスタンスへ UniverPdfsPlugin を登録します。

PDF ユニットを作成、取得、保存する

document を省略すると、createPdf() は空白の A4 ページを 1 枚持つユニットを作成します。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 リファレンスを参照してください。

このガイドはいかがですか？