An object describing how the marker highlight should be represented in the view.
Each text node contained in a highlighted range will be wrapped in a <span>
view attribute element with CSS class(es), attributes and a priority
described by this object.
Additionally, each container element can handle displaying the highlight
separately by providing the addHighlight
and removeHighlight
custom properties. In this case:
- The
HighlightDescriptor
object is passed to the addHighlight
function upon conversion and should be used to apply the highlight to
the element.
- The descriptor
id
is passed to the removeHighlight
function upon conversion and should be used to remove the highlight with the
given ID from the element.