ViewerConfig – Doconut Τεκμηρίωση

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

Ιδιότητες C#

Τύπος	Ιδιότητα	Προεπιλογή	Περιγραφή
`bool`	`ShowThumbs`	`true`	Εμφανίζει το πάνελ μικρογραφιών.
`bool`	`AutoLoad`	`false`	Φορτώνει αυτόματα μετά την αρχικοποίηση. Η κανονική ροή token καλεί ρητά το `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`	`"/"`	Κλάδος όπου ο κεντρικός υπολογιστής αντιστοιχεί το `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	Βάση πόρων που χρησιμοποιείται από το widget. Σε κανονική ρύθμιση, δείξτε το στο `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`\"width\", \"height\", ή κενό για καμία αυτόματη προσαρμογή. Το \"page\" δεν γίνεται αποδεκτό από το τρέχον widget.`
`bool`	`RetryOn409`	`false`	Ενεργοποιεί την ανάκληση όταν η ασύγχρονη/διανεμημένη παραγωγή σελίδων απαντά με `202 Accepted`; το `409` επίσης γίνεται αποδεκτό για συμβατότητα με παλαιότερους διακομιστές. Δεν απαιτείται από τον κανονικό συγχρονισμένο προβολέα.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    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`	`maxZoom` της JavaScript διαφέρει από την C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	Tooltip θέσης σελίδας.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	Εσωτερικές τιμές αρχικοποίησης· συνήθως γεμίζονται από το `View(token)`.
`debugMode`	`false`	Επιπλέον διαγνωστικά του πελάτη.
`FitType`	`""`	Καμία αυτόματη προσαρμογή εκτός αν δοθεί.
`BasePath`	`"DocImage.axd"`	Ιστορική προεπιλογή πελάτη διατηρείται για συμβατότητα. Οι τρέχοντες κεντρικοί υπολογιστές ASP.NET Core πρέπει να το ορίσουν ρητά στο αντιστοιχισμένο κλαδί middleware.
`ResPath`	`""`	Ορίζεται ρητά στη διαδρομή ενσωματωμένων εικόνων.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	Παράθυρο προφόρτωσης σελίδων στη μνήμη και καθυστέρηση.
`autoLoad`	`false`	Συνιστάται ρητή ροή token.
`largeDoc`	`true`	Διαφέρει από την προεπιλογή C#.
`fixedZoom`	`false`	Διαφέρει από την προεπιλογή C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	Η τιμή για κινητές διαφέρει από την C# (`75`).
`showHyperlinks`	`true`	Απαιτεί εξαγωγή από τον διακομιστή για δημιουργία επαφών.

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

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>

Κλήσεις επιστροφής

Κλήση	Ορίσματα	Σκοπός
`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 σχολιασμού έκλεισε.

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

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

Ομάδα	Κοινές μέθοδοι
Κύκλος ζωής	`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`	`60`
`retryMaxTotalMs`	`120000`

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

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

DoconutOptions.MiddlewarePath πρέπει να περιγράφει το κλαδί που πραγματικά αντιστοιχίζετε.
BasePath πρέπει να στοχεύει σε αυτό το κλαδί.
DoconutOptions.ResourcesPath είναι η διαδρομή ενσωματωμένων πόρων.
ResPath συνήθως στοχεύει στον υποφάκελο /images.
ExtractHyperlinks πρέπει να είναι ενεργοποιημένο στη διαμόρφωση μορφής του διακομιστή πριν το showHyperlinks μπορεί να εμφανίσει κάτι.