ViewerConfig – Doconut Dokumentace

ViewerConfig (namespace Doconut) popisuje vzhled a chování prohlížeče ve webovém prohlížeči. Nemá vliv na kvalitu vykreslování dokumentu; pro to použijte konfigurační nastavení formátu. Třída C# a starší JavaScript plugin mají odlišné výchozí hodnoty, takže hodnoty mapujte explicitně.

C# vlastnosti

Typ	Vlastnost	Výchozí	Popis
`bool`	`ShowThumbs`	`true`	Zobrazit panel miniatur.
`bool`	`AutoLoad`	`false`	Automaticky načíst po inicializaci. Normální tok tokenu volá `View(token)` explicitně.
`bool`	`AutoFocus`	`true`	Přesunout fokus/posun prohlížeče na prohlížeč během inicializace.
`bool`	`AutoPageFocus`	`true`	Udržet aktuální miniaturu viditelnou při změně stránek.
`int`	`PageZoom`	`100`	Počáteční procento přiblížení.
`int`	`ZoomStep`	`10`	Procento přidávané nebo odebírané příkazy zoomu.
`int`	`MaxZoom`	`300`	Maximální procento přiblížení.
`bool`	`ShowToolTip`	`true`	Zobrazit tooltip s pozicí stránky během posouvání.
`string`	`ToolTipPageText`	`"Page "`	Předpona používaná v tooltipu stránky.
`bool`	`CacheEnabled`	`false`	Uchovávat pohyblivé okno obrázků stránek v paměti prohlížeče. Nepoužívá `localStorage`.
`bool`	`LargeDoc`	`false`	Přidávat prvky stránek ve časově rozdělených dávkách pro velké dokumenty.
`bool`	`ShowHyperlinks`	`false`	Vykreslovat překryvy hyperodkazů, pokud je serverová konfigurace extrahovala.
`bool`	`FixedZoom`	`true`	Použít pevné procento přiblížení místo responzivního přepočtu.
`int`	`FixedZoomPercent`	`100`	Pevné přiblížení pro desktop.
`int`	`FixedZoomPercentMobile`	`75`	Pevné přiblížení pro mobil.
`string`	`BasePath`	`"/"`	Kam prohlížeč odesílá požadavky na stránky. `"/"` je `DocImage.axd` v kořeni webu; jinak větev, kde hostitel mapuje `UseDoconut()`, bez úvodní `/` (`"doconut"` znamená `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` dříve)	Složka, ze které widget načítá své vlastní obrázky: složka `images` pod `ResourcesPath`, bez úvodní `/`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` nebo prázdné pro žádné automatické přizpůsobení. `"page"` není aktuálním widgetem akceptováno.
`bool`	`RetryOn409`	`false`	Povolit polling, když asynchronní/rozptýlený požadavek na stránku vrátí `409`. Není potřeba pro běžný synchronní prohlížeč.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // bez úvodní '/': prohlížeč ji přidá ("/doconut" by se stal //doconut, jiný host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Mapování C# na JavaScript

Nepropouštějte přímo serializovaný ViewerConfig do docViewer(...). Většina klíčů widgetu je v camelCase, zatímco tři zavedené klíče pro cesty/fity jsou v 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`

Výchozí hodnoty JavaScriptu

Widget má starší výchozí hodnoty, které se liší od třídy C#. Následující hodnoty pocházejí z aktuální implementace docViewer.js.

Možnost	Výchozí	Poznámky
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Meze šířky panelu miniatur.
`showThumbs`	`true`	Počáteční viditelnost miniatur.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` se liší od výchozí hodnoty v C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Geometrie miniatur v pixelech.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` v JavaScriptu se liší od C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Tooltip s pozicí stránky.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Interní hodnoty inicializace; běžně naplněny pomocí `View(token)`.
`debugMode`	`false`	Další diagnostika na klientovi.
`FitType`	`""`	Žádné automatické přizpůsobení, pokud není zadáno.
`BasePath`	`"DocImage.axd"`	Výchozí hodnota starého handleru. Nastavte explicitně pro ASP.NET Core.
`ResPath`	`""`	Nastavte explicitně na cestu k vloženým obrázkům.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Okno přednačítání stránek v paměti a zpoždění.
`autoLoad`	`false`	Doporučuje se explicitní tok tokenu.
`largeDoc`	`true`	Liší se od výchozí hodnoty v C#.
`fixedZoom`	`false`	Liší se od výchozí hodnoty v C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Mobilní hodnota se liší od C# (`75`).
`showHyperlinks`	`true`	Vyžaduje extrakci na serveru pro vytvoření překryvů.

Nastavte všechny behaviorálně důležité hodnoty místo spoléhaní se na některou sadu výchozích hodnot:

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>

Callbacky

Callback	Argumenty	Účel
`onPageLoading`	`pageNum`	Požadavek na stránku se spouští.
`onPageLoaded`	`pageNum`	Obrázek stránky byl načten.
`onThumbnailClicked`	`pageNum`	Uživatel vybral miniaturu.
`onPageClicked`	`pageNum`	Uživatel vybral stránku.
`onDoubleClick`	none	Prohlížeč obdržel dvojklik.
`onViewerBusy`	none	Prohlížeč vstoupil do stavu zaneprázdněnosti.
`onViewerReady`	none	Inicializace dokončena.
`onViewerError`	none	Prohlížeč vstoupil do chybového stavu.
`onError`	`message`	Operace vrátila chybovou zprávu.
`onCopy`	`data`	Data pro kopírování textu jsou k dispozici.
`onAutoLoadStatus`	`pageNum`	Automatické načítání postupovalo na stránku.
`onThumbsShown`	none	Panel miniatur se stal viditelným.
`onAnnLoaded`	none	Data anotací načtena.
`onAnnSaved`	none	Data anotací uložena.
`onAnnSaveError`	none	Uložení anotací selhalo.
`onAnnClosed`	none	Uživatelské rozhraní anotací bylo uzavřeno.

Udržujte zpětná volání rychlá; odesílejte telemetrii asynchronně a neblokujte vykreslování stránky.

Veřejné skupiny metod

Skupina	Společné metody
Životní cyklus	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigace	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom a přizpůsobení	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientace	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniatury	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Vyhledávání	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Anotace	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Kopírování	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

Soubor JavaScript také obsahuje interní pomocníky. Považujte za stabilní integrační body pouze metody používané referenčním UI a dokumentované zde nebo v průvodcích funkcemi.

Opakování po HTTP 409

retryOn409 slouží k asynchronní tvorbě stránek. Když je povoleno, widget periodicky kontroluje s těmito výchozími hodnotami JavaScriptu:

Možnost	Výchozí hodnota
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Nechte to pro normální prohlížeč zakázáno. Povolení nemůže změnit nepodporované synchronní vykreslování na asynchronní.

Kontrolní seznam cest

DoconutOptions.MiddlewarePath musí popisovat větev, kterou skutečně mapujete.
BasePath musí cílit na tuto větev, zapsaný bez úvodní / ('doconut', ne '/doconut': prohlížeč přidá lomítko a //doconut/... je požadavek na jiný host).
DoconutOptions.ResourcesPath je cesta k vloženým zdrojům.
ResPath obvykle cílí na jeho podsložku images, také bez úvodního / ('doconut-res/images').
ExtractHyperlinks musí být povolen v konfiguraci formátu serveru, než showHyperlinks může něco zobrazit.