Class: SearchResult

PSPDFKit.SearchResult

A match when searching the PDF.

You can retrieve search results by using PSPDFKit.Instance#search

Extends

  • Immutable.Record

Members




Members

lengthInPreview: number

Length of the search term in the preview text.

Type:
  • number

locationInPreview: number

Location of the search term in the preview text.

Type:
  • number

pageIndex: number

The page where the result was found.

Type:
  • number

previewText: string

The text surrounding the search term that can be used to list a preview.

Type:
  • string

rectsOnPage: PSPDFKit.Immutable.Rect.<PSPDFKit.Geometry.Rect>

All rects on the page that should be used to highlight the text.

Type: