ViewerConfig – Doconut ドキュメント

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

C# プロパティ

型	プロパティ	デフォルト	説明
`bool`	`ShowThumbs`	`true`	サムネイルパネルを表示します。
`bool`	`AutoLoad`	`false`	初期化後に自動的にロードします。通常のトークンフローでは `View(token)` を明示的に呼び出します。
`bool`	`AutoFocus`	`true`	初期化時にブラウザのフォーカス/スクロールをビューアへ移動します。
`bool`	`AutoPageFocus`	`true`	ページが変わっても現在のサムネイルが表示されたままになります。
`int`	`PageZoom`	`100`	初期ズーム率（パーセンテージ）。
`int`	`ZoomStep`	`10`	ズームコマンドで加算または減算されるパーセンテージ。
`int`	`MaxZoom`	`300`	最大ズーム率（パーセンテージ）。
`bool`	`ShowToolTip`	`true`	スクロール中にページ位置ツールチップを表示します。
`string`	`ToolTipPageText`	`"Page "`	ページツールチップで使用されるプレフィックス。
`bool`	`CacheEnabled`	`false`	ブラウザメモリ内にページ画像の移動ウィンドウを保持します。`localStorage` は使用しません。
`bool`	`LargeDoc`	`false`	大きなドキュメント向けに、ページ要素を時間間隔でバッチ追加します。
`bool`	`ShowHyperlinks`	`false`	サーバー設定で抽出されたハイパーリンクオーバーレイを描画します。
`bool`	`FixedZoom`	`true`	レスポンシブな再計算ではなく、固定ズーム率を使用します。
`int`	`FixedZoomPercent`	`100`	固定デスクトップズーム。
`int`	`FixedZoomPercentMobile`	`75`	固定モバイルズーム。
`string`	`BasePath`	`"/"`	`UseDoconut()` がマッピングされるホスト側のブランチ。
`string`	`ResPath`	`"doconut-res"`	ウィジェットが使用するリソースベース。通常の設定では `<ResourcesPath>/images` を指します。
`string`	`FitType`	`"width"`	`"width"`、`"height"`、または自動フィットしない場合は空文字。現在のウィジェットでは `"page"` は受け付けられません。
`bool`	`RetryOn409`	`false`	非同期/分散ページリクエストが `409` を返したときにポーリングを有効にします。通常の同期ビューアでは不要です。

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

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

C#	JavaScript
`ShowThumbs`	`showThumbs`
`AutoLoad`	`autoLoad`
`AutoFocus`	`autoFocus`
`AutoPageFocus`	`autoPageFocus`
`PageZoom`	`pageZoom`
`ZoomStep`	`zoomStep`
`MaxZoom`	`maxZoom`
`ShowToolTip`	`showToolTip`
`ToolTipPageText`	`toolTipPageText`
`CacheEnabled`	`cacheEnabled`
`LargeDoc`	`largeDoc`
`ShowHyperlinks`	`showHyperlinks`
`FixedZoom`	`fixedZoom`
`FixedZoomPercent`	`fixedZoomPercent`
`FixedZoomPercentMobile`	`fixedZoomPercentMobile`
`BasePath`	`BasePath`
`ResPath`	`ResPath`
`FitType`	`FitType`
`RetryOn409`	`retryOn409`

JavaScript デフォルト

オプション	デフォルト	備考
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	サムネイルペインの幅の範囲。
`showThumbs`	`true`	初期サムネイル表示状態。
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` は C# のデフォルトとは異なります。
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	ピクセル単位のサムネイルジオメトリ。
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	JavaScript の `maxZoom` は C#（`300`）とは異なります。
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	ページ位置ツールチップ。
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	内部初期化値。通常は `View(token)` によって設定されます。
`debugMode`	`false`	追加のクライアント診断情報。
`FitType`	`""`	提供されない限り自動フィットは行いません。
`BasePath`	`"DocImage.axd"`	レガシーハンドラのデフォルト。ASP.NET Core 用に明示的に設定してください。
`ResPath`	`""`	埋め込み画像パスに明示的に設定してください。
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	メモリ内ページ事前読み込みウィンドウと遅延。
`autoLoad`	`false`	明示的なトークンフローが推奨されます。
`largeDoc`	`true`	C# のデフォルトとは異なります。
`fixedZoom`	`false`	C# のデフォルトとは異なります。
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	モバイル値は C#（`75`）とは異なります。
`showHyperlinks`	`true`	オーバーレイを生成するにはサーバー側で抽出が必要です。

html

<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>

コールバック

コールバック	引数	目的
`onPageLoading`	`pageNum`	ページリクエストが開始されます。
`onPageLoaded`	`pageNum`	ページ画像の読み込みが完了しました。
`onThumbnailClicked`	`pageNum`	ユーザーがサムネイルを選択しました。
`onPageClicked`	`pageNum`	ユーザーがページを選択しました。
`onDoubleClick`	none	ビューアがダブルクリックを受け取りました。
`onViewerBusy`	none	ビューアがビジー状態になりました。
`onViewerReady`	none	初期化が完了しました。
`onViewerError`	none	ビューアがエラー状態になりました。
`onError`	`message`	操作がエラーメッセージを返しました。
`onCopy`	`data`	テキストコピー用データが利用可能です。
`onAutoLoadStatus`	`pageNum`	自動ロードがページに進みました。
`onThumbsShown`	none	サムネイルパネルが表示されました。
`onAnnLoaded`	none	アノテーションデータがロードされました。
`onAnnSaved`	none	アノテーションデータが保存されました。
`onAnnSaveError`	none	アノテーションの保存に失敗しました。
`onAnnClosed`	none	アノテーション UI が閉じられました。

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

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

グループ	共通メソッド
Lifecycle	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigation	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom and fit	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientation	`Rotate(page, angle)`, `Flip(page, flipType)`
Thumbnails	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Search	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Annotation	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Copy	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

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

HTTP 409 後のリトライ

retryOn409 は非同期ページ生成のための設定です。有効にすると、ウィジェットは以下の JavaScript デフォルトでポーリングを行います：

オプション	デフォルト
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

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

パスチェックリスト

DoconutOptions.MiddlewarePath は実際にマッピングするブランチを示す必要があります。
BasePath はそのブランチを指す必要があります。
DoconutOptions.ResourcesPath は埋め込みリソースのルートです。
ResPath は通常その /images サブフォルダーを指します。
ExtractHyperlinks は showHyperlinks が何かを表示できるようにする前に、サーバー側のフォーマット設定で有効にする必要があります。