HighlightResultOption
algoliasearch.search.HighlightResultOption
case class HighlightResultOption(value: String, matchLevel: MatchLevel, matchedWords: Seq[String], fullyHighlighted: Option[Boolean]) extends HighlightResultTrait
Surround words that match the query with HTML tags for highlighting.
Value parameters
- fullyHighlighted
-
Whether the entire attribute value is highlighted.
- matchedWords
-
List of matched words from the search query.
- value
-
Highlighted attribute value, including HTML tags.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait HighlightResultTraittrait HighlightResultclass Objecttrait Matchableclass Any
Members list
In this article