ViewerConfig

Client‑Viewer‑Widget‑Optionen

ViewerConfig (namespace Doconut) beschreibt das Aussehen und Verhalten des Browser‑Viewers. Es beeinflusst nicht die Qualität der Dokumentdarstellung; dafür verwenden Sie eine Format‑Konfiguration. Die C#‑Klasse und das langjährige JavaScript‑Widget haben unterschiedliche Vorgaben, daher Werte explizit zuordnen.

C# Eigenschaften

TypEigenschaftStandardBeschreibung
boolShowThumbstrueZeige das Miniaturbild‑Panel.
boolAutoLoadfalseAutomatisch nach der Initialisierung laden. Der normale Token‑Fluss ruft View(token) explizit auf.
boolAutoFocustrueVerschiebe den Browser‑Fokus/Scrollen zum Viewer während der Initialisierung.
boolAutoPageFocustrueHalte das aktuelle Thumbnail sichtbar, während die Seiten wechseln.
intPageZoom100Anfangs‑Zoom‑Prozentsatz.
intZoomStep10Prozentsatz, der durch Zoom‑Befehle hinzugefügt oder entfernt wird.
intMaxZoom300Maximaler Zoom‑Prozentsatz.
boolShowToolTiptrueZeige den Seitenpositions‑Tooltip beim Scrollen.
stringToolTipPageText"Page "Präfix, das im Seiten‑Tooltip verwendet wird.
boolCacheEnabledfalseBehalte ein rollierendes Fenster von Seitenbildern im Browser‑Speicher. Es verwendet nicht localStorage.
boolLargeDocfalseFüge Seitenelemente in zeitgesteuerten Chargen für große Dokumente hinzu.
boolShowHyperlinksfalseRendre Hyperlink‑Overlays, wenn die Serverkonfiguration sie extrahiert hat.
boolFixedZoomtrueVerwende einen festen Zoom‑Prozentsatz anstelle einer responsiven Neuberechnung.
intFixedZoomPercent100Fester Desktop‑Zoom.
intFixedZoomPercentMobile75Fester mobiler Zoom.
stringBasePath"/"Wo der Viewer Seitenanfragen sendet. "/" ist DocImage.axd an der Seitenwurzel; andernfalls der Zweig, in dem der Host UseDoconut() abbildet, ohne ein führendes / ("doconut" bedeutet /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" vor)Ordner, aus dem das Widget seine eigenen Bilder lädt: der images‑Ordner unter ResourcesPath, ohne ein führendes /.
stringFitType"width""width", "height" oder leer für keine automatische Anpassung. "page" wird vom aktuellen Widget nicht akzeptiert.
boolRetryOn409falseAktiviere Polling, wenn asynchrone/verteilte Seitenerstellung auf 202 Accepted reagiert; 409 wird ebenfalls für die Kompatibilität mit älteren Servern akzeptiert. Nicht erforderlich für den normalen synchronen Viewer.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // kein führender '/' : der Viewer fügt ihn hinzu ("/doconut" würde zu //doconut, einem anderen Host werden)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# zu JavaScript Zuordnung

Übergebe kein direkt serialisiertes ViewerConfig an docViewer(...). Die meisten Widget‑Schlüssel sind camelCase, während drei etablierte Pfad‑/Fit‑Schlüssel PascalCase sind.

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

JavaScript-Standardwerte

Das Widget hat ältere Standardwerte, die von der C#‑Klasse abweichen. Die folgenden Werte stammen aus der aktuellen docViewer.js‑Implementierung.

OptionStandardHinweise
leftMinWidth / leftMaxWidth220 / 800Grenzen der Breite des Miniaturbereichs.
showThumbstrueInitiale Miniatur‑Sichtbarkeit.
autoFocus / autoPageFocustrue / falseautoPageFocus weicht vom C#‑Standard ab.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Miniatur‑Geometrie in Pixeln.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom weicht von C# (300) ab.
showToolTip / toolTipPageTexttrue / "Page "Tooltip zur Seitenposition.
format / doc / AccessToken"" / 0 / ""Interne Initialisierungswerte; normalerweise von View(token) befüllt.
debugModefalseZusätzliche Client‑Diagnosen.
FitType""Keine automatische Anpassung, sofern nicht angegeben.
BasePath"DocImage.axd"Historischer Client‑Standard aus Kompatibilitätsgründen beibehalten. Aktuelle ASP.NET‑Core‑Hosts müssen ihn explizit auf den zugeordneten Middleware‑Zweig setzen.
ResPath""Explizit auf den Pfad der eingebetteten Bilder setzen.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3In‑Memory‑Seiten‑Preload‑Fenster und -Verzögerung.
autoLoadfalseEin expliziter Token‑Fluss wird empfohlen.
largeDoctrueWeicht vom C#‑Standard ab.
fixedZoomfalseWeicht vom C#‑Standard ab.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Mobiler Wert weicht von C# (75) ab.
showHyperlinkstrueErfordert serverseitige Extraktion, um Overlays zu erzeugen.

Setzen Sie alle verhaltensrelevanten Werte, anstatt sich auf einen der Standardsätze zu verlassen:

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>

Rückrufe

RückrufArgumenteZweck
onPageLoadingpageNumEine Seitenanfrage startet.
onPageLoadedpageNumEin Seitenbild wurde geladen.
onThumbnailClickedpageNumDer Benutzer hat eine Miniatur ausgewählt.
onPageClickedpageNumDer Benutzer hat eine Seite ausgewählt.
onDoubleClicknoneDer Viewer hat einen Doppelklick erhalten.
onViewerBusynoneDer Viewer ist in einen Beschäftigungszustand gewechselt.
onViewerReadynoneInitialisierung abgeschlossen.
onViewerErrornoneDer Viewer ist in den Fehlermodus gewechselt.
onErrormessageEin Vorgang hat eine Fehlermeldung zurückgegeben.
onCopydataText‑Kopierdaten sind verfügbar.
onAutoLoadStatuspageNumAutomatisches Laden hat eine Seite erreicht.
onThumbsShownnoneDas Miniatur‑Panel wurde sichtbar.
onAnnLoadednoneAnnotationsdaten geladen.
onAnnSavednoneAnnotationsdaten gespeichert.
onAnnSaveErrornoneSpeichern der Annotation fehlgeschlagen.
onAnnClosednoneAnnotations‑UI geschlossen.

Halten Sie Rückrufe schnell; senden Sie Telemetrie asynchron und blockieren Sie das Rendern der Seite nicht.

Öffentliche Methodengruppen

GruppeGemeinsame Methoden
LebenszyklusView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigationGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom und AnpassenZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
AusrichtungRotate(page, angle), Flip(page, flipType)
MiniaturenHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
SucheCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
KopierenCopy(...), CopyPage(pageNumber), CopyMode(enabled)

Die JavaScript‑Datei enthält ebenfalls interne Hilfsfunktionen. Betrachten Sie nur Methoden, die von der Referenz‑UI verwendet und hier oder in den Funktionsleitfäden dokumentiert sind, als stabile Integrationspunkte.

Erneuter Versuch, während eine verteilte Seite noch gerendert wird

retryOn409 behält seinen historischen Namen. Es dient der asynchronen Seitenerstellung und wiederholt die aktuelle 202 Accepted Bereitschaftsantwort sowie das ältere 409 Conflict Signal. Wenn aktiviert, fragt das Widget mit diesen JavaScript‑Standardwerten ab:

OptionStandard
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

Lassen Sie es für den normalen Betrachter deaktiviert. Das Aktivieren kann ein nicht unterstütztes synchrones Rendering nicht asynchron machen.

Pfad‑Checkliste

  • DoconutOptions.MiddlewarePath muss den Zweig beschreiben, den Sie tatsächlich zuordnen.
  • BasePath muss diesen Zweig anvisieren, geschrieben ohne ein führendes / ('doconut', nicht '/doconut': Der Betrachter fügt den Schrägstrich hinzu, und //doconut/... ist eine Anfrage an einen anderen Host).
  • DoconutOptions.ResourcesPath ist die Route zur eingebetteten Ressource.
  • ResPath zielt normalerweise auf seinen images Unterordner, ebenfalls ohne ein führendes / ('doconut-res/images').
  • ExtractHyperlinks muss in der Serverformat‑Konfiguration aktiviert sein, bevor showHyperlinks irgendetwas anzeigen kann.

War diese Seite hilfreich?