ViewerConfig

ViewerConfig (namespace Doconut) beskriver webbläsarens visningsutseende och beteende. Det påverkar inte dokumentrenderingskvaliteten; använd en formatkonfiguration för det. C#-klassen och den äldre JavaScript‑pluginen har olika standardvärden, så mappa värden explicit.

C#-egenskaper

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = DocImage.axd‑hanteraren på webbplatsens rot (Web.config)
    ResPath = "doconut-res/images", // bildmappen under ResourcesPath, utan inledande '/'
    ShowHyperlinks = true
};
// Generera den med viewer.RenderViewer("viewerEl", token, config) - se Viewer‑referensen.

Skapa en ViewerConfig med RenderViewer

Viewer.RenderViewer(elementId, token, config) omvandlar en ViewerConfig till widgetens initieringsskript. Den skriver sex av egenskaperna ovan — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom och FitType — och anropar sedan View(token). De andra egenskaperna skrivs inte: för MaxZoom, ShowHyperlinks, zoominställningarna eller någon återuppringning, initiera widgeten själv med JavaScript-alternativen nedan. Se Viewer för RenderViewer.

C# till JavaScript-mappning

Skicka inte ett direkt serialiserat ViewerConfig till docViewer(...). De flesta widgetnycklar är camelCase, medan tre etablerade sökväg/fit-nycklar är PascalCase.

JavaScript-standardvärden

Widgeten har äldre standardvärden som skiljer sig från C#‑klassen. Följande värden kommer från den aktuella docViewer.js‑implementeringen.

Ställ in alla beteendemässigt viktiga värden istället för att förlita dig på någon av standarduppsättningarna:

<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>

Återanrop

Håll återanrop snabba; skicka telemetri asynkront och blockera inte sidrenderingen.

Publika metodgrupper

JavaScript‑filen innehåller också interna hjälpfunktioner. Betrakta endast metoder som används av referens‑UI‑t och som dokumenteras här eller i funktionsguiderna som stabila integrationspunkter.

Återförsöksalternativ

Widgeten accepterar också retryOn409 och dess backoff‑inställningar (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). De används för distributioner vars sidor genereras i bakgrunden. DocImage.axd renderar varje sida under begäran, så håll retryOn409 av.

Kontrollista för sökväg

• BasePath är '/' när DocImage.axd‑hanteraren är på webbplatsens rot — path‑attributet för hanteraren i Web.config bestämmer var den svarar. I en virtuell katalog, använd katalognamnet utan ett inledande / ('myapp', inte '/myapp': visaren lägger till snedstrecket, och //myapp/... är en begäran till en annan värd).
• DoconutOptions.ResourcesPath är där resursmodulen levererar de inbäddade filerna (/doconut-res som standard).
• ResPath pekar på sin images‑undermapp, också utan ett inledande / ('doconut-res/images'). Att peka den mot 'doconut-res' gör att varje ikon får 404 medan dokumentet fortfarande renderas.
• I MVC måste routes.IgnoreRoute("doconut-res/{*pathInfo}") följa ResourcesPath om du ändrar den.
• ExtractHyperlinks måste vara aktiverad i serverns formatkonfiguration innan showHyperlinks kan visa någonting.