×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

SearchResults

Thomas Walker

Thomas Walker Last update: Aug 7, 2017

Methods

Name Type Description
$searchResults.enableHighlights(enabled) n/a

Enable or disable highlighting of search results. Call this before rendering the results.

Parameter Type Description
enabled boolean 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.

$searchResults.startIndex long

The starting index (useful for pagination).

$searchResults.total long

The total search results (useful for pagination).

2x2.9
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok