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",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

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

Do not pass a directly serialized ViewerConfig to docViewer(...). Most widget keys are camelCase, while three established path/fit keys are PascalCase.

JavaScript デフォルト

The widget has older defaults that differ from the C# class. The following values come from the current docViewer.js implementation.

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

<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({
    // ... your existing options ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // was found by name
    onViewerReady:    ctlDoc_OnViewerReady,     // was found by name
    onCopy:           ctlDoc_Copy,              // was ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // was ctlDoc_AutoLoadStatus(page)
});

古い検索は空の catch でラップされていたため、何も報告されませんでした。このリリースでは関数は単に実行されません：一般的な症状は、onViewerReady が隠すはずだったスピナーが止まらないことです。背後の文書は正しくレンダリングされています。

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

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

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

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

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

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

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

パスチェックリスト

• DoconutOptions.MiddlewarePath は実際にマップするブランチを記述する必要があります。
• BasePath はそのブランチを指す必要があります。リファレンスアプリケーションは MapWhen ブランチ上で歴史的な DocImage.axd リクエスト形態を保持しているため、BasePath: '/' を設定しています。
• DoconutOptions.ResourcesPath は埋め込みリソースのルートです。
• ResPath は通常その /images サブフォルダを指します — デフォルトプレフィックスで 'doconut-res/images'。以前のライブラリではリソースがアプリケーションルートから提供されていたため空の ResPath が正しかったですが、ここでは正しくなく、エラーなしで失敗します。
• ExtractHyperlinks はサーバー側のフォーマット設定で有効にする必要があり、そうしないと showHyperlinks が何も表示できません。