ViewerConfig

ViewerConfig（名前空間 Doconut）は、ブラウザビューアの外観と動作を記述します。ドキュメントのレンダリング品質には影響しません；そのためにはフォーマット設定を使用してください。C# クラスと長年使用されている JavaScript ウィジェットはデフォルトが異なるため、値は明示的にマッピングしてください。

このリリースのクライアント側変更2つは黙って失敗します。 ハンドラ関数はオプションとして渡されます — ウィジェットはもはやコンテナ ID からグローバル関数名を導出しません — そして ResPath はアプリケーションルートではなくリソースプレフィックスを指す必要があります。どちらもサーバーは正常に動作し続け、ブラウザコンソールには何も報告されません。前のライブラリからページを引き継いでいる場合は、まず コールバック と パスチェックリスト をお読みください。

C# プロパティ

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // 先頭に '/' を付けない: ビューアが自動で付加します（"/doconut" は //doconut になり、別のホストになります）
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# から JavaScript へのマッピング

ViewerConfig を直接シリアライズしたまま docViewer(...) に渡さないでください。ほとんどのウィジェットキーはキャメルケースですが、パス/フィットに関する確立された 3 つのキーはパスカルケースです。

JavaScript のデフォルト

ウィジェットには C# クラスとは異なる古いデフォルトがあります。以下の値は現在の docViewer.js 実装から取得したものです。

デフォルトのいずれかに依存せず、動作上重要なすべての値を設定してください：

<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad: false,
    autoFocus: true,
    autoPageFocus: true,
    pageZoom: 100,
    zoomStep: 10,
    maxZoom: 300,
    FitType: 'width',
    cacheEnabled: false,
    largeDoc: false,
    showHyperlinks: true,
    fixedZoom: true,
    fixedZoomPercent: 100,
    fixedZoomPercentMobile: 75,
    BasePath: 'doconut',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

コールバック

コールバックは高速に保ち、テレメトリは非同期で送信し、ページのレンダリングをブロックしないでください。

これらはすべて初期化オブジェクトのオプションです。 以前のビューアは、コンテナ ID から導出した名前のグローバル関数を検索していました — <div id="div_ctlDoc"> を持つページは function ctlDoc_OnViewerReady() を宣言するだけで済みました。その検索は廃止されました。関数を明示的に渡してください：

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... 既存のオプション ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // 名前で見つかっていました
    onViewerReady:    ctlDoc_OnViewerReady,     // 名前で見つかっていました
    onCopy:           ctlDoc_Copy,              // ctlDoc_Copy(text) が呼び出されていました
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // ctlDoc_AutoLoadStatus(page) が呼び出されていました
});

古い検索は空の catch でラップされていたため、何も報告されませんでした。このリリースでは関数は単に実行されません。一般的な症状は、onViewerReady が非表示にするハンドラだったため、停止しないビジー スピナーが表示され続けることです。背後のドキュメントは正しくレンダリングされています。

リンククリックのコールバックはありません — ハイパーリンクの処理は組み込みで、showHyperlinks によって制御されます。

パブリックメソッドグループ

JavaScript ファイルには内部ヘルパーも含まれています。ここや機能ガイドで文書化され、リファレンス UI が使用するメソッドだけを、安定した統合ポイントとして扱ってください。

分散ページがまだレンダリング中の間のリトライ

retryOn409 は歴史的な名前を保持しています。これは非同期ページ生成用で、現在の 202 Accepted 準備完了レスポンスと、従来の 409 Conflict シグナルの両方をリトライします。有効化すると、ウィジェットは以下の JavaScript デフォルトでポーリングします。

通常のシングルノードビューアでは無効のままにしてください。有効化しても、サポートされていない同期レンダリングを非同期に変えることはできません。

FirstPagePriority を使用した共有ストレージからページが提供され、後続のページが書き込まれるまで正当に 202 Accepted を返す場合に有効にしてください。リトライしないクライアントは、まだレンダリング中のページでタイルが壊れた状態になります — 詳細は分散デプロイメントをご覧ください。

パスチェックリスト

• DoconutOptions.MiddlewarePath は、実際にマッピングするブランチを記述する必要があります。
• BasePath はそのブランチを対象とし、先頭の / を付けずに記述します（'doconut'、'/doconut' ではなく：ビューアがスラッシュを付加し、//doconut/... は別ホストへのリクエストになります）。リファレンスアプリケーションは MapWhen ブランチ上で歴史的な DocImage.axd リクエスト形状を保持しているため、BasePath: '/' を設定します。
• DoconutOptions.ResourcesPath は埋め込みリソースのルートです。
• ResPath は通常、先頭の / を付けずにその images サブフォルダを対象とします（デフォルトプレフィックス付きで 'doconut-res/images'）。以前のライブラリでは空の ResPath が正しかったため、リソースはアプリケーションルートから取得されていましたが、こちらでは正しくなく、エラーなしで失敗します。
• ExtractHyperlinks は、showHyperlinks が何かを表示できるようになる前に、サーバーフォーマット設定で有効にする必要があります。