ViewerConfig
クライアントビューアウィジェットオプション
ViewerConfig (namespace 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 | "/" | ビューアがページリクエストを送信する場所です。"/" はサイトルートで DocImage.axd です。それ以外の場合は、ホストが UseDoconut() をマップするブランチで、先頭に / がない("doconut" は /doconut/DocImage.axd を意味します)。 |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | ウィジェットが独自の画像をロードするフォルダーです:ResourcesPath の下の images フォルダーで、先頭に / がない。 |
string | FitType | "width" | "width"、"height"、または空にします。"page" は現在のウィジェットでは受け付けられません。 |
bool | RetryOn409 | false | 非同期/分散ページ生成が 202 Accepted に応答したときにポーリングを有効にします。409 は古いサーバーとの互換性のためにも受け入れられます。通常の同期ビューアでは必要ありません。 |
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 |
|---|---|
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 のデフォルト
このウィジェットには、C# クラスとは異なる古いデフォルトがあります。以下の値は現在の docViewer.js 実装から取得されたものです。
| オプション | デフォルト | 備考 |
|---|---|---|
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 | オーバーレイを生成するにはサーバー側での抽出が必要です。 |
いずれかのデフォルトに依存せず、すべての動作上重要な値を設定してください:
<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 が閉じられました。 |
コールバックは高速に保ち、テレメトリは非同期で送信し、ページのレンダリングをブロックしないでください。
パブリックメソッドグループ
| グループ | 共通メソッド |
|---|---|
| ライフサイクル | 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 デフォルトでポーリングします:
| オプション | デフォルト |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
通常のビューアでは無効のままにしてください。有効にしても、サポートされていない同期レンダリングを非同期に変えることはできません。
パスチェックリスト
DoconutOptions.MiddlewarePathは実際にマップするブランチを記述する必要があります。BasePathはそのブランチを対象とする必要があり、先頭の/を付けずに記述します('doconut'、'/doconut'ではなく:ビューアがスラッシュを追加し、//doconut/...は別ホストへのリクエストです)。DoconutOptions.ResourcesPathは埋め込みリソースのルートです。ResPathは通常、そのimagesサブフォルダを対象とし、先頭の/も付けません('doconut-res/images')。ExtractHyperlinksはサーバー形式設定で有効にする必要があり、showHyperlinksが何かを表示できるようになる前に設定します。
このページは役に立ちましたか?