ViewerConfig

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

ViewerConfig(名前空間 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",           // no leading '/': the viewer adds it ("/doconut" would become //doconut, another host)
    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ユーザーがページを選択しました。
onDoubleClicknoneビューアがダブルクリックを受け取りました。
onViewerBusynoneビューアがビジー状態になりました。
onViewerReadynone初期化が完了しました。
onViewerErrornoneビューアがエラー状態になりました。
onErrormessage操作がエラーメッセージを返しました。
onCopydataテキストコピーのデータが利用可能です。
onAutoLoadStatuspageNum自動ロードがページに進みました。
onThumbsShownnoneサムネイルパネルが表示されました。
onAnnLoadednone注釈データがロードされました。
onAnnSavednone注釈データが保存されました。
onAnnSaveErrornone注釈の保存に失敗しました。
onAnnClosednone注釈 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
retryMaxAttempts60
retryMaxTotalMs120000

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

パスチェックリスト

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

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