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

annotationRect: PSPDFKit.Geometry.Rect

The bounding box of the annotation in which the result was found. This property is only available when the result is an annotation.

Type:

isAnnotations: boolean

Boolean to indicate whether the matching search result is part of an annotation.

Type:
  • boolean

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

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

Type: