Class SearchResultItem

Represents a search result item containing a search match.

Implements

ISearchResultItem

Constructors

constructor

new SearchResultItem(_def: ISearchResultItemDef): SearchResultItem
Parameters
- _def: ISearchResultItemDef
Returns SearchResultItem

Properties

`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

toJSON(): ISearchResultItemData
Get this object as a plain JSON object.

Returns ISearchResultItemData
Implementation of ISearchResultItem.toJSON

Class SearchResultItem

Implements

Constructors

constructor

Parameters

Returns SearchResultItem

Properties

ReadonlycontentBlocks

ReadonlycontentLocation

ReadonlymatchingText

ReadonlyreaderDocumentIndexInSpine

ReadonlytextAfter

ReadonlytextBefore