ViewerConfig

Client viewer widget options

ViewerConfig (Namespace Doconut) beschreibt das Aussehen und Verhalten des Browser‑Viewers. Es beeinflusst nicht die Dokument‑Renderqualität; 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
boolShowThumbstrueZeigt das Miniatur‑Panel an.
boolAutoLoadfalseLädt nach der Initialisierung automatisch. Der normale Token‑Ablauf ruft View(token) explizit auf.
boolAutoFocustrueVerschiebt den Browser‑Fokus/Scroll zum Viewer während der Initialisierung.
boolAutoPageFocustrueHält die aktuelle Miniatur sichtbar, während Seiten wechseln.
intPageZoom100Anfänglicher Zoom‑Prozentsatz.
intZoomStep10Prozentsatz, der durch Zoom‑Befehle hinzugefügt oder entfernt wird.
intMaxZoom300Maximaler Zoom‑Prozentsatz.
boolShowToolTiptrueZeigt das Seiten‑Positions‑Tooltip beim Scrollen an.
stringToolTipPageText"Page "Präfix, das im Seiten‑Tooltip verwendet wird.
boolCacheEnabledfalseBehält ein rollierendes Fenster von Seitenbildern im Browser‑Speicher. Es verwendet kein localStorage.
boolLargeDocfalseFügt Seitenelemente in zeitgesteuerten Stapeln für große Dokumente hinzu.
boolShowHyperlinksfalseRendert Hyperlink‑Overlays, wenn die Server‑Konfiguration sie extrahiert hat.
boolFixedZoomtrueVerwendet 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 Site‑Wurzel; andernfalls der Zweig, wo der Host UseDoconut() zuordnet, ohne führendes / ("doconut" bedeutet /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" vorher)Ordner, aus dem das Widget seine eigenen Bilder lädt: der images‑Ordner unter ResourcesPath, ohne führendes /.
stringFitType"width""width", "height" oder leer für keine automatische Anpassung. "page" wird vom aktuellen Widget nicht akzeptiert.
boolRetryOn409falseAktiviert das Polling, wenn asynchrone/verteilte Seitenerstellung 202 Accepted zurückgibt; 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ührendes '/': der Viewer fügt es hinzu ("/doconut" würde zu //doconut, ein anderer Host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# zu JavaScript‑Abbildung

Übergeben Sie 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 / 800Grenzwerte für die Breite des Miniaturbereichs.
showThumbstrueAnfängliche Sichtbarkeit der Miniaturansichten.
autoFocus / autoPageFocustrue / falseautoPageFocus unterscheidet sich vom C#‑Standard.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Miniaturgeometrie in Pixeln.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom unterscheidet sich von C# (300).
showToolTip / toolTipPageTexttrue / "Page "Tooltip zur Seitenposition.
format / doc / AccessToken"" / 0 / ""Interne Initialisierungswerte; normalerweise durch 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‑Vorladungsfenster und -Verzögerung für Seiten.
autoLoadfalseEin expliziter Token‑Fluss wird empfohlen.
largeDoctrueWeicht vom C#‑Standard ab.
fixedZoomfalseWeicht vom C#‑Standard ab.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Mobiler Wert unterscheidet sich von C# (75).
showHyperlinkstrueErfordert serverseitige Extraktion, um Overlays zu erzeugen.

Setzen Sie alle verhaltensrelevanten Werte, anstatt sich auf einen der Standardwerte 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
onPageLoadingpageNumEin Seitenaufruf wird gestartet.
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 Besetzungszustand übergegangen.
onViewerReadynoneInitialisierung abgeschlossen.
onViewerErrornoneDer Viewer ist in den Fehlermodus übergegangen.
onErrormessageEin Vorgang hat eine Fehlermeldung zurückgegeben.
onCopydataTextkopierdaten sind verfügbar.
onAutoLoadStatuspageNumAuto‑Loading hat eine Seite erreicht.
onThumbsShownnoneDas Miniatur‑Panel wurde sichtbar.
onAnnLoadednoneAnnotierungsdaten wurden geladen.
onAnnSavednoneAnnotierungsdaten wurden gespeichert.
onAnnSaveErrornoneSpeichern der Annotation fehlgeschlagen.
onAnnClosednoneAnnotierungs‑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)
MiniaturansichtenHideThumbs(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. Behandeln Sie nur Methoden, die von der Referenz‑UI verwendet und hier oder in den Feature‑Leitfäden dokumentiert sind, als stabile Integrationspunkte.

Erneut versuchen, 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
retryMaxAttempts60
retryMaxTotalMs120000

Lassen Sie es für den normalen Viewer deaktiviert. Das Aktivieren kann einen nicht unterstützten synchronen Render nicht asynchron machen.

Pfad‑Checkliste

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

War diese Seite hilfreich?