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
| Typ | Eigenschaft | Standard | Beschreibung |
|---|---|---|---|
bool | ShowThumbs | true | Zeige das Miniaturbild‑Panel. |
bool | AutoLoad | false | Automatisch nach der Initialisierung laden. Der normale Token‑Fluss ruft View(token) explizit auf. |
bool | AutoFocus | true | Verschiebe den Browser‑Fokus/Scrollen zum Viewer während der Initialisierung. |
bool | AutoPageFocus | true | Halte das aktuelle Thumbnail sichtbar, während die 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 | Zeige den Seitenpositions‑Tooltip beim Scrollen. |
string | ToolTipPageText | "Page " | Präfix, das im Seiten‑Tooltip verwendet wird. |
bool | CacheEnabled | false | Behalte ein rollierendes Fenster von Seitenbildern im Browser‑Speicher. Es verwendet nicht localStorage. |
bool | LargeDoc | false | Füge Seitenelemente in zeitgesteuerten Chargen für große Dokumente hinzu. |
bool | ShowHyperlinks | false | Rendre Hyperlink‑Overlays, wenn die Serverkonfiguration sie extrahiert hat. |
bool | FixedZoom | true | Verwende einen festen Zoom‑Prozentsatz anstelle 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 an der Seitenwurzel; andernfalls der Zweig, in dem der Host UseDoconut() abbildet, ohne ein führendes / ("doconut" bedeutet /doconut/DocImage.axd). |
string | ResPath | "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 /. |
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 für die 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ü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 |
|---|---|
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 Standardwerte, die von der C#‑Klasse abweichen. Die folgenden Werte stammen aus der aktuellen docViewer.js‑Implementierung.
| Option | Standard | Hinweise |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Grenzen der Breite des Miniaturbereichs. |
showThumbs | true | Initiale Miniatur‑Sichtbarkeit. |
autoFocus / autoPageFocus | true / false | autoPageFocus weicht vom C#‑Standard ab. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Miniatur‑Geometrie in Pixeln. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom weicht von C# (300) ab. |
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 | "" | 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 / cacheDelay | false / 3 / 3 | In‑Memory‑Seiten‑Preload‑Fenster 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 weicht von C# (75) ab. |
showHyperlinks | true | Erfordert serverseitige Extraktion, um Overlays zu erzeugen. |
Setzen Sie alle verhaltensrelevanten Werte, anstatt sich auf einen der Standardsätze 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 startet. |
onPageLoaded | pageNum | Ein Seitenbild wurde geladen. |
onThumbnailClicked | pageNum | Der Benutzer hat eine Miniatur 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ä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 | Text‑Kopierdaten sind verfügbar. |
onAutoLoadStatus | pageNum | Automatisches 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ü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) |
| Miniaturen | 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 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:
| 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 Zweig beschreiben, den Sie tatsächlich zuordnen.BasePathmuss 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.ResourcesPathist die Route zur eingebetteten Ressource.ResPathzielt normalerweise auf seinenimagesUnterordner, ebenfalls ohne ein führendes/('doconut-res/images').ExtractHyperlinksmuss in der Serverformat‑Konfiguration aktiviert sein, bevorshowHyperlinksirgendetwas anzeigen kann.
War diese Seite hilfreich?