Interface ISearchResultItem

Represents a search result item containing a search match.

interface ISearchResultItem {
    contentBlocks?: IContentBlock[];
    contentLocation: IContentLocation;
    matchingText: string;
    readerDocumentIndexInSpine: number;
    textAfter: string;
    textBefore: string;
    toJSON(): ISearchResultItemData;
}

Properties

contentBlocks?: IContentBlock[]

The content blocks related to the matchingText.

contentLocation: IContentLocation

The ContentLocation pointing to the matching text in the publication.

matchingText: string

The matching text as found in the ReaderDocument.

readerDocumentIndexInSpine: number

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

textAfter: string

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

textBefore: string

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

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

Returns ISearchResultItemData