ViewerConfig

Klientvisningswidgetalternativ

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

C#-egenskaper

TypEgenskapStandardBeskrivning
boolShowThumbstrueVisa miniatyrpanelen.
boolAutoLoadfalseLadda automatiskt efter initiering. Det normala tokenflödet anropar View(token) explicit.
boolAutoFocustrueFlytta webbläsarens fokus/rullning till visaren under initiering.
boolAutoPageFocustrueBehåll den aktuella miniatyren synlig medan sidorna ändras.
intPageZoom100Initial zoomprocent.
intZoomStep10Procentandel som läggs till eller tas bort av zoomkommandon.
intMaxZoom300Maximal zoomprocent.
boolShowToolTiptrueVisa verktygstips för sidposition medan du rullar.
stringToolTipPageText"Page "Prefix som används i sidverktygstipset.
boolCacheEnabledfalseBehåll ett rörligt fönster av sidbilder i webbläsarens minne. Det använder inte localStorage.
boolLargeDocfalseLägg till sidelement i tidsstyrda batcher för stora dokument.
boolShowHyperlinksfalseRendera hyperlänksöverlägg när serverkonfigurationen har extraherat dem.
boolFixedZoomtrueAnvänd en fast zoomprocent istället för responsiv omräkning.
intFixedZoomPercent100Fast skrivbordszoom.
intFixedZoomPercentMobile75Fast mobilzoom.
stringBasePath"/"Var visaren skickar sidförfrågningar. "/" är DocImage.axd vid webbplatsens rot; annars den gren där värden mappar UseDoconut(), utan ett inledande / ("doconut" betyder /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" before)Mapp där widgeten laddar sina egna bilder från: images-mappen under ResourcesPath, utan ett inledande /.
stringFitType"width""width", "height", eller tom för ingen automatisk anpassning. "page" accepteras inte av den aktuella widgeten.
boolRetryOn409falseAktivera 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, en annan värd)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# till JavaScript-mappning

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

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

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.

AlternativStandardAnteckningar
leftMinWidth / leftMaxWidth220 / 800Gränser för miniatyrpanelens bredd.
showThumbstrueInitial miniatyrsynlighet.
autoFocus / autoPageFocustrue / falseautoPageFocus skiljer sig från C#‑standardvärdet.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Miniatyrgeometri i pixlar.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom skiljer sig från C# (300).
showToolTip / toolTipPageTexttrue / "Page "Verktygstips för sidposition.
format / doc / AccessToken"" / 0 / ""Interna initieringsvärden; normalt fylls i av View(token).
debugModefalseYtterligare klientdiagnostik.
FitType""Ingen automatisk anpassning om den inte tillhandahålls.
BasePath"DocImage.axd"Standardvärde för äldre hanterare. Ange den explicit för ASP.NET Core.
ResPath""Ange explicit till den inbäddade bildsökvägen.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Fönster och fördröjning för förinläsning av sidor i minnet.
autoLoadfalseExplicitt tokenflöde rekommenderas.
largeDoctrueSkiljer sig från C#‑standardvärdet.
fixedZoomfalseSkiljer sig från C#‑standardvärdet.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Mobilt värde skiljer sig från C# (75).
showHyperlinkstrueKrä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>

Återuppringningsfunktioner

ÅteruppringningArgumentSyfte
onPageLoadingpageNumEn sidbegäran påbörjas.
onPageLoadedpageNumEn sidbild har laddats färdigt.
onThumbnailClickedpageNumAnvändaren valde en miniatyr.
onPageClickedpageNumAnvändaren valde en sida.
onDoubleClicknoneVisaren mottog ett dubbelklick.
onViewerBusynoneVisaren gick in i ett upptaget tillstånd.
onViewerReadynoneInitieringen slutförd.
onViewerErrornoneVisaren gick in i feltilstånd.
onErrormessageEn operation returnerade ett felmeddelande.
onCopydataTextkopieringsdata är tillgänglig.
onAutoLoadStatuspageNumAutomatisk laddning gick vidare till en sida.
onThumbsShownnoneMiniatyrpanelen blev synlig.
onAnnLoadednoneAnnotationsdata laddades.
onAnnSavednoneAnnotationsdata sparades.
onAnnSaveErrornoneSparning av annotation misslyckades.
onAnnClosednoneAnnotations‑UI stängdes.

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

Publika metodgrupper

GruppVanliga metoder
LivscykelView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigeringGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom och anpassningZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrienteringRotate(page, angle), Flip(page, flipType)
MiniatyrerHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
SökningCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
KopieraCopy(...), CopyPage(pageNumber), CopyMode(enabled)

JavaScript‑filen innehåller också interna hjälpfunktioner. Behandla endast metoder som används av referens‑UI‑et och som dokumenteras 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:

AlternativStandard
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

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

Kontrollista för sökväg

  • DoconutOptions.MiddlewarePath måste beskriva den gren du faktiskt mappar.
  • BasePath måste rikta sig mot den grenen, skriven utan en 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 riktar normalt mot sin images undermapp, också utan en inledande / ('doconut-res/images').
  • ExtractHyperlinks måste vara aktiverad i serverns formatkonfiguration innan showHyperlinks kan visa någonting.

Var den här sidan hjälpsam?