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; pro to použijte konfigurační formát. Třída C# a dlouho etablovaný JavaScript widget mají různé výchozí hodnoty, takže hodnoty mapujte explicitně.

Dvě změny na straně klienta v tomto vydání selhávají tiše. Funkce obsluhy jsou předávány jako možnosti — widget již neodvozuje své zpětné volání událostí z ID kontejneru — a ResPath musí ukazovat na předponu zdrojů místo kořene aplikace. Obě ponechávají server v perfektním provozu a nehlásí nic v konzoli prohlížeče. Pokud přenášíte stránku z předchozí knihovny, přečtěte si Zpětná volání a Seznam kontrolních cest před čímkoli jiným.

Vlastnosti C#

TypVlastnostVýchozíPopis
boolShowThumbstrueZobrazit panel miniatur.
boolAutoLoadfalseAutomaticky načíst po inicializaci. Normální tok tokenů volá View(token) explicitně.
boolAutoFocustruePřesunout fokus/posun prohlížeče do prohlížeče během inicializace.
boolAutoPageFocustrueUdržet aktuální miniaturu viditelnou při změně stránek.
intPageZoom100Počáteční procento přiblížení.
intZoomStep10Procento přidané nebo odebrané příkazy zoomu.
intMaxZoom300Maximální procento přiblížení.
boolShowToolTiptrueZobrazit tooltip pozice stránky při posouvání.
stringToolTipPageText"Page "Předpona použitá v tooltipu stránky.
boolCacheEnabledfalseUdržovat pohyblivé okno obrázků stránek v paměti prohlížeče. Nepoužívá localStorage.
boolLargeDocfalsePřidávat prvky stránky v časově řízených dávkách pro velké dokumenty.
boolShowHyperlinksfalseVykreslovat překryvy hyperodkazů, když je serverová konfigurace extrahovala.
boolFixedZoomtruePoužít pevné procento přiblížení místo responzivního přepočtu.
intFixedZoomPercent100Pevné přiblížení pro desktop.
intFixedZoomPercentMobile75Pevné přiblížení pro mobil.
stringBasePath"/"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).
stringResPath"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 /.
stringFitType"width""width", "height", nebo prázdné pro žádné automatické přizpůsobení. "page" není akceptováno aktuálním widgetem.
boolRetryOn409falsePovolit polling, když asynchronní/rozptýlená výroba stránek odpovídá 202 Accepted; 409 je také akceptováno pro kompatibilitu se staršími servery. 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",           // žá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

Nepropusťte přímo serializovaný ViewerConfig do docViewer(...). Většina klíčů widgetu je v camelCase, zatímco tři zavedené klíče cesty/přizpůsobení jsou v PascalCase.

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

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žnostVýchozíPoznámky
leftMinWidth / leftMaxWidth220 / 800Meze šířky panelu miniatur.
showThumbstruePočáteční viditelnost miniatur.
autoFocus / autoPageFocustrue / falseautoPageFocus se liší od výchozí hodnoty C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometrie miniatur v pixelech.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom se liší od C# (300).
showToolTip / toolTipPageTexttrue / "Page "Tooltip umístění stránky.
format / doc / AccessToken"" / 0 / ""Interní hodnoty inicializace; obvykle naplněny pomocí View(token).
debugModefalseDalší diagnostika klienta.
FitType""Žádné automatické přizpůsobení, pokud není poskytnuto.
BasePath"DocImage.axd"Historická výchozí hodnota klienta zachována pro kompatibilitu. Současní hostitelé ASP.NET Core ji musí nastavit explicitně na mapovanou větev middleware.
ResPath""Nastavte explicitně na cestu vložených obrázků.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Okno a zpoždění přednačítání stránek v paměti.
autoLoadfalseDoporučuje se explicitní tok tokenu.
largeDoctrueLiší se od výchozí hodnoty C#.
fixedZoomfalseLiší se od výchozí hodnoty C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Mobilní hodnota se liší od C# (75).
showHyperlinkstrueVyžaduje serverovou extrakci pro vytvoření překryvů.

Nastavte všechny behaviorálně důležité hodnoty místo spolehání 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>

Zpětné volání

Zpětné voláníArgumentyÚčel
onPageLoadingpageNumPočíná požadavek na stránku.
onPageLoadedpageNumObrázek stránky se načetl.
onThumbnailClickedpageNumUživatel vybral miniaturu.
onPageClickedpageNumUživatel vybral stránku.
onDoubleClicknoneProhlížeč obdržel dvojklik.
onViewerBusynoneProhlížeč vstoupil do zaneprázdněného stavu.
onViewerReadynoneInicializace dokončena.
onViewerErrornoneProhlížeč vstoupil do chybového stavu.
onErrormessageOperace vrátila chybovou zprávu.
onCopydataData pro kopírování textu jsou k dispozici.
onAutoLoadStatuspageNumAutomatické načítání postoupilo na stránku.
onThumbsShownnonePanel miniatur se stal viditelným.
onAnnLoadednoneData anotací načtena.
onAnnSavednoneData anotací uložena.
onAnnSaveErrornoneUkládání anotací selhalo.
onAnnClosednoneUživatelské rozhraní anotací uzavřeno.

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

Každá z nich je možností v init objektu. Předchozí prohlížeč vyhledával globální funkce, jejichž názvy odvozoval od ID kontejneru — stránka s <div id="div_ctlDoc"> stačila pouze deklarovat function ctlDoc_OnViewerReady(). Toto vyhledávání zmizelo. Předávejte funkci explicitně:

javascript
function ctlDoc_OnViewerBusy() { /* zobrazte svůj indikátor zaneprázdnění */ }
function ctlDoc_OnViewerReady() { /* skryjte jej */ }
function ctlDoc_Copy(text) { /* použijte zkopírovaný text */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* oznamte průběh */ }

const objViewer = $('#div_ctlDoc').docViewer({
    // ... vaše existující možnosti ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // byl nalezen podle jména
    onViewerReady:    ctlDoc_OnViewerReady,     // byl nalezen podle jména
    onCopy:           ctlDoc_Copy,              // was ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // was ctlDoc_AutoLoadStatus(page)
});

Staré vyhledávání bylo zabalené do prázdného catch, takže nic nebylo nikdy hlášeno. V tomto vydání funkce prostě neběží: typickým příznakem je neustále běžící spinner, protože obslužná rutina, která jej skrývala, byla onViewerReady. Dokument za ním se vykresluje správně.

Stále jsou dva háčky pro ukládání anotací vyhledávány podle názvu: SaveAnnotations() volá <elementId>_BeforeAnnSave() a <elementId>_DeletedAnnotationIds(), pokud existují, a používá úplné ID elementu (div_ctlDoc_BeforeAnnSave pro výše uvedený příklad).

Není žádné zpětné volání při kliknutí na odkaz — zpracování hypertextových odkazů je vestavěné a řízené pomocí showHyperlinks.

Veřejné skupiny metod

SkupinaSpolečné metody
Životní cyklusView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigaceGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Přiblížení a přizpůsobeníZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientaceRotate(page, angle), Flip(page, flipType)
NáhledyHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
VyhledáváníCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnotaceSaveAnnotations(), 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 funkcí.

Opakování, dokud je distribuovaná stránka stále vykreslována

retryOn409 si zachovává svůj historický název. Slouží k asynchronní produkci stránek a opakuje aktuální odpověď připravenosti 202 Accepted i starší signál 409 Conflict. Když je povoleno, widget provádí dotazování s těmito výchozími hodnotami JavaScriptu:

MožnostVýchozí
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

Nechte to zakázáno pro běžného jednojádrového prohlížeče. Povolení nemůže učinit nepodporované synchronní vykreslování asynchronním.

Povolte to, když jsou stránky poskytovány ze sdíleného úložiště s FirstPagePriority, kde pozdější stránky legitimně odpovídají 202 Accepted, dokud nejsou zapsány. Klient, který neprovádí opakování, zobrazuje poškozené dlaždice pro stránky, které se stále vykreslují — viz Distribuovaná nasazení.

Kontrolní seznam cesty

  • DoconutOptions.MiddlewarePath musí popisovat větev, kterou skutečně mapujete.
  • BasePath musí 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). Běžné nastavení zachovává historický tvar požadavku DocImage.axd na větvi MapWhen a proto nastavuje BasePath: '/'.
  • DoconutOptions.ResourcesPath je cesta pro vložené zdroje.
  • ResPath normálně cílí na jeho podadresář images, bez úvodního / — 'doconut-res/images' s výchozím předponou. Prázdný ResPath byl v předchozí knihovně správný, kde zdroje pocházely z kořene aplikace; zde to není správné a selže bez chyby.
  • ExtractHyperlinks musí být povoleno v konfiguraci formátu serveru, než showHyperlinks může něco zobrazit.

Byla tato stránka užitečná?