Skip to main content
Skip table of contents

SearchResults

Methods

Name

Type

Description

$searchResults.cqlError

String

The CQL error message if there was an error in the used CQL query.

$searchResults.enableHighlights(enabled)

n/a

Enable or disable highlighting of search results. Call this before rendering the results. Has no effect when using CQL search.

  • Parameter: enabled

  • Type: boolean 

  • Description: True if the highlighting should be enabled, otherwise false.

$searchResults.items

List<SearchResult >

A list of the search results.

$searchResults.maxResultsPerPage

long

The maximum number of results per page (useful for pagination).

$searchResults.searchWords

List<String>

The search words from the query string that were actually used in the search (raw query string with the stop words removed). May be an empty list if there were none or if CQL search was used.

$searchResults.startIndex

long

The starting index (useful for pagination).

$searchResults.total

long

The total search results (useful for pagination).


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.