ViewerConfig
Επιλογές widget προβολέα πελάτη
ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προβολέα του προγράμματος περιήγησης. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το παλαιό πρόσθετο JavaScript έχουν διαφορετικές προεπιλογές, επομένως αντιστοιχίστε τις τιμές ρητά.
Ιδιότητες C#
| Τύπος | Ιδιότητα | Προεπιλογή | Περιγραφή |
|---|---|---|---|
bool | ShowThumbs | true | Εμφανίζει το πάνελ μικρογραφιών. |
bool | AutoLoad | false | Φορτώνεται αυτόματα μετά την αρχικοποίηση. Η κανονική ροή διακριτικών καλεί το 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 επίσης γίνεται αποδεκτό για συμβατότητα με παλαιότερους διακομιστές. Δεν απαιτείται από τον κανονικό συγχρονισμένο προβολέα. |
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 | JavaScript maxZoom διαφέρει από το C# (300). |
showToolTip / toolTipPageText | true / "Page " | Συμβουλή εργαλείου θέσης σελίδας. |
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 | Απαιτεί εξαγωγή από τον διακομιστή για τη δημιουργία επικάλυψεων. |
Ορίστε όλες τις τιμές που επηρεάζουν τη συμπεριφορά αντί να βασίζεστε σε κάποιο από τα σύνολα προεπιλογών:
<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 σχολιασμού έκλεισε. |
Κρατήστε τις αναδρομές γρήγορες· στείλτε τηλεμετρία ασύγχρονα και μην μπλοκάρετε την απόδοση της σελίδας.
Ομάδες δημόσιων μεθόδων
| Ομάδα | Κοινές μέθοδοι |
|---|---|
| Lifecycle | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Navigation | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Zoom and fit | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Orientation | Rotate(page, angle), Flip(page, flipType) |
| Thumbnails | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Search | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Annotation | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Copy | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
Το αρχείο JavaScript περιέχει επίσης εσωτερικούς βοηθούς. Θεωρήστε μόνο τις μεθόδους που χρησιμοποιούνται από το αναφορά UI και τεκμηριώνονται εδώ ή στους οδηγούς χαρακτηριστικών ως σταθερά σημεία ενσωμάτωσης.
Επανάληψη ενώ μια κατανεμημένη σελίδα εξακολουθεί να αποδίδεται
retryOn409 διατηρεί το ιστορικό του όνομα. Είναι για ασύγχρονη παραγωγή σελίδων και επαναλαμβάνει την τρέχουσα 202 Accepted απόκριση ετοιμότητας καθώς και το παλαιότερο σήμα 409 Conflict. Όταν είναι ενεργοποιημένο, το widget ελέγχει με αυτές τις προεπιλογές JavaScript:
| Επιλογή | Προεπιλογή |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Αφήστε το απενεργοποιημένο για τον κανονικό προβολέα. Η ενεργοποίησή του δεν μπορεί να μετατρέψει μια μη υποστηριζόμενη συγχρονισμένη απόδοση σε ασύγχρονη.
Λίστα ελέγχου διαδρομής
- Το
DoconutOptions.MiddlewarePathπρέπει να περιγράφει το κλαδί που πραγματικά αντιστοιχίζετε. - Το
BasePathπρέπει να στοχεύει εκείνο το κλαδί, γραμμένο χωρίς προπορευόμενο/('doconut', όχι'/doconut': ο προβολέας προσθέτει την κάθετο, και το//doconut/...είναι ένα αίτημα σε άλλο διακομιστή). - Το
DoconutOptions.ResourcesPathείναι η διαδρομή ενσωματωμένου πόρου. - Το
ResPathσυνήθως στοχεύει το υποφάκελοimagesτου, επίσης χωρίς προπορευόμενο/('doconut-res/images'). - Το
ExtractHyperlinksπρέπει να είναι ενεργοποιημένο στη ρύθμιση μορφής του διακομιστή πριν τοshowHyperlinksμπορεί να εμφανίσει οτιδήποτε.
Ήταν αυτή η σελίδα χρήσιμη;