Skip to main content
Interwork Corporation
IDR Solutions Product Support Portal
PDF開発用語集 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動

PDF annotations API reference

PDF annotations APIリファレンスは、PDFドキュメント内のインタラクティブ要素を作成、変更、管理するためのプログラマティックインターフェースを提供します。

カテゴリ: General PDF Concepts
キーワード: pdf annotations api reference, PDF annotations API reference

概要

PDF annotations APIリファレンスは、PDFドキュメント内のインタラクティブ要素を作成、変更、管理するためのプログラマティックインターフェースを提供します。 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で定義されているように、annotationsは基礎となるコンテンツを変更することなくPDFページに追加できるオブジェクトです。これらのAPIにより、開発者はコメント、ハイライト、フォームフィールド、マルチメディア要素などの機能を実装できます。annotation APIの理解は、インタラクティブなPDFアプリケーションやドキュメント共同作業ツールを構築する上で不可欠です。

定義

PDF annotations APIリファレンスは、PDFのannotationオブジェクトをプログラマティックに操作するために利用可能なメソッド、クラス、関数を記述した包括的なドキュメントです。 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) によれば、annotationsはページコンテンツとは区別され、独自のappearance streamとプロパティを保持します。APIリファレンスは通常、テキストannotations(メモやコメント)、マークアップannotations(ハイライト、下線、取り消し線)、インタラクティブannotations(リンクやボタン)、widget annotations(フォームフィールド)、マルチメディアannotations(音声、動画、3Dオブジェクト)など、様々なannotationタイプをカバーしています。ページのcontent streamを変更する直接的なコンテンツ操作APIとは異なり、annotation APIは、基礎となるドキュメント構造に影響を与えることなく表示切替、変更、削除が可能なインタラクティブ要素の独立したレイヤーを扱います。この分離により、annotationsはレビューワークフロー、 ( Citation: N.A., (N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html ) で参照されているアクセシビリティの強化、共同編集シナリオに特に適しています。

重要性

PDF処理アプリケーションを構築する開発者にとって、annotation APIはユーザーエンゲージメント機能と共同作業ワークフローを実装するために重要です。これらのAPIにより、複数のユーザーが元のコンテンツを変更することなくコメントやマークアップを追加できるドキュメントレビューシステムの作成が可能になり、コミュニケーションを促進しながらドキュメントの整合性を維持できます。Annotationsはフォーム処理アプリケーションにも不可欠で、widget annotationsがユーザーが入力できるインタラクティブフィールドを表現します。アクセシビリティに重点を置いた開発では、annotation APIの理解により、インタラクティブ要素が ( Citation: N.A., (N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html ) などの標準に準拠し、支援技術によって適切に解釈されることを保証できます。さらに、annotation APIにより、開発者はPDF内でリッチなマルチメディア体験を作成し、インタラクティブなトレーニング資料を埋め込み、ドキュメント署名ワークフローを構築できます。annotationsをプログラマティックに操作する機能は、手動処理時間を削減し、大規模な自動ドキュメントワークフローを可能にします。

仕組み

PDF annotation APIは、 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で規定されているように、ページのAnnots配列から参照されるannotation dictionaryを作成・操作することで動作します。各annotationタイプには、annotation subtype、境界矩形座標、外観特性、動作フラグなど、dictionaryで定義された特定の必須および任意のプロパティがあります。これらのAPIを使用する際、開発者は通常、特定のsubtypeを持つannotationオブジェクトのインスタンス化(例:Text、Highlight、Widget)、色、不透明度、作成者、コンテンツなどのプロパティの設定、矩形座標によるannotationの位置と寸法の定義、annotationのレンダリング方法を定義するappearance streamの添付などの操作を実行します。APIは、appearance生成、座標系変換、PDF構造更新の複雑さを処理します。高度なannotation APIは、annotation states(レビューワークフロー用)、ポップアップの関連付け(コメントとポップアップウィンドウのリンク)、アクショントリガー(ユーザーがannotationsと対話したときにJavaScriptやナビゲーションコマンドを実行)などの機能もサポートしています。最新のPDFライブラリの多くは、直接的なdictionary操作のための低レベルAPIと、一般的なannotationタスクのための高レベルの便利なメソッドの両方を提供し、開発者がユースケースに適した抽象化レベルを選択できるようにしています。

関連用語

  • PDF content streams – annotationsが重なる基礎となるページコンテンツで、静的なドキュメント構造を表現します
  • Interactive forms – ユーザーのデータ入力と送信を可能にするwidget annotationsの集合
  • Appearance streams – annotationsがページ上で視覚的にどのようにレンダリングされるかを定義するForm XObject
  • PDFアクセシビリティ – PDFドキュメントを支援技術で利用可能にするための標準と技術で、多くの場合適切なannotationタグ付けが含まれます
  • PDFアクション – annotationsとの対話やドキュメントイベントによってトリガーされるプログラマティックな動作

出典

(N.A.) (2020)
(N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html
(N.A.) (2014)
(N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html