ViewerConfig

ViewerConfig (namespace Doconut) popisuje vzhled a chování prohlížeče. Nemá vliv na kvalitu vykreslování dokumentu; použijte formátovací konfiguraci pro to. Třída C# a starý JavaScript plugin mají různé výchozí hodnoty, takže hodnoty mapujte explicitně.

Vlastnosti C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = the DocImage.axd handler at the site root (Web.config)
    ResPath = "doconut-res/images", // the images folder under ResourcesPath, no leading '/'
    ShowHyperlinks = true
};
// Emit it with viewer.RenderViewer("viewerEl", token, config) - see the Viewer reference.

Vytvoření ViewerConfig pomocí RenderViewer

Viewer.RenderViewer(elementId, token, config) převádí ViewerConfig na inicializační skript widgetu. Zapíše šest výše uvedených vlastností — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom a FitType — a poté zavolá View(token). Ostatní vlastnosti nejsou zapsány: pro MaxZoom, ShowHyperlinks, nastavení zoomu nebo jakékoli zpětné volání inicializujte widget sami pomocí níže uvedených JavaScript možností. Viz Viewer pro RenderViewer.

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 z výchozích sad:

<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: '/',
    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.

Veřejné skupiny metod

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 funkcí.

Možnosti opakování

Widget také přijímá retryOn409 a jeho nastavení zpětného zpoždění (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Slouží nasazením, jejichž stránky jsou generovány na pozadí. DocImage.axd vykresluje každou stránku během požadavku, takže nechte retryOn409 vypnuté.

Kontrolní seznam cesty

• BasePath je '/', když je obsluha DocImage.axd umístěna v kořeni webu — atribut path obsluhy v Web.config určuje, kde odpovídá. Ve virtuálním adresáři použijte název adresáře bez úvodní / ('myapp', ne '/myapp': prohlížeč přidá lomítko a //myapp/... je požadavek na jiný hostitel).
• DoconutOptions.ResourcesPath určuje, kde modul zdrojů poskytuje vložené soubory (/doconut-res ve výchozím nastavení).
• ResPath cílí na podsložku images, také bez úvodního / ('doconut-res/images'). Nastavení na 'doconut-res' způsobí, že každá ikona vrátí 404, zatímco dokument se stále vykresluje.
• V MVC musí routes.IgnoreRoute("doconut-res/{*pathInfo}") následovat po ResourcesPath, pokud jej změníte.
• ExtractHyperlinks musí být povoleno v konfiguraci formátu serveru, než showHyperlinks může něco zobrazit.