ViewerConfig

Επιλογές widget προβολέα πελάτη

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

Ιδιότητες C#

ΤύποςΙδιότηταΠροεπιλογήΠεριγραφή
boolShowThumbstrueΕμφανίζει το πάνελ μικρογραφιών.
boolAutoLoadfalseΦορτώνεται αυτόματα μετά την αρχικοποίηση. Η κανονική ροή διακριτικών καλεί το View(token) ρητά.
boolAutoFocustrueΜετακινεί την εστίαση/κύλιση του προγράμματος περιήγησης στον προβολέα κατά την αρχικοποίηση.
boolAutoPageFocustrueΔιατηρεί την τρέχουσα μικρογραφία ορατή ενώ αλλάζουν οι σελίδες.
intPageZoom100Αρχικό ποσοστό ζουμ.
intZoomStep10Ποσοστό που προστίθεται ή αφαιρείται από τις εντολές ζουμ.
intMaxZoom300Μέγιστο ποσοστό ζουμ.
boolShowToolTiptrueΕμφανίζει το tooltip θέσης σελίδας κατά την κύλιση.
stringToolTipPageText"Page "Πρόθεμα που χρησιμοποιείται στο tooltip σελίδας.
boolCacheEnabledfalseΔιατηρεί ένα κινούμενο παράθυρο εικόνων σελίδας στη μνήμη του προγράμματος περιήγησης. Δεν χρησιμοποιεί το localStorage.
boolLargeDocfalseΠροσθέτει στοιχεία σελίδας σε χρονομετρημένες παρτίδες για μεγάλα έγγραφα.
boolShowHyperlinksfalseΑποδίδει επικάλυψη υπερσυνδέσμων όταν η διαμόρφωση του διακομιστή τα εξάγει.
boolFixedZoomtrueΧρησιμοποιεί σταθερό ποσοστό ζουμ αντί για επαναϋπολογισμό απόκρισης.
intFixedZoomPercent100Σταθερό ζουμ επιφάνειας εργασίας.
intFixedZoomPercentMobile75Σταθερό ζουμ κινητής συσκευής.
stringBasePath"/"Πού ο προβολέας στέλνει αιτήματα σελίδων. Το "/" είναι DocImage.axd στη ρίζα του ιστότοπου· διαφορετικά ο κλάδος όπου ο κεντρικός υπολογιστής αντιστοιχίζει το UseDoconut(), χωρίς προπορευόμενο / (το "doconut" σημαίνει /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" before)Φάκελος από τον οποίο το widget φορτώνει τις δικές του εικόνες: ο φάκελος images κάτω από το ResourcesPath, χωρίς προπορευόμενο /.
stringFitType"width""width", "height", ή κενό για να μην υπάρχει αυτόματη προσαρμογή. Το "page" δεν γίνεται αποδεκτό από το τρέχον widget.
boolRetryOn409falseΕνεργοποιεί το 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
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

Προεπιλογές JavaScript

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

ΕπιλογήΠροεπιλογήΣημειώσεις
leftMinWidth / leftMaxWidth220 / 800Όρια πλάτους του πλαισίου μικρογραφιών.
showThumbstrueΑρχική ορατότητα μικρογραφιών.
autoFocus / autoPageFocustrue / falseautoPageFocus διαφέρει από την προεπιλογή C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Γεωμετρία μικρογραφιών σε εικονοστοιχεία.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom διαφέρει από το C# (300).
showToolTip / toolTipPageTexttrue / "Page "Συμβουλή εργαλείου θέσης σελίδας.
format / doc / AccessToken"" / 0 / ""Εσωτερικές τιμές αρχικοποίησης· συνήθως γεμίζονται από View(token).
debugModefalseΠρόσθετες διαγνώσεις πελάτη.
FitType""Καμία αυτόματη προσαρμογή εκτός αν δοθεί.
BasePath"DocImage.axd"Προεπιλογή παλαιού χειριστή. Ορίστε το ρητά για το ASP.NET Core.
ResPath""Ορίστε ρητά τη διαδρομή ενσωματωμένων εικόνων.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Παράθυρο προφόρτωσης σελίδας στη μνήμη και καθυστέρηση.
autoLoadfalseΣυνιστάται ρητή ροή token.
largeDoctrueΔιαφέρει από την προεπιλογή C#.
fixedZoomfalseΔιαφέρει από την προεπιλογή C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Η κινητή τιμή διαφέρει από το C# (75).
showHyperlinkstrueΑπαιτεί εξαγωγή από τον διακομιστή για τη δημιουργία επικάλυψεων.

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

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>

Αναδρομές

ΑναδρομήΟρίσματαΣκοπός
onPageLoadingpageNumΈνα αίτημα σελίδας ξεκινά.
onPageLoadedpageNumΜια εικόνα σελίδας ολοκλήρωσε τη φόρτωση.
onThumbnailClickedpageNumΟ χρήστης επέλεξε μια μικρογραφία.
onPageClickedpageNumΟ χρήστης επέλεξε μια σελίδα.
onDoubleClicknoneΟ προβολέας έλαβε διπλό κλικ.
onViewerBusynoneΟ προβολέας εισήλθε σε κατάσταση απασχόλησης.
onViewerReadynoneΗ αρχικοποίηση ολοκληρώθηκε.
onViewerErrornoneΟ προβολέας εισήλθε στην κατάσταση σφάλματος.
onErrormessageΜια λειτουργία επέστρεψε μήνυμα σφάλματος.
onCopydataΔιατίθενται δεδομένα αντιγραφής κειμένου.
onAutoLoadStatuspageNumΗ αυτόματη φόρτωση προχώρησε σε μια σελίδα.
onThumbsShownnoneΤο πάνελ μικρογραφιών έγινε ορατό.
onAnnLoadednoneΤα δεδομένα σχολιασμού φορτώθηκαν.
onAnnSavednoneΤα δεδομένα σχολιασμού αποθηκεύτηκαν.
onAnnSaveErrornoneΑποτυχία αποθήκευσης σχολιασμού.
onAnnClosednoneΤο UI σχολιασμού έκλεισε.

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

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

ΟμάδαΚοινές μέθοδοι
LifecycleView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavigationGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom and fitZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientationRotate(page, angle), Flip(page, flipType)
ThumbnailsHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
SearchCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnnotationSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CopyCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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

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

retryOn409 διατηρεί το ιστορικό του όνομα. Είναι για ασύγχρονη παραγωγή σελίδων και επαναλαμβάνει την τρέχουσα 202 Accepted απόκριση ετοιμότητας καθώς και το παλαιότερο σήμα 409 Conflict. Όταν είναι ενεργοποιημένο, το widget ελέγχει με αυτές τις προεπιλογές JavaScript:

ΕπιλογήΠροεπιλογή
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

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

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

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

Ήταν αυτή η σελίδα χρήσιμη;