ViewerConfig – Doconut Dokumentation

ViewerConfig (Namespace Doconut) beschreibt das Aussehen und Verhalten des Browser‑Viewers. Es beeinflusst nicht die Dokumentenrender‑Qualität; 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 automatisch nach der Initialisierung. 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 sich die Seiten ändern.
`int`	`PageZoom`	`100`	Anfänglicher 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 Chargen für große Dokumente hinzu.
`bool`	`ShowHyperlinks`	`false`	Rendert 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`	`"/"`	Wo der Viewer Seitenanfragen sendet. `"/"` ist `DocImage.axd` im Seiten‑Root; andernfalls der Zweig, wo der Host `UseDoconut()` zuordnet, ohne führenden `/` (`"doconut"` bedeutet `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` before)	Ordner, aus dem das Widget seine eigenen Bilder lädt: der `images`‑Ordner unter `ResourcesPath`, ohne führenden `/`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` oder leer für kein automatisches Anpassen. `"page"` wird vom aktuellen Widget nicht akzeptiert.
`bool`	`RetryOn409`	`false`	Aktiviert 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",           // kein führender '/': der Viewer fügt ihn hinzu ("/doconut" würde zu //doconut, ein anderer Host werden)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# zu JavaScript-Mapping

Übergeben Sie keine direkt serialisierte ViewerConfig an docViewer(...). Die meisten Widget‑Schlüssel sind im camelCase‑Format, während drei etablierte Pfad‑/Fit‑Schlüssel im PascalCase‑Format vorliegen.

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

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

Option	Standard	Hinweise
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Breitenbegrenzungen des Miniatur‑Panels.
`showThumbs`	`true`	Anfängliche Miniatur‑Sichtbarkeit.
`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 zur 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.

Setzen Sie alle verhaltensrelevanten Werte, anstatt sich auf eine der Vorgabemengen 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ückruf	Argumente	Zweck
`onPageLoading`	`pageNum`	Eine Seitenanforderung wird gestartet.
`onPageLoaded`	`pageNum`	Ein Seitenbild wurde geladen.
`onThumbnailClicked`	`pageNum`	Der Benutzer hat ein Vorschaubild ausgewählt.
`onPageClicked`	`pageNum`	Der Benutzer hat eine Seite ausgewählt.
`onDoubleClick`	none	Der Viewer hat einen Doppelklick erhalten.
`onViewerBusy`	none	Der Viewer ist in den Beschäftigungszustand gewechselt.
`onViewerReady`	none	Initialisierung abgeschlossen.
`onViewerError`	none	Der Viewer ist in den Fehlermodus gewechselt.
`onError`	`message`	Ein Vorgang hat eine Fehlermeldung zurückgegeben.
`onCopy`	`data`	Textkopierdaten sind verfügbar.
`onAutoLoadStatus`	`pageNum`	Das automatische Laden hat eine Seite erreicht.
`onThumbsShown`	none	Das Vorschaubild-Panel wurde sichtbar.
`onAnnLoaded`	none	Annotationsdaten wurden geladen.
`onAnnSaved`	none	Annotationsdaten wurden gespeichert.
`onAnnSaveError`	none	Speichern der Annotationen fehlgeschlagen.
`onAnnClosed`	none	Annotations-UI wurde geschlossen.

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

Öffentliche Methoden‑Gruppen

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()`
Orientierung	`Rotate(page, angle)`, `Flip(page, flipType)`
Miniaturansichten	`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. Betrachten Sie nur die Methoden, die von der Referenz‑UI verwendet und hier oder in den Feature‑Anleitungen dokumentiert sind, als stabile Integrationspunkte.

Wiederholungsversuch nach HTTP 409

retryOn409 ist für die asynchrone Seitenerstellung vorgesehen. Wenn aktiviert, fragt das Widget mit diesen JavaScript‑Standardwerten ab:

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 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 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 Route für eingebettete Ressourcen.
ResPath zielt normalerweise auf dessen Unterordner images, ebenfalls ohne führenden / ('doconut-res/images').
ExtractHyperlinks muss in der Server‑Format‑Konfiguration aktiviert sein, bevor showHyperlinks etwas anzeigen kann.