Annotations JSON API – アノテーションJSON API
このドキュメントでは、annotations.jsonファイルの構造について説明します。 BuildVuで注釈がどのように機能するかについて詳しくは、”BuildVuで注釈はどのように機能しますか？“をご覧ください。
IDRViewer内で使用されるアノテーションの読み込みと表示のためのシンプルな実装を提供します。この実装は、提供されるままに、あるいはインスピレーションのために、あるいは独自のカスタムソリューションの基礎として、ご自由にお使いください。
基本構造：
{
"pages": [{
"page": 1,
"annotations": [{
"type": "Highlight",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"contents": "contents value", (optional)
"appearance": "1/annots/255.png" (optional)
}
]
}
]
}
アノテーション(注釈)タイプ ("type")：テキスト、リンク、フリーテキスト、線、正方形、円、多角形、ポリゴン、ハイライト、下線、波線、取り消し線(ストライクアウト)、スタンプ、キャレット、インク、ファイル添付ファイル、サウンド、ムービー、ウィジェット、画面、透かし、 TrapNet、ウォーターマーク、3D、プロジェクション、RichMedia、スクリーン、TextLink
境界 ("bounds")：左上の原点を使用して[x、y、幅、高さ]の形式で提供されます。
オブジェクト参照("objref")：PDFファイル内の注釈のオブジェクト参照。
オブジェクト参照は、次の2つの状況では使用できません。
- まれに、注釈がインライン配列を使用して定義されている場合。
- PDFファイルから検出されたリンクからTextLinkアノテーションが生成される場合。
コンテンツ ("contents")：通常、ポップアップ注釈のプレーンテキストコンテンツまたは注釈の説明（提供されている場合）。
外観 ("appearance")：「通常」状態の外観（AP）ストリームのラスタライズバージョン（APディクショナリが提供されている場合）。
タイプ固有の値：
ポップアップのタイプ： テキスト(ノート)、ライン、矩形、円(楕円形)、多角形、折れ線、ハイライト、下線、波状下線、取り消し線(ストライクアウト)、ゴム印(スタンプ)、キャレット(校正記号)、インク(フリーハンド)、ファイル添付、プロジェクション、墨消し(黒塗り)
(Text, Line, Square, Circle, Polygon, PolyLine, Highlight, Underline, Squiggly, StrikeOut, Stamp, Caret, Ink, FileAttachment, Redact, Projection)
{
"type": "Highlight",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"title": "title value", (optional)
"contents": "contents value", (optional)
"appearance": "1/annots/255.png" (optional)
}
リンクのタイプ：Link, TextLink, Widget
{
"type": "Link",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"title": "title value", (optional)
"contents": "contents value", (optional)
"action": { }, (optional)
"appearance": "1/annots/255.png" (optional)
}
アクション固有の値
アクションのタイプ：URI, GoTo, Named, Sound
URI:
"action": {
"type": "URI",
"uri": "https://www.example.com"
}
GOTO:
"action": {
"type": "GoTo",
"page": 1
}
NAMED:
"action": {
"type": "Named",
"name": "NextPage"
}
Name types: NextPage, PrevPage, FirstPage, LastPage
LAUNCH:
"action": {
"type": "Launch",
"target": "executable/or/file/path.pdf"
}
SOUND:
"action": {
"type": "Sound",
"sound": "path/to/sound.wav"
}
FileAttachment:
{
"type": "FileAttachment",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"title": "title value", (optional)
"contents": "contents value", (optional)
"attachment": "<a href="https://pub.dev/packages/path" target="_blank" title="A string-based path manipulation library. All of the path operations you know and love, with solid support for Windows, POSIX (Linux and Mac OS X), and the web." hreflang="en-us">path</a>/to/file",
"filename": "attachment.pdf",
"appearance": "1/annots/255.png" (optional)
}
RichMedia:
{
"type": "RichMedia",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"contents": "contents value", (optional)
"richmedia": [{
"src": "path/to/media.mp4",
"type": "video/mp4"
}],
"appearance": "1/annots/255.png" (optional)
}
サポートするビデオタイプ: m4v, mov, mp4 (video/mp4)
サポートするオーディオタイプ: mp3 (audio/mpeg)
Screen:
{
"type": "Screen",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"action": {
"type": "Rendition",
"media": {
"src": "path/to/media.mp4",
"type": "video/mp4",
"filename": "named-media.mp4" (optional)
}
},
"appearance": "1/annots/255.png" (optional)
}
サポートするメディアタイプ: mp4 (video/mp4), mp3 (audio/mpeg)
Sound:
{
"type": "Sound",
"bounds": [0, 0, 100, 100],
"objref": "255", (optional)
"title": "title value", (optional)
"contents": "contents value", (optional)
"sound": "path/to/sound.wav",
"appearance": "1/annots/255.png" (optional)
}
サポートするメディアタイプ: wav