ViewerConfig
Optionen für das Client-Viewer-Widget
ViewerConfig (namespace Doconut) beschreibt das Erscheinungsbild und das Verhalten des Browser-Viewers. Es beeinflusst nicht die Dokumentdarstellungsqualitä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 | Automatisches Laden nach der Initialisierung. Der normale Token‑Fluss ruft View(token) explizit auf. |
bool | AutoFocus | true | Verschiebt den Browser‑Fokus/Scroll während der Initialisierung zum Viewer. |
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 nicht localStorage. |
bool | LargeDoc | false | Fügt Seitenelemente in zeitgesteuerten Chargen für große Dokumente hinzu. |
bool | ShowHyperlinks | false | Rendern von Hyperlink‑Overlays, wenn die Server‑Konfiguration sie extrahiert hat. |
bool | FixedZoom | true | Verwendet einen festen Zoom‑Prozentsatz anstelle einer responsiven Neuberechnung. |
int | FixedZoomPercent | 100 | Fester Desktop‑Zoom. |
int | FixedZoomPercentMobile | 75 | Fester Mobile‑Zoom. |
string | BasePath | "/" | Wo der Viewer Seitenanfragen sendet. "/" ist DocImage.axd an der Site‑Wurzel; andernfalls der Zweig, in dem der Host UseDoconut() zuordnet, ohne ein führendes / ("doconut" bedeutet /doconut/DocImage.axd). |
string | ResPath | "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 ein führendes /. |
string | FitType | "width" | "width", "height" oder leer für keine automatische Anpassung. "page" wird vom aktuellen Widget nicht akzeptiert. |
bool | RetryOn409 | false | Aktiviere Polling, wenn asynchrone/verteilte Seitenerstellung auf 202 Accepted reagiert; 409 wird ebenfalls zur Kompatibilität mit älteren Servern akzeptiert. Nicht erforderlich für den normalen synchronen Viewer. |
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‑Mapping
Ü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 |
|---|---|
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 | Grenzwerte für die Breite des Thumbnail‑Bereichs. |
showThumbs | true | Anfängliche Thumbnail‑Sichtbarkeit. |
autoFocus / autoPageFocus | true / false | autoPageFocus unterscheidet sich vom C#‑Standard. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Thumbnail‑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) bereitgestellt. |
debugMode | false | Zusätzliche Client‑Diagnosen. |
FitType | "" | Keine automatische Anpassung, sofern nicht angegeben. |
BasePath | "DocImage.axd" | Standardwert des Legacy‑Handlers. Setzen Sie ihn explizit für ASP.NET Core. |
ResPath | "" | Explizit auf den Pfad der eingebetteten Bilder setzen. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | In‑Memory‑Seitenvorladefenster und Verzögerung. |
autoLoad | false | Ein expliziter Token‑Fluss wird empfohlen. |
largeDoc | true | Weicht vom C#‑Standard ab. |
fixedZoom | false | Weicht vom C#‑Standard ab. |
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 einen der Standardwerte zu verlassen:
<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 Seitenanfrage wird gestartet. |
onPageLoaded | pageNum | Ein Seitenbild wurde geladen. |
onThumbnailClicked | pageNum | Der Benutzer hat ein Thumbnail 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 einen beschäftigten Zustand übergegangen. |
onViewerReady | none | Initialisierung abgeschlossen. |
onViewerError | none | Der Viewer ist in den Fehlermodus übergegangen. |
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 Thumbnail‑Panel wurde sichtbar. |
onAnnLoaded | none | Annotierungsdaten geladen. |
onAnnSaved | none | Annotierungsdaten gespeichert. |
onAnnSaveError | none | Speichern der Annotation fehlgeschlagen. |
onAnnClosed | none | Annotation‑UI geschlossen. |
Halten Sie Rückrufe 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) |
| Vorschaubilder | 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 Funktionsleitfäden dokumentiert sind, als stabile Integrationspunkte.
Wiederholen, 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:
| Option | Standard |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Lassen Sie es für den normalen Betrachter deaktiviert. Das Aktivieren kann ein nicht unterstütztes synchrones Rendering nicht asynchron machen.
Pfad-Checkliste
DoconutOptions.MiddlewarePathmuss den Branch beschreiben, den Sie tatsächlich zuordnen.BasePathmuss diesen Branch 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.ResourcesPathist die Route für eingebettete Ressourcen.ResPathzielt normalerweise auf seinenimagesUnterordner ab, ebenfalls ohne ein führendes/('doconut-res/images').ExtractHyperlinksmuss in der Serverformat-Konfiguration aktiviert sein, bevorshowHyperlinksetwas anzeigen kann.
War diese Seite hilfreich?