ViewerConfig

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

C# プロパティ

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = the DocImage.axd handler at the site root (Web.config)
    ResPath = "doconut-res/images", // the images folder under ResourcesPath, no leading '/'
    ShowHyperlinks = true
};
// Emit it with viewer.RenderViewer("viewerEl", token, config) - see the Viewer reference.

viewer.RenderViewer("viewerEl", token, config) で出力します - Viewer のリファレンスを参照してください。

RenderViewer を使用した ViewerConfig の生成

Viewer.RenderViewer(elementId, token, config) は ViewerConfig をウィジェットの初期化スクリプトに変換します。上記のプロパティのうち 6 つ（BasePath、ResPath、ShowThumbs、AutoLoad、PageZoom、FitType）を書き出し、その後 View(token) を呼び出します。他のプロパティは書き出されません。MaxZoom、ShowHyperlinks、ズーム設定、またはコールバックについては、以下の JavaScript オプションでウィジェットを自分で初期化してください。RenderViewer の詳細は ビューア を参照してください。

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

ViewerConfig を直接シリアライズした状態で docViewer(...) に渡さないでください。ほとんどのウィジェットキーは camelCase ですが、パス/フィットに関する 3 つのキーは PascalCase です。

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: '/',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

コールバック

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

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

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

リトライオプション

ウィジェットは retryOn409 とそのバックオフ設定（retryInitialDelayMs、retryBackoffFactor、retryMaxDelayMs、retryMaxAttempts、retryMaxTotalMs）も受け付けます。これらはページがバックグラウンドで生成されるデプロイに役立ちます。DocImage.axd はリクエスト中にすべてのページをレンダリングするため、retryOn409 はオフにしてください。

パスチェックリスト

• BasePath は DocImage.axd ハンドラがサイトルートにある場合は '/' です — Web.config のハンドラの path 属性が応答先を決定します。仮想ディレクトリの場合は、先頭の / を付けずにディレクトリ名を使用します（'myapp'、'/myapp' ではなく：ビューアがスラッシュを追加し、//myapp/... は別ホストへのリクエストになります）。
• DoconutOptions.ResourcesPath はリソースモジュールが埋め込みファイルを提供する場所です（デフォルトは /doconut-res）。
• ResPath はその images サブフォルダを対象とします。こちらも先頭の / を付けません（'doconut-res/images'）。'doconut-res' を指定すると、すべてのアイコンが 404 になり、ドキュメントはまだレンダリングされます。
• MVC では、ResourcesPath を変更した場合、routes.IgnoreRoute("doconut-res/{*pathInfo}") をそれに続ける必要があります。
• ExtractHyperlinks は showHyperlinks が何かを表示できるようになる前に、サーバーフォーマット設定で有効にしなければなりません。