ViewerConfig

Client viewer widget options

ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προγράμματος περιήγησης προβολής. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το μακροχρόνιο widget 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 / 200Το JavaScript 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Συνιστάται ρητή ροή διακριτικού.
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Ο χρήστης επέλεξε μια σελίδα.
onDoubleClickκανέναΟ προβολέας έλαβε διπλό κλικ.
onViewerBusyκανέναΟ προβολέας εισήλθε σε κατάσταση απασχόλησης.
onViewerReadyκανέναΗ αρχικοποίηση ολοκληρώθηκε.
onViewerErrorκανέναΟ προβολέας εισήλθε στην κατάσταση σφάλματος.
onErrormessageΜια λειτουργία επέστρεψε μήνυμα σφάλματος.
onCopydataΔιατίθενται δεδομένα αντιγραφής κειμένου.
onAutoLoadStatuspageNumΗ αυτόματη φόρτωση προχώρησε σε μια σελίδα.
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:

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

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

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

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

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