ViewerConfig – Doconut Dokumentation

ViewerConfig (namnrymd Doconut) beskriver webbläsarens visningsutseende och beteende. Det påverkar inte dokumentets renderingskvalitet; använd en formatkonfiguration för det. C#‑klassen och den långvariga JavaScript‑widgeten har olika standardvärden, så mappa värden explicit.

C#‑egenskaper

Typ	Egenskap	Standard	Beskrivning
`bool`	`ShowThumbs`	`true`	Visa miniatyrpanelen.
`bool`	`AutoLoad`	`false`	Ladda automatiskt efter initiering. Det normala tokenflödet anropar `View(token)` explicit.
`bool`	`AutoFocus`	`true`	Flytta webbläsarens fokus/rullning till visaren under initiering.
`bool`	`AutoPageFocus`	`true`	Behåll den aktuella miniatyren synlig medan sidorna ändras.
`int`	`PageZoom`	`100`	Initial zoomprocent.
`int`	`ZoomStep`	`10`	Procent som läggs till eller tas bort av zoomkommandon.
`int`	`MaxZoom`	`300`	Maximal zoomprocent.
`bool`	`ShowToolTip`	`true`	Visa verktygstips för sidposition medan du rullar.
`string`	`ToolTipPageText`	`"Page "`	Prefix som används i sidverktygstipset.
`bool`	`CacheEnabled`	`false`	Behåll ett rörligt fönster av sidbilder i webbläsarens minne. Det använder inte `localStorage`.
`bool`	`LargeDoc`	`false`	Lägg till sidelement i tidsinställda satser för stora dokument.
`bool`	`ShowHyperlinks`	`false`	Rendera hyperlänksöverlagringar när serverkonfigurationen har extraherat dem.
`bool`	`FixedZoom`	`true`	Använd en fast zoomprocent istället för responsiv omräkning.
`int`	`FixedZoomPercent`	`100`	Fast skrivbordzoom.
`int`	`FixedZoomPercentMobile`	`75`	Fast mobilzoom.
`string`	`BasePath`	`"/"`	Var visaren skickar sidförfrågningar. `"/"` är `DocImage.axd` vid webbplatsens rot; annars grenen där värden mappar `UseDoconut()`, utan inledande `/` (`"doconut"` betyder `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` före)	Mapp som widgeten laddar sina egna bilder från: `images`‑mappen under `ResourcesPath`, utan inledande `/`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` eller tomt för ingen automatisk anpassning. `"page"` accepteras inte av den aktuella widgeten.
`bool`	`RetryOn409`	`false`	Aktivera polling när asynkron/distribuerad sidproduktion svarar `202 Accepted`; `409` accepteras också för kompatibilitet med äldre servrar. Behövs inte av den normala synkrona visaren.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // ingen inledande '/': visaren lägger till den ("/doconut" skulle bli //doconut, annan värd)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# till JavaScript-mappning

Skicka inte en direkt serialiserad ViewerConfig till docViewer(...). De flesta widgetnycklar är i camelCase, medan tre etablerade sökvägs‑/anpassningsnycklar är i PascalCase.

C#	JavaScript
`ShowThumbs`	`showThumbs`
`AutoLoad`	`autoLoad`
`AutoFocus`	`autoFocus`
`AutoPageFocus`	`autoPageFocus`
`PageZoom`	`pageZoom`
`ZoomStep`	`zoomStep`
`MaxZoom`	`maxZoom`
`ShowToolTip`	`showToolTip`
`ToolTipPageText`	`toolTipPageText`
`CacheEnabled`	`cacheEnabled`
`LargeDoc`	`largeDoc`
`ShowHyperlinks`	`showHyperlinks`
`FixedZoom`	`fixedZoom`
`FixedZoomPercent`	`fixedZoomPercent`
`FixedZoomPercentMobile`	`fixedZoomPercentMobile`
`BasePath`	`BasePath`
`ResPath`	`ResPath`
`FitType`	`FitType`
`RetryOn409`	`retryOn409`

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.

Alternativ	Standard	Anteckningar
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Gränser för miniatyrpanelen bredd.
`showThumbs`	`true`	Initial miniatyrsynlighet.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` skiljer sig från C#‑standard.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Miniatyrgeometri i pixlar.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	JavaScript `maxZoom` skiljer sig från C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Verktygstips för sidposition.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Interna initieringsvärden; normalt fylls i av `View(token)`.
`debugMode`	`false`	Ytterligare klientdiagnostik.
`FitType`	`""`	Ingen automatisk anpassning om den inte anges.
`BasePath`	`"DocImage.axd"`	Historiskt klientstandardvärde behållet för kompatibilitet. Aktuella ASP.NET Core-värdar måste sätta det explicit till den mappade middleware-grenen.
`ResPath`	`""`	Sätt explicit till den inbäddade bildsökvägen.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Fönster och fördröjning för förinläsning av sidor i minnet.
`autoLoad`	`false`	Explicitt tokenflöde rekommenderas.
`largeDoc`	`true`	Skiljer sig från C#‑standard.
`fixedZoom`	`false`	Skiljer sig från C#‑standard.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Mobilt värde skiljer sig från C# (`75`).
`showHyperlinks`	`true`	Kräver server‑sidextraktion för att skapa överlägg.

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

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>

Återuppringningar

Återuppringning	Argument	Syfte
`onPageLoading`	`pageNum`	En sidbegäran påbörjas.
`onPageLoaded`	`pageNum`	En sidbild har laddats färdigt.
`onThumbnailClicked`	`pageNum`	Användaren valde en miniatyr.
`onPageClicked`	`pageNum`	Användaren valde en sida.
`onDoubleClick`	none	Visaren mottog ett dubbelklick.
`onViewerBusy`	none	Visaren gick in i ett upptaget tillstånd.
`onViewerReady`	none	Initiering slutförd.
`onViewerError`	none	Visaren gick in i feltilstånd.
`onError`	`message`	En operation returnerade ett felmeddelande.
`onCopy`	`data`	Textkopieringsdata är tillgänglig.
`onAutoLoadStatus`	`pageNum`	Autoladdning fortskred till en sida.
`onThumbsShown`	none	Miniatyrpanelen blev synlig.
`onAnnLoaded`	none	Annotationsdata laddades.
`onAnnSaved`	none	Annotationsdata sparades.
`onAnnSaveError`	none	Sparning av annotation misslyckades.
`onAnnClosed`	none	Annotations‑UI stängdes.

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

Grupp av publika metoder

Grupp	Vanliga metoder
Livscykel	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigering	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom och anpassning	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Orientering	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniatyrer	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Sök	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Annotation	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Kopiera	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

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

Försök igen medan en distribuerad sida fortfarande renderas

retryOn409 behåller sitt historiska namn. Det är för asynkron sidproduktion och återförsöker det aktuella 202 Accepted‑beredskapsresponsen samt den äldre 409 Conflict‑signalen. När den är aktiverad pollar widgeten med dessa JavaScript‑standardvärden:

Alternativ	Standard
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Låt den vara inaktiverad för den vanliga visaren. Att aktivera den kan inte göra en ej stödd synkron rendering asynkron.

Sökvägskontrollista

DoconutOptions.MiddlewarePath måste beskriva den gren du faktiskt mappar.
BasePath måste rikta sig mot den grenen, skrivet utan inledande / ('doconut', inte '/doconut': visaren lägger till snedstrecket, och //doconut/... är en begäran till en annan värd).
DoconutOptions.ResourcesPath är den inbäddade resursrutten.
ResPath pekar normalt på dess images‑undermapp, också utan inledande / ('doconut-res/images').
ExtractHyperlinks måste vara aktiverad i serverns formatkonfiguration innan showHyperlinks kan visa något.