Last date modified: 2025-Jul-02

Interface: IHighlightListenerVisibility()

Listener function for the [[ViewHighlights]] visibility event. This event is fired whenever a highlight is shown or hidden.

The arguments to this event listener are as follows:

IHighlightListenerVisibility(highlightSet, visible, refObject?, ...args?): void

Listener function for the [[ViewHighlights]] visibility event. This event is fired whenever a highlight is shown or hidden.

The arguments to this event listener are as follows:

Parameters

highlightSet: HighlightSetMemento

The [[RangeHighlightSet]], [[TermHighlightSet]] or [[AllHighlights]] object

visible: boolean

refObject?: any

The first additional argument that was passed in to [[ViewHighlights.onactive]] or [[ViewHighlights.onactiveonce]]

• ...args?: any[]

Additional arguments that were passed in to [[ViewHighlights.onactive]] or [[ViewHighlights.onactiveonce]]

Returns

void

Return to top of the page
Feedback