Highlight class

The Atlas Search highlight option adds fields to the result set that display search terms in their original context. You can use it in conjunction with all $search operators to display search terms as they appear in the returned documents, along with the adjacent text content (if any). highlight results are returned as part of the $meta field.

Example

Expected result:

"highlight": {
   "path": ["description", "summary" ]
 }

Expected result:

 "highlight": {
   "path": "description",
   "maxNumPassages": 1,
   "maxCharsToExamine": 40
 }

https://www.mongodb.com/docs/atlas/atlas-search/highlighting

Inheritance

• Object
• ExpressionContent
• Expression<ExpressionContent>
• OperatorExpression<ExpressionContent>
• Highlight

Constructors

Highlight({required dynamic path, int? maxCharsToExamine, int? maxNumPassages})

path - Document field to search. The path field may contain:

Properties

content → ExpressionContent

no setter, inherited

entry ↔ MapEntry<String, ExpressionContent>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

key → String

no setter, inherited

operator → String

no setter, inherited

rawContent → dynamic

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build() → MongoDocument

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited