Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHighlightSetListenerAdd

Listener function for the [[RangeHighlightSet]], [[TermHighlightSet]] and [[AllHighlights]] add events. This event is fired when one or more new highlights have been added to the set.

The arguments to this event listener are as follows:

  • highlightSet: The [[RangeHighlightSet]], [[TermHighlightSet]] or [[AllHighlights]] object
  • highlights: An array of affected Highlight objects
  • Additional arguments that were passed in to onadd or onaddonce.

Hierarchy

  • IHighlightSetListenerAdd

Callable

  • Listener function for the [[RangeHighlightSet]], [[TermHighlightSet]] and [[AllHighlights]] add events. This event is fired when one or more new highlights have been added to the set.

    The arguments to this event listener are as follows:

    • highlightSet: The [[RangeHighlightSet]], [[TermHighlightSet]] or [[AllHighlights]] object
    • highlights: An array of affected Highlight objects
    • Additional arguments that were passed in to onadd or onaddonce.

    Parameters

    Returns void