ITextSearchQueryOptions | Colibrio Reader Framework API

Options object used with ReaderDocumentSearch.createTextQuery.

Hierarchy

ITextSearchQueryOptions

Index

Properties

Optional ignoreCase

ignoreCase?: boolean

If set to true, character casing is ignored.

For example the query "paris" will match the text "Paris".

default: true

Optional ignoreDiacritics

ignoreDiacritics?: boolean

If set to true, the query will match text while ignoring diacritics.

The publication text and the search query will both be normalized using the unicode Normalization Form KD and then diacritics will be removed using the "Nonspacing Mark" unicode category before searching for matches.

For example, searching for "hèllo" in a publication with the text "hëllô, hellò" will find two matches if the option is set to true.

default: false

Optional searchResultOptions

searchResultOptions?: ITextSearchResultOptions

Options for search result items.

default: ITextSearchResultOptions

Optional whitespaceMode

whitespaceMode?: TextSearchQueryWhitespaceMode

Controls how whitespace should be treated in the source content. See TextSearchQueryWhitespaceMode for a description of each mode.

default: COLLAPSE