Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a search result item containing a search match.

Hierarchy

  • ISearchResultItem

Implemented by

Index

Properties

Optional Readonly contentBlocks

contentBlocks?: IContentBlock[]

The content blocks related to the matchingText.

Readonly contentLocation

contentLocation: IContentLocation

The ContentLocation pointing to the matching text in the publication.

Readonly matchingText

matchingText: string

The matching text as found in the ReaderDocument.

Readonly readerDocumentIndexInSpine

readerDocumentIndexInSpine: number

The index of the ReaderDocument in the ReaderPublication spine where the match was found.

Readonly textAfter

textAfter: string

The text in the ReaderDocument just after the matching text. To configure this field, see ITextSearchResultOptions.numberOfCharactersAfter.

Readonly textBefore

textBefore: string

The text in the ReaderDocument just before the matching text. To configure this field, see ITextSearchResultOptions.numberOfCharactersBefore.

Methods

toJSON

Generated using TypeDoc