ViewerConfig – Doconut Τεκμηρίωση

ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προβολέα του προγράμματος περιήγησης. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το παλαιό πρόσθετο JavaScript έχουν διαφορετικές προεπιλογές, οπότε αντιστοιχίστε τις τιμές ρητά.

Ιδιότητες C#

Τύπος	Ιδιότητα	Προεπιλογή	Περιγραφή
`bool`	`ShowThumbs`	`true`	Εμφάνιση του πίνακα μικρογραφιών.
`bool`	`AutoLoad`	`false`	Αυτόματη φόρτωση μετά την αρχικοποίηση. Η κανονική ροή token καλεί το `View(token)` ρητά.
`bool`	`AutoFocus`	`true`	Μετακίνηση της εστίασης/κύλισης του προγράμματος περιήγησης στον προβολέα κατά την αρχικοποίηση.
`bool`	`AutoPageFocus`	`true`	Διατήρηση της τρέχουσας μικρογραφίας ορατής ενώ αλλάζουν οι σελίδες.
`int`	`PageZoom`	`100`	Αρχικό ποσοστό ζουμ.
`int`	`ZoomStep`	`10`	Ποσοστό που προστίθεται ή αφαιρείται με εντολές ζουμ.
`int`	`MaxZoom`	`300`	Μέγιστο ποσοστό ζουμ.
`bool`	`ShowToolTip`	`true`	Εμφάνιση του tooltip θέσης σελίδας κατά την κύλιση.
`string`	`ToolTipPageText`	`"Page "`	Πρόθεμα που χρησιμοποιείται στο tooltip σελίδας.
`bool`	`CacheEnabled`	`false`	Διατήρηση ενός κινούμενου παραθύρου εικόνων σελίδας στη μνήμη του προγράμματος περιήγησης. Δεν χρησιμοποιεί το `localStorage`.
`bool`	`LargeDoc`	`false`	Προσθήκη στοιχείων σελίδας σε χρονομετρημένες παρτίδες για μεγάλα έγγραφα.
`bool`	`ShowHyperlinks`	`false`	Απόδοση επικάλυψης υπερσυνδέσμων όταν η διαμόρφωση διακομιστή τα εξάγει.
`bool`	`FixedZoom`	`true`	Χρήση σταθερού ποσοστού ζουμ αντί για προσαρμοστικό επανυπολογισμό.
`int`	`FixedZoomPercent`	`100`	Σταθερό ζουμ επιφάνειας εργασίας.
`int`	`FixedZoomPercentMobile`	`75`	Σταθερό ζουμ κινητής συσκευής.
`string`	`BasePath`	`"/"`	Που ο προβολέας στέλνει αιτήματα σελίδας. Το `"/"` είναι `DocImage.axd` στη ρίζα του ιστότοπου· διαφορετικά ο κλάδος όπου ο κεντρικός υπολογιστής αντιστοιχίζει το `UseDoconut()`, χωρίς αρχικό `/` (το `"doconut"` σημαίνει `/doconut/DocImage.axd`).
`string`	`ResPath`	`"doconut-res/images"` (26.9.0; `"doconut-res"` before)	Φάκελος από τον οποίο το widget φορτώνει τις δικές του εικόνες: ο φάκελος `images` κάτω από το `ResourcesPath`, χωρίς αρχικό `/`.
`string`	`FitType`	`"width"`	`"width"`, `"height"`, ή κενό για καμία αυτόματη προσαρμογή. Το `"page"` δεν γίνεται αποδεκτό από το τρέχον widget.
`bool`	`RetryOn409`	`false`	Ενεργοποίηση polling όταν ένα ασύγχρονο/διανεμημένο αίτημα σελίδας απαντά `409`. Δεν απαιτείται από τον κανονικό συγχρονισμένο προβολέα.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // χωρίς αρχικό '/' : ο προβολέας το προσθέτει ("/doconut" θα γίνει //doconut, άλλο host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

Χαρτογράφηση C# σε JavaScript

Μην περάσετε ένα άμεσα σειριοποιημένο ViewerConfig στο docViewer(...). Τα περισσότερα κλειδιά του widget είναι camelCase, ενώ τρία καθιερωμένα κλειδιά path/fit είναι PascalCase.

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

Το widget έχει παλαιότερες προεπιλογές που διαφέρουν από την κλάση C#. Οι παρακάτω τιμές προέρχονται από την τρέχουσα υλοποίηση docViewer.js.

Επιλογή	Προεπιλογή	Σημειώσεις
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	Όρια πλάτους του πλαισίου μικρογραφιών.
`showThumbs`	`true`	Αρχική ορατότητα μικρογραφιών.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` διαφέρει από την προεπιλογή C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	Γεωμετρία μικρογραφιών σε εικονοστοιχεία.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	Το JavaScript `maxZoom` διαφέρει από το C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Tooltip θέσης σελίδας.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Εσωτερικές τιμές αρχικοποίησης· συνήθως γεμίζονται από το `View(token)`.
`debugMode`	`false`	Πρόσθετη διάγνωση πελάτη.
`FitType`	`""`	Καμία αυτόματη προσαρμογή εκτός εάν δοθεί.
`BasePath`	`"DocImage.axd"`	Προεπιλογή παλαιού χειριστή. Ορίστε το ρητά για το ASP.NET Core.
`ResPath`	`""`	Ορίστε ρητά τη διαδρομή ενσωματωμένων εικόνων.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Παράθυρο προφόρτωσης σελίδων στη μνήμη και καθυστέρηση.
`autoLoad`	`false`	Συνιστάται ρητή ροή token.
`largeDoc`	`true`	Διαφέρει από την προεπιλογή C#.
`fixedZoom`	`false`	Διαφέρει από την προεπιλογή C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Η τιμή για κινητές συσκευές διαφέρει από το C# (`75`).
`showHyperlinks`	`true`	Απαιτεί εξαγωγή από τον διακομιστή για την παραγωγή επικαλύψεων.

Ορίστε όλες τις τιμές που είναι σημαντικές για τη συμπεριφορά αντί να βασίζεστε σε κάποιο σύνολο προεπιλογών:

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>

Κλήσεις επιστροφής

Κλήση	Ορίσματα	Σκοπός
`onPageLoading`	`pageNum`	Ένα αίτημα σελίδας ξεκινά.
`onPageLoaded`	`pageNum`	Η εικόνα μιας σελίδας ολοκληρώθηκε τη φόρτωση.
`onThumbnailClicked`	`pageNum`	Ο χρήστης επέλεξε μια μικρογραφία.
`onPageClicked`	`pageNum`	Ο χρήστης επέλεξε μια σελίδα.
`onDoubleClick`	none	Ο προβολέας έλαβε διπλό κλικ.
`onViewerBusy`	none	Ο προβολέας εισήλθε σε κατάσταση απασχόλησης.
`onViewerReady`	none	Η αρχικοποίηση ολοκληρώθηκε.
`onViewerError`	none	Ο προβολέας εισήλθε στην κατάσταση σφάλματος.
`onError`	`message`	Μια λειτουργία επέστρεψε μήνυμα σφάλματος.
`onCopy`	`data`	Τα δεδομένα αντιγραφής κειμένου είναι διαθέσιμα.
`onAutoLoadStatus`	`pageNum`	Η αυτόματη φόρτωση προχώρησε σε μια σελίδα.
`onThumbsShown`	none	Ο πίνακας μικρογραφιών έγινε ορατός.
`onAnnLoaded`	none	Τα δεδομένα σχολιασμού φορτώθηκαν.
`onAnnSaved`	none	Τα δεδομένα σχολιασμού αποθηκεύτηκαν.
`onAnnSaveError`	none	Αποτυχία αποθήκευσης σχολιασμού.
`onAnnClosed`	none	Το UI σχολιασμού έκλεισε.

Διατηρήστε τις κλήσεις επιστροφής γρήγορες· στείλτε τηλεμετρία ασύγχρονα και μην μπλοκάρετε την απόδοση της σελίδας.

Δημόσιες ομάδες μεθόδων

Ομάδα	Κοινές μέθοδοι
Κύκλος ζωής	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
Πλοήγηση	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
Ζουμ και προσαρμογή	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
Προσανατολισμός	`Rotate(page, angle)`, `Flip(page, flipType)`
Μικρογραφίες	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
Αναζήτηση	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
Σχολιασμός	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
Αντιγραφή	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

Το αρχείο JavaScript περιέχει επίσης εσωτερικούς βοηθούς. Θεωρήστε μόνο τις μεθόδους που χρησιμοποιούνται από το αναφορά UI και τεκμηριώνονται εδώ ή στους οδηγούς χαρακτηριστικών ως σταθερά σημεία ενσωμάτωσης.

Επανάληψη μετά από HTTP 409

retryOn409 είναι για ασύγχρονη παραγωγή σελίδων. Όταν είναι ενεργοποιημένο, το widget ελέγχει με αυτές τις προεπιλογές JavaScript:

Επιλογή	Προεπιλογή
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Αφήστε το απενεργοποιημένο για τον κανονικό προβολέα. Η ενεργοποίησή του δεν μπορεί να κάνει μια μη υποστηριζόμενη συγχρονική απόδοση ασύγχρονη.

Λίστα ελέγχου διαδρομής

DoconutOptions.MiddlewarePath πρέπει να περιγράφει το κλαδί που πραγματικά αντιστοιχίζετε.
BasePath πρέπει να στοχεύει αυτό το κλαδί, γραμμένο χωρίς το αρχικό / ('doconut', όχι '/doconut': ο προβολέας προσθέτει την κάθετο, και //doconut/... είναι ένα αίτημα σε άλλο διακομιστή).
DoconutOptions.ResourcesPath είναι η διαδρομή ενσωματωμένου πόρου.
ResPath συνήθως στοχεύει το υποφάκελο images, επίσης χωρίς το αρχικό / ('doconut-res/images').
ExtractHyperlinks πρέπει να είναι ενεργοποιημένο στη διαμόρφωση μορφής του διακομιστή πριν το showHyperlinks μπορεί να εμφανίσει οτιδήποτε.