ViewerConfig
Client viewer widget options
ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προγράμματος περιήγησης προβολής. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το μακροχρόνιο widget 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 | Συνιστάται ρητή ροή διακριτικού. |
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 | κανένα | Ο προβολέας έλαβε διπλό κλικ. |
onViewerBusy | κανένα | Ο προβολέας εισήλθε σε κατάσταση απασχόλησης. |
onViewerReady | κανένα | Η αρχικοποίηση ολοκληρώθηκε. |
onViewerError | κανένα | Ο προβολέας εισήλθε στην κατάσταση σφάλματος. |
onError | message | Μια λειτουργία επέστρεψε μήνυμα σφάλματος. |
onCopy | data | Διατίθενται δεδομένα αντιγραφής κειμένου. |
onAutoLoadStatus | pageNum | Η αυτόματη φόρτωση προχώρησε σε μια σελίδα. |
onThumbsShown | κανένα | Το πάνελ μικρογραφιών έγινε ορατό. |
onAnnLoaded | κανένα | Τα δεδομένα σχολιασμού φορτώθηκαν. |
onAnnSaved | κανένα | Τα δεδομένα σχολιασμού αποθηκεύτηκαν. |
onAnnSaveError | κανένα | Η αποθήκευση σχολιασμού απέτυχε. |
onAnnClosed | κανένα | Το 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 | 150 |
retryMaxTotalMs | 300000 |
Αφήστε το απενεργοποιημένο για τον κανονικό προβολέα. Η ενεργοποίησή του δεν μπορεί να κάνει μια μη υποστηριζόμενη συγχρονική απόδοση ασύγχρονη.
Λίστα ελέγχου διαδρομής
DoconutOptions.MiddlewarePathπρέπει να περιγράφει το κλαδί που πραγματικά αντιστοιχίζετε.BasePathπρέπει να στοχεύει εκείνο το κλαδί, γραμμένο χωρίς προπορευόμενο/('doconut', όχι'/doconut': ο προβολέας προσθέτει την κάθετος, και//doconut/...είναι ένα αίτημα σε άλλο κεντρικό υπολογιστή).DoconutOptions.ResourcesPathείναι η διαδρομή ενσωματωμένου πόρου.ResPathσυνήθως στοχεύει το υποφάκελοimagesτου, επίσης χωρίς προπορευόμενο/('doconut-res/images').ExtractHyperlinksπρέπει να είναι ενεργοποιημένο στη ρύθμιση μορφής του διακομιστή πριν τοshowHyperlinksμπορεί να εμφανίσει οτιδήποτε.
Ήταν αυτή η σελίδα χρήσιμη;