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

ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προβολέα του προγράμματος περιήγησης. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το μακροχρόνιο widget 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 όταν η ασύγχρονη/διανεμημένη παραγωγή σελίδων ανταποκρίνεται στο `202 Accepted`· το `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, ενώ τρία καθιερωμένα κλειδιά διαδρομής/προσαρμογής είναι 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`	Το `maxZoom` της JavaScript διαφέρει από το C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Υπόδειξη θέσης σελίδας.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Εσωτερικές τιμές αρχικοποίησης· συνήθως γεμίζονται από το `View(token)`.
`debugMode`	`false`	Πρόσθετες διαγνωστικές του πελάτη.
`FitType`	`""`	Καμία αυτόματη προσαρμογή εκτός εάν δοθεί.
`BasePath`	`"DocImage.axd"`	Η ιστορική προεπιλογή του πελάτη διατηρείται για συμβατότητα. Οι τρέχοντες κεντρικοί υπολογιστές ASP.NET Core πρέπει να το ορίσουν ρητά στο αντιστοιχισμένο κλαδί middleware.
`ResPath`	`""`	Ορίστε ρητά στη διαδρομή ενσωματωμένων εικόνων.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Παράθυρο προφόρτωσης σελίδων στη μνήμη και καθυστέρηση.
`autoLoad`	`false`	Συνιστάται ρητή ροή διακριτικού.
`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 και τεκμηριώνονται εδώ ή στους οδηγούς χαρακτηριστικών ως σταθερά σημεία ενσωμάτωσης.

Επανάληψη ενώ μια κατανεμημένη σελίδα εξακολουθεί να αποδίδεται

retryOn409 διατηρεί το ιστορικό του όνομα. Είναι για ασύγχρονη παραγωγή σελίδων και επαναλαμβάνει την τρέχουσα απάντηση ετοιμότητας 202 Accepted καθώς και το παλαιότερο σήμα 409 Conflict. Όταν είναι ενεργοποιημένο, το 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 μπορεί να εμφανίσει οτιδήποτε.