Last date modified: 2025-Jul-02

Interface: IHighlightListenerActive()

Listener function for the [[ViewHighlights]] active event. This event is fired whenever a highlight is activated or deactivated.

The arguments to this event listener are as follows:

IHighlightListenerActive(highlights, refObject?, ...args?): void

Listener function for the [[ViewHighlights]] active event. This event is fired whenever a highlight is activated or deactivated.

The arguments to this event listener are as follows:

Parameters

highlights: HighlightMemento[]

The current list of active highlights

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