ViewerConfig

ViewerConfig (namespace Doconut) popisuje vzhled a chování prohlížeče. Nemá vliv na kvalitu vykreslování dokumentu; použijte konfigurační formát pro to. Třída C# a dlouho existující JavaScript widget mají odlišné 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 globální názvy funkcí z ID kontejneru — a ResPath musí ukazovat na předponu zdrojů místo kořene aplikace. Obě ponechávají server v perfektním stavu a nic nehlásí 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 Kontrolní seznam cest před čímkoli jiným.

Vlastnosti C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Mapování C# na JavaScript

Nepředávejte přímo serializovaný ViewerConfig do docViewer(...). Většina klíčů widgetu je ve formátu camelCase, zatímco tři zavedené klíče pro cestu/přizpůsobení jsou ve formátu PascalCase.

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.

Nastavte všechny behaviorálně důležité hodnoty místo spoléhání se na některý ze souborů 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>

Zpětná volání

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

Každá z těchto položek 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 deklarovat function ctlDoc_OnViewerReady(). Toto vyhledávání bylo odstraněno. Funkci předávejte explicitně:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... vaše stávající možnosti ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // bylo nalezeno podle názvu
    onViewerReady:    ctlDoc_OnViewerReady,     // bylo nalezeno podle názvu
    onCopy:           ctlDoc_Copy,              // bylo ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // bylo ctlDoc_AutoLoadStatus(page)
});

Staré vyhledávání bylo zabalené do prázdného catch, takže se nic nehlásilo. V tomto vydání funkce prostě nikdy neběží: typickým příznakem je neustále se otáčející indikátor zaneprázdněnosti, který se nikdy nezastaví, protože obsluha, která jej skrývala, byla onViewerReady. Dokument za ním se však vykresluje správně.

Není k dispozici zpětné volání pro kliknutí na odkaz — zpracování hyperodkazů je vestavěné a řízené pomocí showHyperlinks.

Veřejné skupiny metod

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

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

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

Ponechte jej zakázáno pro běžný jednojádrový prohlížeč. Povolení nemůže učinit nepodporované synchronní vykreslení asynchronním.

Povolte jej, 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 cest

• DoconutOptions.MiddlewarePath musí popisovat větev, kterou skutečně mapujete.
• BasePath musí cílit na tuto větev. Referenční aplikace zachovává historický tvar požadavku DocImage.axd na větvi MapWhen a proto nastavuje BasePath: '/'.
• DoconutOptions.ResourcesPath je cesta k vloženým zdrojům.
• ResPath normálně cílí na podsložku /images — 'doconut-res/images' s výchozím prefixem. Prázdný ResPath byl správný v předchozí knihovně, kde zdroje pocházely z kořene aplikace; zde to není správné a selže bez chyby.
• ExtractHyperlinks musí být povoleno v konfiguračním formátu serveru, než showHyperlinks může něco zobrazit.