Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISearchResultItemData

Represents a search result item containing a search match.

Hierarchy

  • ISearchResultItemData

Index

Properties

Properties

Optional contentBlocks

contentBlocks?: IContentBlockData[]

The content blocks related to the matchingText.

nativeignore

locator

locator: ISimpleLocatorData

The locator pointing to the matching text in the publication.

matchingText

matchingText: string

The matching text as found in the ReaderDocument.

readerDocumentIndexInSpine

readerDocumentIndexInSpine: number

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

int

textAfter

textAfter: string

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

textBefore

textBefore: string

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

Generated using TypeDoc