Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ITextSearchQueryOptions

    Options object used with ReaderDocumentSearch.createTextQuery.

    interface ITextSearchQueryOptions {
        ignoreCase?: boolean;
        ignoreDiacritics?: boolean;
        searchResultOptions?: ITextSearchResultOptions;
        whitespaceMode?: TextSearchQueryWhitespaceMode;
    }

    Properties

    ignoreCase?: boolean

    If set to true, character casing is ignored.

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

    true
    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.

    false
    searchResultOptions?: ITextSearchResultOptions

    Options for search result items.

    ITextSearchResultOptions
    whitespaceMode?: TextSearchQueryWhitespaceMode

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

    COLLAPSE
    Properties