ViewerConfig

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

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

Ιδιότητες C#

ΤύποςΙδιότηταΠροεπιλογήΠεριγραφή
boolShowThumbstrueΕμφάνιση του πίνακα μικρογραφιών.
boolAutoLoadfalseΑυτόματη φόρτωση μετά την αρχικοποίηση. Η κανονική ροή token καλεί το View(token) ρητά.
boolAutoFocustrueΜετακίνηση της εστίασης/κύλισης του προγράμματος περιήγησης στον προβολέα κατά την αρχικοποίηση.
boolAutoPageFocustrueΔιατήρηση της τρέχουσας μικρογραφίας ορατής ενώ αλλάζουν οι σελίδες.
intPageZoom100Αρχικό ποσοστό ζουμ.
intZoomStep10Ποσοστό που προστίθεται ή αφαιρείται από τις εντολές ζουμ.
intMaxZoom300Μέγιστο ποσοστό ζουμ.
boolShowToolTiptrueΕμφάνιση του tooltip θέσης σελίδας κατά την κύλιση.
stringToolTipPageText"Page "Πρόθεμα που χρησιμοποιείται στο tooltip σελίδας.
boolCacheEnabledfalseΔιατήρηση ενός κινούμενου παραθύρου εικόνων σελίδας στη μνήμη του προγράμματος περιήγησης. Δεν χρησιμοποιεί το localStorage.
boolLargeDocfalseΠροσθήκη στοιχείων σελίδας σε χρονομετρημένες παρτίδες για μεγάλα έγγραφα.
boolShowHyperlinksfalseΑπόδοση επικάλυψης υπερσυνδέσμων όταν η διαμόρφωση διακομιστή τα εξάγει.
boolFixedZoomtrueΧρήση σταθερού ποσοστού ζουμ αντί για επαναϋπολογισμό απόκρισης.
intFixedZoomPercent100Σταθερό ζουμ επιφάνειας εργασίας.
intFixedZoomPercentMobile75Σταθερό ζουμ κινητής συσκευής.
stringBasePath"/"Πού ο προβολέας στέλνει αιτήματα σελίδας. Το "/" είναι ο χειριστής DocImage.axd στη ρίζα του ιστότοπου. Για μια εφαρμογή σε εικονικό κατάλογο, χρησιμοποιήστε το όνομα του καταλόγου χωρίς ένα αρχικό / (το "myapp" σημαίνει /myapp/DocImage.axd).
stringResPath"doconut-res/images"Φάκελος από τον οποίο το widget φορτώνει τις δικές του εικόνες: ο φάκελος images κάτω από το ResourcesPath, χωρίς ένα αρχικό /.
stringFitType"width""width", "height", ή κενό για να μην υπάρχει αυτόματη προσαρμογή. Το "page" δεν γίνεται αποδεκτό από το τρέχον widget.
boolRetryOn409falseΕπαναπροσπάθειες αιτημάτων σελίδας που απαντούν «still rendering». Το DocImage.axd αποδίδει συγχρονισμένα και δεν στέλνει ποτέ αυτό το σήμα· αφήστε το false.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = ο χειριστής DocImage.axd στη ρίζα του ιστότοπου (Web.config)
    ResPath = "doconut-res/images", // ο φάκελος images κάτω από το ResourcesPath, χωρίς αρχικό '/'
    ShowHyperlinks = true
};
// Εκδόστε το με viewer.RenderViewer("viewerEl", token, config) - δείτε την αναφορά Viewer.

Δημιουργία ViewerConfig με RenderViewer

Viewer.RenderViewer(elementId, token, config) μετατρέπει ένα ViewerConfig σε script αρχικοποίησης του widget. Γράφει έξι από τις παραπάνω ιδιότητες — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom και FitType — και στη συνέχεια καλεί το View(token). Οι άλλες ιδιότητες δεν γράφονται: για MaxZoom, ShowHyperlinks, τις ρυθμίσεις ζουμ ή οποιοδήποτε callback, αρχικοποιήστε το widget μόνοι σας με τις παρακάτω επιλογές JavaScript. Δείτε το Viewer για RenderViewer.

Αντιστοίχιση C# σε JavaScript

Μην περάσετε ένα άμεσα σειριακό ViewerConfig στο docViewer(...). Τα περισσότερα κλειδιά του widget είναι camelCase, ενώ τρία καθιερωμένα κλειδιά path/fit είναι 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Το maxZoom της JavaScript διαφέρει από το C# (300).
showToolTip / toolTipPageTexttrue / "Page "Υπόδειξη θέσης σελίδας.
format / doc / AccessToken"" / 0 / ""Εσωτερικές τιμές αρχικοποίησης· συνήθως γεμίζονται από View(token).
debugModefalseΠρόσθετες διαγνώσεις πελάτη.
FitType""Καμία αυτόματη προσαρμογή εκτός εάν δοθεί.
BasePath"DocImage.axd"Παλαιότερη προεπιλογή. Ορίστε την ρητά: '/' για το χειριστή στη ρίζα του ιστότοπου.
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: '/',
    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 σχολιασμού έκλεισε.

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

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

ΟμάδαΚοινές μέθοδοι
Κύκλος ζωής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 και τεκμηριώνονται εδώ ή στους οδηγούς χαρακτηριστικών ως σταθερά σημεία ενσωμάτωσης.

Επιλογές επανάληψης

Το widget επίσης δέχεται retryOn409 και τις ρυθμίσεις επαναπροσέγγισής του (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Σερβίρουν εγκαταστάσεις των οποίων οι σελίδες παράγονται στο παρασκήνιο. DocImage.axd αποδίδει κάθε σελίδα κατά τη διάρκεια του αιτήματος, οπότε αφήστε το retryOn409 απενεργοποιημένο.

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

  • BasePath είναι '/' όταν ο χειριστής DocImage.axd βρίσκεται στη ρίζα του site — το χαρακτηριστικό path του χειριστή στο Web.config καθορίζει πού απαντά. Σε εικονικό φάκελο, χρησιμοποιήστε το όνομα του φακέλου χωρίς αρχικό / ('myapp', όχι '/myapp': ο προβολέας προσθέτει την κάθετο, και //myapp/... είναι αίτημα σε άλλο κεντρικό υπολογιστή).
  • DoconutOptions.ResourcesPath είναι όπου το module πόρων εξυπηρετεί τα ενσωματωμένα αρχεία (/doconut-res από προεπιλογή).
  • ResPath στοχεύει το υποφάκελο images του, επίσης χωρίς αρχικό / ('doconut-res/images'). Η κατεύθυνση του προς 'doconut-res' κάνει κάθε εικονίδιο 404 ενώ το έγγραφο εξακολουθεί να αποδίδεται.
  • Στο MVC, το routes.IgnoreRoute("doconut-res/{*pathInfo}") πρέπει να ακολουθεί το ResourcesPath αν το αλλάξετε.
  • Το ExtractHyperlinks πρέπει να είναι ενεργοποιημένο στη διαμόρφωση μορφής του διακομιστή πριν το showHyperlinks μπορεί να εμφανίσει οτιδήποτε.

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