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

ViewerConfig (namespace Doconut) περιγράφει την εμφάνιση και τη συμπεριφορά του προβολέα του προγράμματος περιήγησης. Δεν επηρεάζει την ποιότητα απόδοσης του εγγράφου· χρησιμοποιήστε μια διαμόρφωση μορφής γι' αυτό. Η κλάση C# και το παλιό plugin 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`	Ενεργοποιεί το polling όταν ένα ασύγχρονο/διανεμημένο αίτημα σελίδας απαντά με `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.
`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 σχολίων έκλεισε.

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

Το αρχείο JavaScript περιέχει επίσης εσωτερικούς βοηθούς. Θεωρήστε σταθερά σημεία ενσωμάτωσης μόνο τις μεθόδους που χρησιμοποιούνται από το 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)`

Επανάληψη μετά από HTTP 409

retryOn409 είναι για ασύγχρονη παραγωγή σελίδας. Όταν ενεργοποιηθεί, το widget κάνει polling με αυτές τις προεπιλογές JavaScript:

Επιλογή	Προεπιλογή
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

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

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

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