Class GcPdfSearcher

Calculates the phrase matches in the given page content based on the specified query and matching options.

Returns

An object containing the matches and their lengths.

Returns

matches - An array of character indices (character indices) on the page where matches were found.

Returns

matchesLength - An array of lengths for each matched text.

Extract all text from pdf document once.

Determine if the search query constitutes a "whole word", by comparing the first/last character type with the preceding/following character type.

Helper for multi-term search that fills the matchesWithLength array and handles cases where one search term includes another search term (for example, "tamed tame" or "this is"). It looks for intersecting terms in the matches and keeps elements with a longer match length.

Render highlight for the current search result.

Cancel search task.

Example

// Open the document, find the text 'wildlife' and highlight the first result:
async function loadPdfViewer(selector) {
     var viewer = new GcPdfViewer(selector, { restoreViewStateOnLoad: false });
     viewer.addDefaultPanels();
     var afterOpenPromise = new Promise((resolve)=>{ viewer.onAfterOpen.register(()=>{ resolve(); }); });
     await viewer.open('wetlands.pdf');
     await afterOpenPromise;
     var findOptions = { Text: 'wildlife' };
     var searchIterator = await viewer.searcher.search(findOptions);
     var searchResult = await searchIterator.next();
  viewer.searcher.cancel();
  viewer.searcher.highlight(searchResult.value);
}
loadPdfViewer('#root');

Highlights a specified portion of text on a given page.

Returns

A promise that resolves to true if the text was successfully highlighted, otherwise false.

Example

// Highlight the text from character 10 to character 20 on the first page with custom highlight colors.
viewer.highlightTextSegment(0, 10, 20, {
    color: 'rgba(173, 216, 230, 0.5)', // semi-transparent light blue
    borderColor: 'blue', // named color for the border
    borderWidth: 4, // custom border width
    clearPrevious: true
});

Retrieves the content of a specific page.

Returns

The content of the specified page.

Retrieves the line endings of the content of a specific page.

Returns

The line endings of the content of the specified page.

Retrieves the text rectangles and styles of a specific page.

Returns

The text rectangles and styles of the specified page.

Navigates to a page containing the result and highlights found text.

Example

// Open the document, find the text 'wildlife' and highlight the first result:
async function loadPdfViewer(selector) {
     var viewer = new GcPdfViewer(selector, { restoreViewStateOnLoad: false });
     viewer.addDefaultPanels();
     var afterOpenPromise = new Promise((resolve)=>{ viewer.onAfterOpen.register(()=>{ resolve(); }); });
     await viewer.open('wetlands.pdf');
     await afterOpenPromise;
     var findOptions = { Text: 'wildlife' };
     var searchIterator = await viewer.searcher.search(findOptions);
     var searchResult = await searchIterator.next();
  viewer.searcher.cancel();
  viewer.searcher.highlight(searchResult.value);
}
loadPdfViewer('#root');

Checks whether a specific search result is currently selected.

Returns

A boolean indicating whether the provided search result is currently selected.

Issues the next search result, primarily used internally by the PDF Searcher.

Returns

A Promise that resolves with the processed search result.

Clear search results. This method must be called when the SearchPanel is closed.

Asynchronously generates search results based on the provided search options.

Example

 // Highlight all search results without opening SearchPanel.
 const searchIterator = viewer.searcher.search({ Text: "test", MatchCase: true, HighlightAll: true });
 searchIterator.next();
 searcher.applyHighlight();

Example

 // Iterate all search results
 const searcher = viewer.searcher;
 var searchResults = [];
 const searchIterator = searcher.search({ Text: textToSearch, MatchCase: true });
 var searchResult = await searchIterator.next();
 if (searchResult.value)
     searcher.highlight(searchResult.value)
 while (searchResult.value && !searchResult.done) {
     const searchResultValue = searchResult.value;
     searchResults.push(`index: ${searchResultValue.ItemIndex}, text: ${searchResultValue.DisplayText}, pageIndex: ${searchResultValue.PageIndex}`);
     searchResult = await searchIterator.next();
 }
 console.log("Search results: " + (searchResults.length ? searchResults.join("; ") : "No search results"));

Example

// Open the document, find the text 'wildlife' and highlight the first result:
async function loadPdfViewer(selector) {
     var viewer = new DsPdfViewer(selector, { restoreViewStateOnLoad: false });
     viewer.addDefaultPanels();
     var afterOpenPromise = new Promise((resolve)=>{ viewer.onAfterOpen.register(()=>{ resolve(); }); });
     await viewer.open('wetlands.pdf');
     await afterOpenPromise;
     var findOptions = { Text: 'wildlife' };
     var searchIterator = await viewer.searcher.search(findOptions);
     var searchResult = await searchIterator.next();
  viewer.searcher.cancel();
  viewer.searcher.highlight(searchResult.value);
}
loadPdfViewer('#root');

Example

// Open the document, find the text 'wildlife' and print search results to the console:

 async function loadPdfViewer(selector) {
     var viewer = new DsPdfViewer(selector);
      viewer.addDefaultPanels();
      await viewer.open('wetlands.pdf');
      await (new Promise((resolve)=>{
          viewer.onAfterOpen.register(()=>{
              resolve();
          });
      }));
      var findOptions = {
          Text: 'wildlife',
          MatchCase: true,
          WholeWord: true,
          StartsWith: false,
          EndsWith: false,
          Wildcards: false,
          Proximity: false,
          SearchBackward: false,
          HighlightAll: true
      };
      var searcher = viewer.searcher;
      var searchIterator = await searcher.search(findOptions);
      var resultsCount = 0;
      var searchResult;
      do {
          searchResult = await searchIterator.next();
          if (searchResult.value) {
              // this could be either result or progress message (ItemIndex < 0)
              if(searchResult.value.ItemIndex >= 0) {
                  console.log('next search result:');
                  console.log(searchResult.value);
                  resultsCount++;
              } else {
                  const pageCount = _doc.pageCount.totalPageCount || _doc.pageCount.renderedSoFar;
                  console.log('search progress, page index is ' + searchResult.value.PageIndex);
              }
          }
          else {
              console.log("Search completed");
              break;
          }
      }
      while(!searchResult.done);
      console.log('Total results count is ' + resultsCount);
 }

Returns

An asynchronous iterable iterator that yields search results.

Toggles the visibility of the Search UI.

Repaint highlight for visible pages.