ViewerConfig – Doconut Dokumentation

ViewerConfig (Namespace Doconut) beschreibt das Aussehen und Verhalten des Browser-Viewers. Es beeinflusst nicht die Qualität der Dokumentendarstellung; dafür verwenden Sie eine Formatkonfiguration. Die C#-Klasse und das veraltete JavaScript-Plugin haben unterschiedliche Vorgaben, daher Werte explizit zuordnen.

C#-Eigenschaften

Typ	Eigenschaft	Standard	Beschreibung
`bool`	`ShowThumbs`	`true`	Zeigt das Miniaturbild-Panel an.
`bool`	`AutoLoad`	`false`	Lädt nach der Initialisierung automatisch. Der normale Token‑Ablauf ruft `View(token)` explizit auf.
`bool`	`AutoFocus`	`true`	Verschiebt den Browser‑Fokus/Scroll zum Viewer während der Initialisierung.
`bool`	`AutoPageFocus`	`true`	Hält das aktuelle Miniaturbild sichtbar, während Seiten wechseln.
`int`	`PageZoom`	`100`	Anfangs‑Zoom‑Prozentsatz.
`int`	`ZoomStep`	`10`	Prozentsatz, der durch Zoom‑Befehle hinzugefügt oder entfernt wird.
`int`	`MaxZoom`	`300`	Maximaler Zoom‑Prozentsatz.
`bool`	`ShowToolTip`	`true`	Zeigt das Seiten‑Positions‑Tooltip beim Scrollen an.
`string`	`ToolTipPageText`	`"Page "`	Präfix, das im Seiten‑Tooltip verwendet wird.
`bool`	`CacheEnabled`	`false`	Behält ein rollierendes Fenster von Seitenbildern im Browser‑Speicher. Es verwendet kein `localStorage`.
`bool`	`LargeDoc`	`false`	Fügt Seitenelemente in zeitgesteuerten Stapeln für große Dokumente hinzu.
`bool`	`ShowHyperlinks`	`false`	Rendern Hyperlink‑Overlays, wenn die Server‑Konfiguration sie extrahiert hat.
`bool`	`FixedZoom`	`true`	Verwendet einen festen Zoom‑Prozentsatz statt einer responsiven Neuberechnung.
`int`	`FixedZoomPercent`	`100`	Fester Desktop‑Zoom.
`int`	`FixedZoomPercentMobile`	`75`	Fester mobiler Zoom.
`string`	`BasePath`	`"/"`	Zweig, in dem der Host `UseDoconut()` zuordnet.
`string`	`ResPath`	`"doconut-res"`	Ressourcenbasis, die vom Widget verwendet wird. In einer normalen Einrichtung darauf zeigen zu `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` oder leer für kein automatisches Anpassen. `"page"` wird vom aktuellen Widget nicht akzeptiert.
`bool`	`RetryOn409`	`false`	Aktiviert das Polling, wenn eine asynchrone/verteilte Seitenanfrage `409` zurückgibt. 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",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

C#-Zu-JavaScript-Zuordnung

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

Option	Standard	Hinweise
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Breitenbegrenzungen des Miniatur‑Panels.
`showThumbs`	`true`	Anfangliche Sichtbarkeit der Miniaturbilder.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` unterscheidet sich vom C#‑Standard.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Miniatur‑Geometrie in Pixeln.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	JavaScript `maxZoom` unterscheidet sich von C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Tooltip für Seitenposition.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Interne Initialisierungswerte; normalerweise von `View(token)` befüllt.
`debugMode`	`false`	Zusätzliche Client‑Diagnosen.
`FitType`	`""`	Kein automatisches Anpassen, sofern nicht angegeben.
`BasePath`	`"DocImage.axd"`	Standardwert des Legacy‑Handlers. Für ASP.NET Core explizit setzen.
`ResPath`	`""`	Explizit auf den Pfad der eingebetteten Bilder setzen.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	In‑Memory‑Fenster für das Vorladen von Seiten und Verzögerung.
`autoLoad`	`false`	Expliziter Token‑Ablauf wird empfohlen.
`largeDoc`	`true`	Unterscheidet sich vom C#‑Standard.
`fixedZoom`	`false`	Unterscheidet sich vom C#‑Standard.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Mobiler Wert unterscheidet sich von C# (`75`).
`showHyperlinks`	`true`	Erfordert serverseitige Extraktion, um Overlays zu erzeugen.

Set all behaviorally important values instead of relying on either set of defaults:

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

Rückruffunktion	Argumente	Zweck
`onPageLoading`	`pageNum`	Ein Seitenrequest wird gestartet.
`onPageLoaded`	`pageNum`	Ein Seitenbild wurde geladen.
`onThumbnailClicked`	`pageNum`	Der Benutzer hat ein Miniaturbild ausgewählt.
`onPageClicked`	`pageNum`	Der Benutzer hat eine Seite ausgewählt.
`onDoubleClick`	none	Der Viewer erhielt einen Doppelklick.
`onViewerBusy`	none	Der Viewer trat in einen beschäftigten Zustand ein.
`onViewerReady`	none	Initialisierung abgeschlossen.
`onViewerError`	none	Der Viewer trat in den Fehlermodus ein.
`onError`	`message`	Ein Vorgang gab eine Fehlermeldung zurück.
`onCopy`	`data`	Text‑Kopierdaten sind verfügbar.
`onAutoLoadStatus`	`pageNum`	Auto‑Laden hat eine Seite erreicht.
`onThumbsShown`	none	Das Miniatur‑Panel wurde sichtbar.
`onAnnLoaded`	none	Annotationsdaten geladen.
`onAnnSaved`	none	Annotationsdaten gespeichert.
`onAnnSaveError`	none	Speichern der Annotation fehlgeschlagen.
`onAnnClosed`	none	Annotations‑UI geschlossen.

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

Öffentliche Methodengruppen

Gruppe	Gemeinsame Methoden
Lebenszyklus	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Navigation	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Zoom und Anpassen	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Ausrichtung	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniaturbilder	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Suche	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Annotation	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Kopieren	`Copy(...)`, `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.

Wiederholungsversuch nach HTTP 409

retryOn409 dient der asynchronen Seitenerstellung. Wenn aktiviert, pollt das Widget mit diesen JavaScript‑Standardwerten:

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

Lassen Sie es für den normalen Viewer deaktiviert. Das Aktivieren kann eine nicht unterstützte synchrone Darstellung nicht in eine asynchrone umwandeln.

Pfad‑Checkliste

DoconutOptions.MiddlewarePath muss den Zweig beschreiben, den Sie tatsächlich zuordnen.
BasePath muss diesen Zweig anvisieren.
DoconutOptions.ResourcesPath ist die Route zu den eingebetteten Ressourcen.
ResPath zielt normalerweise auf dessen Unterordner /images.
ExtractHyperlinks muss in der Server‑Format‑Konfiguration aktiviert sein, bevor showHyperlinks etwas anzeigen kann.