注釈
ビューアに注釈サポートを追加
Doconut の注釈は 2 つの方向で機能します。ユーザーはブラウザウィジェットで描画し、サーバーがページごとに永続化するか、またはコードでプログラム的に構築してオープンセッションにロードします。どちらの場合もページ上に表示され、PDF/PNG エクスポートに焼き込むことができます。
注釈サポートは Annotation ライセンス機能によって制御されます(アクティブな Temporary ライセンスの下で自動的に付与されます)。
注釈 UI を有効にする
注釈は Viewer のモジュールであり、スタンドアロンのツールバーではありません。完全なページには Viewer リソース、Viewer ツールバー、Viewer のマウント、そして初期化された objViewer が含まれる必要があります。その後、Annotation Ribbon がマウントされ、同じインスタンスに添付されます。
注釈バンドルを Viewer バンドルと同時に出力します — これらはライセンスで制御されるため、機能が利用可能なときだけタグが表示されます:
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeViewerCss = true,
IncludeAnnotationCss = true // jquery-ui.min.css + annotationBar.css
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeViewerScripts = true,
IncludeAnnotationScripts = true, // jquery-ui, raphael.js, annotation.js
IncludeAnnotationBar = true // 埋め込まれたアノテーションリボン
}))マークアップ内で完全な Viewer 構成が見えるように保ちます:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Viewer controls, Annotation を開くボタンを含む -->
</nav>
<div id="annBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>Annotation バンドルは annBarMount 内に Ribbon の DOM を生成します。ボタンやダイアログのマークアップをコピーする必要はありません。まず docViewer を初期化し、サーバーが注釈がライセンスされていることを確認したときにのみ Ribbon を作成します:
<script>
let annBar = null;
let currentToken = '';
const objViewer = $('#div_ctlDoc').docViewer({
BasePath: '/',
ResPath: 'doconut-res/images',
onAnnLoaded: () => annBar?.handleAnnLoaded(),
onAnnSaved: () => annBar?.handleAnnSaved(),
onAnnSaveError: () => annBar?.handleAnnSaveError(),
onAnnClosed: () => annBar?.handleAnnClosed(),
onError: (message) => console.error('Viewer error:', message)
});
@if (Viewer.IsAnnotationEnabled)
{
<text>
annBar = $('#annBarMount').doconutAnnotationBar({
docId: 'ctlDoc',
getRequestParams: () => ({ token: currentToken }),
onStatus: (message) => console.log(message),
onToast: (message, type) => console.log(type, message),
onLayout: () => requestAnimationFrame(() => objViewer.Refit())
});
annBar.attach(objViewer);
</text>
}
</script>機能がない場合、ReferenceScripts は Ribbon のスクリプトを除外するため、サーバー側の if が保護されていない doconutAnnotationBar(...) 呼び出しがページを壊すのを防ぎます。
Ribbon からの保存はミドルウェア (AnnSave) を通じてデータを投稿し、ページごとのドキュメントセッションに保存します。ロード (AnnLoad) は注釈があるページがレンダリングされると自動的に行われます。4 つの onAnn* コールバックが Ribbon と Viewer のライフサイクルを同期させます。
任意のホスト所有 Viewer ツールバーから開閉できます:
annBar.open();
annBar.close();公開されている Ribbon API は次のとおりです:
| メソッド | 目的 |
|---|---|
attach(objViewer) | 初期化された Viewer に Ribbon を接続します;一度だけ必要です |
open() / close() | 注釈編集モードに入るまたは退出する |
reset() | Ribbon を閉じた編集なしの状態に戻します |
isOpen() / annotating() | Ribbon の状態 / Viewer の注釈編集状態を取得します |
reopenEditable() | 現在のページの注釈を編集可能なオブジェクトとして再読み込みします |
updateActionState() | ホストの変更後に保存/削除コントロールの利用可能性を更新します |
headerSlot() | ホスト所有コントロール用のオプションヘッダー拡張スロットを取得します |
onStatus、onToast、onLayout、onEditStart、および onEditEnd はオプションのホストコールバックです。endpoints オブジェクトはさらに exportPdf、exportPng、imageUpload、imageList を提供できます;設定されたエンドポイントがないコントロールは非表示のままです。
統合された Viewer、Search、Annotation の起動シーケンスについては、クイックスタート を参照してください。
注釈バンドルはブラウザの作成ツールを追加しますが、データはトークンで識別されるサーバー側のドキュメントセッションに属したままです。ソースを再度開くと新しいセッションが作成されます。セッションの存続期間を超えて注釈を保持する必要がある場合は、XML またはエンコードされた注釈エンベロープをアプリケーションに永続化してください。
コールバックの2種類、2通りの接続方法
アノテーションコードは2つのコールバックスタイルを使用し、相互に接続した場合はそれぞれが黙って失敗します。
onAnnLoaded,onAnnSaved,onAnnSaveError,onAnnClosedはdocViewer({...})の オプション であり、すべてのビューアコールバックと同様です。Created,Changed,Deleted, およびPropertiesは 名前で見つかるグローバル関数 です: ビューア ID がイベント名にプレフィックスされます。#div_ctlDocのビューアの場合、ID はctlDocで、関数はctlDoc_Created、ctlDoc_Changed、ctlDoc_Deleted、ctlDoc_Propertiesです。綴りミスや名前変更された関数は呼び出されません。
SaveAnnotations() は保存されたかどうかを返しません: 結果は onAnnSaved または onAnnSaveError を通じて届きます。戻り値を読むコードは「未保存の変更」フラグをクリアしません。
C# でアノテーションを作成
オープンセッションにバインドされたマネージャを取得し、アノテーションを追加して、ロードします(タイプには using Doconut.Annotations;、Rectangle/Color 用には using System.Drawing; を使用)。
app.MapPost("/api/annotations/load-sample", (string token, Viewer viewer) =>
{
// 開いているセッションのページ寸法にバインドされます
var manager = viewer.GetAnnotationManager(token);
var pageCount = viewer.GetPageCount(token);
// ページごとに1つのスタンプ
for (int page = 1; page <= pageCount; page++)
{
manager.Add(new StampAnnotation(page, new Rectangle(30, 20, 240, 90),
$"PAGE {page}", 28, 4, Color.Maroon)
{
Opacity = 60,
Rotate = -8
});
}
manager.Add(new NoteAnnotation(1, new Rectangle(420, 150, 220, 120),
"Loaded from C# code.", Color.FromArgb(255, 255, 255, 170), 14));
// セッションにロードします — ウィジェットは AnnLoad を介してそれらを取得し、
// レンダラーはそれらを画像/PDF エクスポートに焼き込みます。
viewer.LoadAnnotationData(token, manager);
return Results.Ok();
});アノテーションタイプ
すべてのタイプは Doconut.Annotations にあり、BaseAnnotation を継承します(ページ番号 + バウンディング Rectangle)。
| タイプ | 備考 |
|---|---|
StampAnnotation | フォントサイズ、枠線、色を持つテキストスタンプ;Opacity、Rotate をサポート |
NoteAnnotation | テキスト、背景色、フォントサイズ、TitleColor を持つ付箋 |
RectangleAnnotation | 枠線と塗りつぶし色、Title/ShowTitle |
CircleAnnotation | 枠線と塗りつぶし、ShowBorder |
EllipseAnnotation | 枠線と塗りつぶし、ShowBorder |
TriangleAnnotation | 枠線色、BackColor、ShowBorder |
LineAnnotation | 幅と色を持つ直線 |
ArrowAnnotation | 矢じり付きの線;設定可能な Direction(タイプ ArrowDirection、コンパスポイント、デフォルト E) |
FreehandAnnotation | エンコードされた FreehandData ポイントからのフリーストローク |
ImageAnnotation | URL からの画像。相対 URL はアノテーション追加時にリクエストホストに対して解決されます;サーバは画像を焼き込み時にのみ取得します — 以下のエクスポート注記を参照してください |
AnnotationManager API(アノテーションマネージャ)
| メンバー | 目的 |
|---|---|
Add(BaseAnnotation) | アノテーションをキューに入れる |
GetAnnotations() / GetAnnotations(int page) | マネージャが保持しているものを検査する |
ClearAnnotations() / ClearAnnotations(int page) | すべて削除 / ページ単位で削除 |
GetAnnotationData() / GetAnnotationData(int page) | エンコードされたアノテーションデータ文字列 — ウィジェットが使用する Base64 ワイヤエンベロープ |
GetAnnotationXml() | XML 形式 |
Viewer はセッションに対するロード/読み取り操作を反映します: LoadAnnotationData(token, manager) または LoadAnnotationData(token, encodedData)(GetAnnotationData() からの Base64 ワイヤエンベロープ)、LoadAnnotationXML(token, xml)、GetAnnotationXML(token)。
アノテーションを焼き込んだエクスポート
// 注釈がレンダリングされたすべてのページの PDF
app.MapGet("/api/annotations/export-pdf", async (string token, Viewer viewer) =>
{
byte[] pdf = await viewer.ExportAnnotationsToPdfAsync(token, zoom: 100);
return Results.File(pdf, "application/pdf", "export.pdf");
});
// またはページごとの PNG の ZIP
app.MapGet("/api/annotations/export-png-zip", async (string token, Viewer viewer) =>
{
byte[] zip = await viewer.ExportAnnotationsToPngZipAsync(token, zoom: 100);
return Results.File(zip, "application/zip", "annotations-png.zip");
});エクスポートは画面上のレンダリングと同じバーナーを使用するため、ユーザーが見るものがファイルに含まれるものと同じです — ただし次に説明する画像アノテーションは除きます。
社内ネットワークホストでの画像注釈が「Image blocked」としてエクスポートされる
ビューアとエクスポートは、ImageAnnotation の画像を異なる場所から取得します:
| 対象 | 画像をダウンロードする主体 | 社内ネットワークまたは開発ホスト上 |
|---|---|---|
| ブラウザ内のビューア | ユーザーのブラウザ | 画像が表示される |
ExportAnnotationsToPdfAsync / …PngZipAsync | サーバー | 赤い "Image blocked" プレースホルダー |
サーバーが画像を取得して埋め込む際、プライベートネットワークへ戻るアドレスは拒否されます:ループバック (localhost, 127.0.0.1)、0.0.0.0、リンクローカル (169.254.x.x)、プライベート範囲 10.x、172.16–31.x、192.168.x、キャリアグレード NAT (100.64.0.0/10)、および IPv6 のリンクローカルとユニークローカルアドレスです。これにより、細工された画像 URL を通じて内部システムへアクセスさせることからサーバーを保護し、オフにするスイッチはありません。
相対画像 URL は現在のリクエストのホストに対して解決されるため、localhost 上、社内サーバー上、またはプライベートアドレスでアクセスされたサイト上では、画像はビューアに表示され、エクスポートには代わりにプレースホルダーが入ります。これはガードが機能しているのであって、描画失敗ではありません。エクスポートに画像を含める必要がある場合は、パブリックアドレスを持つホストから提供し、絶対 URL を使用してください。解決できないホスト名も同様に拒否され、その他のダウンロード失敗時は画像の代わりに URL とエラーメッセージが赤で表示されます。
永続化ワークフロー
- ドキュメントを開き、トークンを取得します。
- 以前に保存された XML またはエンコードされたデータをそのトークンにロードします。
- ウィジェットにセッション注釈を読み取り・編集させます。
GetAnnotationXML(token)を使用して、アプリケーションが永続化を決定したときに XML を取得します。- フラット化された成果物が必要な場合は PDF/PNG をエクスポートします。
- ドキュメントセッションを閉じます。
不透明なビューアトークンを永続的な注釈識別子として使用しないでください。永続化された注釈データは、独自のドキュメントおよびバージョン識別子と関連付けてください。
セキュリティとレンダリングに関する注意事項
- 注釈リクエストは、ページリクエストと同じセッション/トークンのセキュリティを使用します。
- サーバー側リクエスト偽装を防ぐため、ユーザー提供の画像 URL を検証・制御してください。
- エクスポートは、画面上のページレンダリングと同じライセンス/カスタム透かしの決定を適用します。
- 大きなフリーハンドペイロードや高解像度エクスポートはメモリ使用量を増加させます。実際的なドキュメントとズーム値でテストしてください。
トラブルシューティング
| 症状 | 確認項目 |
|---|---|
| 注釈リボンが表示されない | Annotation 機能と4つの注釈 CSS/スクリプトフラグ |
| 保存コールバックがエラーを報告する | トークン/セッションの期限切れとミドルウェア BasePath |
ctlDoc_Created(または別のイベント関数)が実行されない | 関数名は:viewer id + _ + event として、グローバル関数で定義してください |
| C# の注釈が表示されない | ページ番号が1から始まり、データがアクティブなトークンにロードされていることを確認してください |
| 画像注釈が画面上には表示されるがエクスポートに含まれない | 画像のホストがプライベートまたはループバックアドレスであるためです — 上記参照 |
| 再度開いたドキュメントに注釈がない | ビューアセッション外で XML/データを永続化し、新しいトークンにロードしてください |
このページは役に立ちましたか?