Αναζήτηση

Φυσική αναζήτηση κειμένου στη σύνθεση Viewer

Το Doconut Viewer παρέχει κανονική Αναζήτηση χρησιμοποιώντας κείμενο που εξάγεται από το format viewer ή μια ανακατεύθυνση PDF βασισμένη σε κείμενο. Απαιτεί τη δυνατότητα άδειας Search.

Ενεργοποίηση του UI αναζήτησης

Η Αναζήτηση είναι ένα module του Viewer, όχι μια αυτόνομη γραμμή εργαλείων. Η πλήρης σελίδα πρέπει να περιλαμβάνει τους πόρους του Viewer, τη γραμμή εργαλείων του Viewer, το mount του Viewer και το αρχικοποιημένο objViewer· η Ribbon Αναζήτησης στη συνέχεια τοποθετείται και συνδέεται με το ίδιο παράδειγμα.

Η Αναζήτηση και η Σχόλιο είναι ενσωματωμένες λειτουργίες με άδεια, όχι πακέτα AddPlugin<T>(). Ζητήστε τους πόρους αναζήτησης από το ενσωματωμένο Viewer· οι ετικέτες τους εκδίδονται μόνο όταν η άδεια παρέχει την Αναζήτηση.

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss = true,
    IncludeSearchCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery = true,
    IncludeViewerScripts = true,
    IncludeSearchScripts = true,
    IncludeSearchBar = true
}))

Η ενσωματωμένη ribbon καλεί τις ίδιες μεθόδους JavaScript που είναι διαθέσιμες σε μια προσαρμοσμένη διεπαφή UI.

Διατηρήστε τη πλήρη σύνθεση Viewer ορατή στο markup, αρχικοποιήστε πρώτα το docViewer και, στη συνέχεια, συνδέστε τη Ribbon με άδεια:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Στοιχεία ελέγχου Viewer, συμπεριλαμβανομένου του κουμπιού που ανοίγει το Search -->
</nav>
<div id="searchBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
    let searchBar = null;
    let currentToken = '';

    const objViewer = $('#div_ctlDoc').docViewer({
        BasePath: 'doconut',
        ResPath: 'doconut-res/images'
    });

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token: currentToken }),
        onStatus: (message) => console.log(message),
        onToast: (message, type) => console.log(type, message),
        onLayout: () => requestAnimationFrame(() => objViewer.Refit())
    });
    searchBar.attach(objViewer);
        </text>
    }
</script>

Το server-side if έχει σημασία: χωρίς τη δυνατότητα Αναζήτησης, το ReferenceScripts παραλείπει το script της Ribbon, έτσι μια μη προστατευμένη κλήση doconutSearchBar(...) θα προκαλέσει σφάλμα και θα σταματήσει την εκκίνηση της σελίδας viewer.

Το στοιχείο ενσωματώνει τις ομάδες Find, Options και Results και διαχειρίζεται την αναζήτηση, τον καθαρισμό, τους μετρητές αντιστοιχίσεων και την πλοήγηση σε προηγούμενη/επόμενη αντιστοιχία. Μια γραμμή εργαλείων Viewer που ανήκει στον κεντρικό υπολογιστή χρειάζεται μόνο να την εναλλάσσει:

javascript
searchBar.isOpen() ? searchBar.close() : searchBar.open();

Το δημόσιο API του είναι σκόπιμα μικρό:

ΜέθοδοςΣκοπός
attach(objViewer)Συνδέει τη Ribbon με το αρχικοποιημένο viewer· απαιτείται μία φορά
open() / close()Εμφανίζει ή κρύβει τη Ribbon· το κλείσιμο επίσης καθαρίζει τις επισημάνσεις
reset()Καθαρίζει τον τρέχοντα όρο, τον αριθμό αποτελεσμάτων και τις επισημάνσεις
isOpen()Αναφέρει αν η Ribbon είναι ορατή
setStatus(message)Προωθεί ένα μήνυμα κατάστασης μέσω της ρυθμισμένης callback

Η προαιρετική callback onToggle(isOpen) επιτρέπει στον κεντρικό υπολογιστή να συγχρονίσει το κουμπί Αναζήτησης, και το onLayout του επιτρέπει να αλλάζει το μέγεθος/προσαρμόζει το viewer όταν η Ribbon αλλάζει ύψος. Για τη συνδυασμένη ακολουθία εκκίνησης Viewer, Αναζήτησης και Σχολιασμού, δείτε Γρήγορη Εκκίνηση.

Αναζήτηση από JavaScript

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

Το δεύτερο όρισμα είναι η αντιστοίχιση ολόκληρης λέξης/ακριβούς. Ο αριθμός αντιστοιχίσεων φτάνει στην callback: το Search στέλνει στον διακομιστή και δεν επιστρέφει τίποτα χρήσιμο, έτσι το var n = objViewer.Search(keyword, false) πάντα διαβάζει το undefined — και μια σελίδα που χτίζεται με αυτόν τον τρόπο αναφέρει «δεν βρέθηκε τίποτα» ενώ το viewer επισημαίνει τις αντιστοιχίες. Μετά την callback:

ΜέθοδοςΑποτέλεσμα
SearchMatchCount()Συνολικές μεμονωμένες αντιστοιχίες στο έγγραφο.
SearchSummary(false)Καταχωρήσεις [pageNumber, matchCount] χωρίς επανασχεδίαση.
SearchSummary(true)Ίδιο σύνοψη και ζωγραφίζει επισημάνσεις σελίδας/μικρογραφίας.
GotoSearchMatch(index)Πλοηγείται σε δείκτη αντιστοιχίας με βάση το μηδέν.

Η διαδρομή middleware χρησιμοποιεί τα search=<term> και exact=true|false και επιστρέφει XML. Χρησιμοποιήστε το widget API αντί να αναλύετε εσείς την εσωτερική αυτή απόκριση.

Έλεγχος δυνατότητας αναζήτησης

Η απάντηση εκκίνησης αναφέρει:

text
X-Doconut-Can-Search: 1

Μετά την εκκίνηση, objViewer.CanSearch() εκθέτει το ίδιο αποτέλεσμα μορφής/συνεδρίας. Επιστρέφει false όταν ο διακομιστής στέλνει 0· πριν από την απάντηση, ή με έναν παλαιότερο διακομιστή που παραλείπει την κεφαλίδα, προεπιλογή είναι true.

Τρία ανεξάρτητα πύλες δεν πρέπει να συγχέονται:

ΠύληΕρώτηση
CanSearch() / response headerΈχει ο επιλυμένος προβολέας εγγενή διαδρομή ευρετηρίου/αναζήτησης;
AllowSearchΖήτησε αυτή η διαμόρφωση μορφής εξαγωγή κειμένου όπου υπάρχει το διακόπτης;
LicenseCapability.SearchΕίναι η εφαρμογή εξουσιοδοτημένη να εκτελεί αναζήτηση και να λαμβάνει τα πακέτα UI;

Μια μορφή μπορεί τεχνικά να είναι αναζητήσιμη ενώ η τρέχουσα άδεια αρνείται τη λειτουργία.

Ενεργοποίηση εξαγωγής ανά μορφή

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // προαιρετικό: επιτρέπει στον χρήστη να σύρει μια περιοχή και να αντιγράψει το κείμενό της
});

AllowSearch και AllowCopy υπάρχουν στο PdfConfig, WordConfig, ExcelConfig και PptConfig. Οι ιδιότητες Office παραπέμπουν στα ένθετα PdfConfig. Και τα δύο προεπιλογή είναι false.

Υπάρχουν κανονικοί προσαρμογείς εγγενούς αναζήτησης για PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB και MHT. Το XPS χρησιμοποιεί την διαδρομή PDF προεπιλογή. Το HTML και το Microsoft Project επωφελούνται από μια ανακατεύθυνση PDF βασισμένη σε κείμενο:

csharp
// DefaultRender = false → μετατράπηκε σε PDF κειμενικού τύπου → αναζητήσιμο
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Για εγγενείς αποτυπωτές, CanSearch() περιγράφει τη δυνατότητα του προβολέα· δεν εγγυάται ότι ένα συγκεκριμένο έγγραφο περιέχει χρήσιμο κείμενο. Ένα PDF των σελίδων του είναι μόνο σαρωμένες εικόνες μπορεί ακόμη να παράγει μηδενικά εγγενή αποτελέσματα.

Κανονική συμπεριφορά αναζήτησης

Ο διακομιστής δοκιμάζει πηγές αναζήτησης με αυτή τη σειρά:

  1. Αποτελέσματα από τον εγγενή προβολέα της μορφής.
  2. Ένα προ-κατασκευασμένο ευρετήριο αναζήτησης .srh.
  3. Σφάλμα/κενό αποτέλεσμα όταν δεν υπάρχει πηγή αναζήτησης.

Το ευρετήριο .srh είναι το αντικείμενο αναζήτησης που δημοσιεύεται μαζί με τις εικόνες σελίδων όταν τα έγγραφα εξυπηρετούνται από κοινόχρηστη αποθήκευση, έτσι ένας κόμβος που δεν έχει ανοίξει ποτέ το έγγραφο μπορεί ακόμη να απαντήσει σε αναζητήσεις — δείτε Διανεμημένες Αναπτύξεις.

CanSearch() μπορεί να είναι αληθές για έναν αναζητήσιμο προβολέα ακόμη και όταν ένα συγκεκριμένο έγγραφο δεν έχει στρώση κειμένου και επομένως δεν επιστρέφει αποτελέσματα.

Άδεια και συμπεριφορά UI

Μια ενεργή άδεια Temporary/Demo παρέχει Αναζήτηση κατά τη διάρκεια της ενεργής περιόδου της. Μια ελλιπής άδεια και το παλιό αρχείο TRIAL δεν παρέχουν δυνατότητα Αναζήτησης. Χωρίς Αναζήτηση:

  • Το ReferenceCss και το ReferenceScripts παραλείπουν τα πακέτα αναζήτησης.
  • Το μεσαίο λογισμικό αρνείται την αναζήτηση αντί να επιστρέφει αποτελέσματα με άδεια.

Οδηγήστε την ορατότητα προσαρμοσμένου UI από το IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) και χρησιμοποιήστε το CanSearch() για το ξεχωριστό αποτέλεσμα μορφής/συνεδρίας.

Επίλυση προβλημάτων

ΣυμπτωμαΈλεγχος
Η γραμμή αναζήτησης λείπειΔυνατότητα αναζήτησης και IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() είναι ψευδέςΠροβολέας μορφής, επιλεγμένη διαδρομή DefaultRender, και κεφαλίδα απάντησης εκκίνησης
Η αναζήτηση επιστρέφει μηδέν για ένα σαρωμένο PDFΤο έγγραφο δεν έχει στρώση κειμένου· χρησιμοποιήστε πηγή που περιέχει κείμενο ή προβολή PDF που διατηρεί το κείμενο
Η αναζήτηση λειτουργεί αλλά οι επισημάνσεις είναι μετατοπισμένεςΔιαδρομή απόδοσης, ανάλυση, μετασχηματισμοί εγγράφου και εξαγόμενα κουτιά λέξεων

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