ViewerConfig

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í formát. Třída C# a dlouholetý JavaScript widget mají odlišné výchozí hodnoty, proto mapujte hodnoty 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",           // bez úvodního '/': prohlížeč jej přidá ("/doconut" by se stal //doconut, jiný host)
    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 v camelCase, zatímco tři zavedené klíče cesty/přizpůsobení jsou v 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é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>

Zpětné volání

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"> musela pouze deklarovat function ctlDoc_OnViewerReady(). Toto vyhledávání bylo odstraněno. Předávejte funkci 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 jednoduše neběží: typickým příznakem je neustále se točící spinner, který se nikdy nezastaví, protože obslužná rutina, která jej skryla, byla onViewerReady. Dokument za ním se vykresluje správně.

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

Veřejné skupiny metod

Soubor JavaScript obsahuje také interní pomocné funkce. 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í, 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:

Nechte jej vypnutý pro běžného jednojádrového prohlížeče. Povolení nemůže učinit nepodporované synchronní vykreslování 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 cesty

• DoconutOptions.MiddlewarePath musí popisovat větev, kterou skutečně mapujete.
• BasePath musí cílit na tuto větev, zapisováno bez úvodního / ('doconut', ne '/doconut': prohlížeč přidá lomítko a //doconut/... je požadavek na jiný host). 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 prostředkům.
• ResPath obvykle cílí na svůj podsložku images, bez úvodního / — 'doconut-res/images' s výchozím prefixem. Prázdný ResPath byl správný v předchozí knihovně, kde prostředky 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.