Last date modified: 2025-Jul-02
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.
IHighlightSetListenerAdd(
highlightSet,highlights,refObject?, ...args?):void
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
• highlightSet: HighlightSetMemento
• highlights: HighlightMemento[]
• refObject?: any
• ...args?: any[]
Returns
void
On this page