ViewerConfig

クライアントビューアウィジェットオプション

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

C# プロパティ

型プロパティデフォルト説明
boolShowThumbstrueサムネイルパネルを表示します。
boolAutoLoadfalse初期化後に自動的にロードします。通常のトークンフローは View(token) を明示的に呼び出します。
boolAutoFocustrue初期化時にブラウザのフォーカス/スクロールをビューアへ移動します。
boolAutoPageFocustrueページが変わる間、現在のサムネイルを表示し続けます。
intPageZoom100初期ズーム率。
intZoomStep10ズームコマンドで追加または削除されるパーセンテージ。
intMaxZoom300最大ズーム率。
boolShowToolTiptrueスクロール中にページ位置ツールチップを表示します。
stringToolTipPageText"Page "ページツールチップで使用されるプレフィックス。
boolCacheEnabledfalseブラウザメモリ内にページ画像の移動ウィンドウを保持します。localStorage は使用しません。
boolLargeDocfalse大きなドキュメント用にページ要素を時間分割で追加します。
boolShowHyperlinksfalseサーバー設定が抽出したハイパーリンクオーバーレイをレンダリングします。
boolFixedZoomtrueレスポンシブな再計算ではなく、固定ズーム率を使用します。
intFixedZoomPercent100固定デスクトップズーム。
intFixedZoomPercentMobile75固定モバイルズーム。
stringBasePath"/"ビューアがページリクエストを送信する場所です。"/" はサイトルートで DocImage.axd です。それ以外の場合は、ホストが UseDoconut() をマップするブランチで、先頭に / を付けずに("doconut" は /doconut/DocImage.axd を意味します)。
stringResPath"doconut-res/images" (26.9.0; "doconut-res" before)ウィジェットが自身の画像を読み込むフォルダーです:ResourcesPath の下にある images フォルダーで、先頭に / を付けません。
stringFitType"width""width"、"height"、または空にすると自動フィットが無効になります。"page" は現在のウィジェットでは受け付けられません。
boolRetryOn409false非同期/分散ページ生成が 202 Accepted に応答する際にポーリングを有効にします。409 も古いサーバーとの互換性のために受け入れられます。通常の同期ビューアでは必要ありません。
csharp
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(...) に渡さないでください。ほとんどのウィジェットキーは camelCase ですが、3 つの確立されたパス/フィットキーは PascalCase です。

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

JavaScript のデフォルト

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

オプションデフォルト備考
leftMinWidth / leftMaxWidth220 / 800サムネイルペインの幅の境界。
showThumbstrue初期サムネイルの表示状態。
autoFocus / autoPageFocustrue / falseautoPageFocus は C# のデフォルトと異なります。
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10ピクセル単位のサムネイルジオメトリ。
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript の maxZoom は C#(300)と異なります。
showToolTip / toolTipPageTexttrue / "Page "ページ位置ツールチップ。
format / doc / AccessToken"" / 0 / ""内部初期化値;通常は View(token) によって設定されます。
debugModefalse追加のクライアント診断情報。
FitType""提供されない限り自動フィットは行われません。
BasePath"DocImage.axd"レガシーハンドラのデフォルト。ASP.NET Core 用に明示的に設定してください。
ResPath""埋め込み画像パスに明示的に設定してください。
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3メモリ内ページ事前読み込みウィンドウと遅延。
autoLoadfalse明示的なトークンフローが推奨されます。
largeDoctrueC# のデフォルトとは異なります。
fixedZoomfalseC# のデフォルトとは異なります。
fixedZoomPercent / fixedZoomPercentMobile100 / 50モバイル値は C#(75)と異なります。
showHyperlinkstrueオーバーレイを生成するにはサーバー側での抽出が必要です。

重要な動作に関わるすべての値を設定し、いずれかのデフォルトに依存しないようにしてください:

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>

コールバック

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

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

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

グループ共通メソッド
ライフサイクルView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
ナビゲーションGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
ズームとフィットZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
向きRotate(page, angle), Flip(page, flipType)
サムネイルHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
検索CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
注釈SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
コピーCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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

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

retryOn409 はその歴史的な名前を保持しています。これは非同期ページ生成のためで、現在の 202 Accepted 準備応答と古い 409 Conflict シグナルの両方を再試行します。有効にすると、ウィジェットはこれらの JavaScript デフォルトでポーリングします:

オプションデフォルト
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

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

パスチェックリスト

  • DoconutOptions.MiddlewarePath は実際にマップするブランチを記述する必要があります。
  • BasePath はそのブランチを対象とし、先頭の / を付けずに記述する必要があります('doconut'、'/doconut' ではなく:ビューアがスラッシュを追加し、//doconut/... は別ホストへのリクエストです)。
  • DoconutOptions.ResourcesPath は埋め込みリソースのルートです。
  • ResPath は通常、その images サブフォルダを対象とし、先頭の / を付けずに記述します('doconut-res/images')。
  • ExtractHyperlinks はサーバー形式設定で有効にしなければ、showHyperlinks が何も表示できません。

このページは役に立ちましたか?