ViewerConfig
Možnosti widgetu klientského prohlížeče
ViewerConfig (namespace Doconut) popisuje vzhled a chování prohlížeče. Nemá vliv na kvalitu vykreslování dokumentu; použijte konfiguraci formátu pro to. Třída C# a starý JavaScript plugin mají odlišné výchozí hodnoty, takže mapujte hodnoty explicitně.
Vlastnosti C#
| Typ | Vlastnost | Výchozí | Popis |
|---|---|---|---|
bool | ShowThumbs | true | Zobrazit panel miniatur. |
bool | AutoLoad | false | Automaticky načíst po inicializaci. Normální tok tokenů volá View(token) explicitně. |
bool | AutoFocus | true | Přesunout zaměření a posun prohlížeče do prohlížeče během inicializace. |
bool | AutoPageFocus | true | Udržet aktuální miniaturu viditelnou během změny stránek. |
int | PageZoom | 100 | Počáteční procento přiblížení. |
int | ZoomStep | 10 | Procento přidané nebo odebrané příkazy přiblížení. |
int | MaxZoom | 300 | Maximální procento přiblížení. |
bool | ShowToolTip | true | Zobrazit tooltip pozice stránky během posouvání. |
string | ToolTipPageText | "Page " | Předpona používaná v tooltipu stránky. |
bool | CacheEnabled | false | Udržovat pohyblivé okno obrázků stránek v paměti prohlížeče. Nepoužívá localStorage. |
bool | LargeDoc | false | Přidávat prvky stránky ve časově řízených dávkách pro velké dokumenty. |
bool | ShowHyperlinks | false | Vykreslovat překryvy hyperodkazů, když 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ího / ("doconut" znamená /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | Složka, ze které widget načítá své vlastní obrázky: složka images pod ResourcesPath, bez úvodního /. |
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á tvorba stránek odpovídá 202 Accepted; 409 je také akceptováno pro kompatibilitu se staršími servery. Není potřeba pro normální synchronní prohlížeč. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // žádný úvodní '/' : prohlížeč jej 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 path/fit 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 C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Geometrie miniatur v pixelech. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom se liší od C# (300). |
showToolTip / toolTipPageText | true / "Page " | Tooltip pozice stránky. |
format / doc / AccessToken | "" / 0 / "" | Interní hodnoty inicializace; obvykle naplněny pomocí View(token). |
debugMode | false | Další diagnostika klienta. |
FitType | "" | Žádné automatické přizpůsobení, pokud není poskytnuto. |
BasePath | "DocImage.axd" | Výchozí hodnota starého obslužného programu. 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 a prodleva přednačítání stránek v paměti. |
autoLoad | false | Doporučuje se explicitní tok tokenu. |
largeDoc | true | Liší se od výchozí hodnoty C#. |
fixedZoom | false | Liší se od výchozí hodnoty C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Mobilní hodnota se liší od C# (75). |
showHyperlinks | true | Vyžaduje serverovou extrakci 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:
<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 | Začíná požadavek na stránku. |
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 zaneprázdněného stavu. |
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í postoupilo 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 callbacky rychlé; odesílejte telemetrii asynchronně a neblokujte vykreslování stránky.
Veřejné skupiny metod
| Skupina | Běž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 uživatelským rozhraním a dokumentované zde nebo v průvodcích funkcemi.
Opakování, dokud je distribuovaná stránka stále vykreslována
retryOn409 si zachovává svůj historický název. Slouží k asynchronní tvorbě stránek a opakuje aktuální odpověď připravenosti 202 Accepted i starší signál 409 Conflict. Když je povoleno, widget dotazuje s těmito výchozími hodnotami JavaScriptu:
| Možnost | Výchozí |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Nechte to vypnuté pro běžného prohlížeče. Povolení to nemůže změnit nepodporovaný synchronní render na asynchronní.
Kontrolní seznam cest
DoconutOptions.MiddlewarePathmusí popisovat větev, kterou skutečně mapujete.BasePathmusí cílit na tuto větev, zapsáno bez úvodního/('doconut', ne'/doconut': prohlížeč přidá lomítko a//doconut/...je požadavek na jiný hostitel).DoconutOptions.ResourcesPathje cesta k vloženému zdroji.ResPathnormálně cílí na jeho podadresářimages, také bez úvodního/('doconut-res/images').ExtractHyperlinksmusí být povoleno v konfiguraci formátu serveru, nežshowHyperlinksmůže něco zobrazit.
Byla tato stránka užitečná?