Support Menu

Interface IHighlight

An highlight structure, as returned by the index. This structure can be used to do the actual highlighting job.

Index

Properties

Optional dataHighlightGroup

dataHighlightGroup: number

The group number for the highlight. A single string can have the same term highlighted multiple times. This allows to regroup the different highlights.

Optional dataHighlightGroupTerm

dataHighlightGroupTerm: string

The string that represent the highlight. A single string can have the same term highlighted multiple times. This allows to regroup the different highlights.

length

length: number

The length of the offset.

offset

offset: number

The 0 based offset inside the string where the highlight should start.

Hierarchy

  • IHighlight