Interface: IHighlightViewer

Persistent Highlight API for IViewerCardInstances

Extends

• IEventEmitter<ViewerHighlightEventType>

Extended by

• IProductionViewer

Properties

highlights

readonlyhighlights: IViewerHighlightManager

Gets the Persistent Highlights Manager object

---

shouldHighlight

readonlyshouldHighlight: boolean

Whether highlights should be applied to the currently loaded document

Methods

off()

off(eventType, handler?, once?): void

Unregisters an event handler

Parameters

• eventType: ViewerHighlightEventType

Event to unregister from

• handler?: EventHandler

Event handler function. If not passed in, it removes all event handlers.

• once?: boolean

Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

Returns

void

Inherited from

IEventEmitter.off

---

on()

on(eventType, handler): void

Registers an event handler

Parameters

• eventType: ViewerHighlightEventType

Event to listen for

• handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.on

---

once()

once(eventType, handler): void

Registers an event handler that is only run once

Parameters

• eventType: ViewerHighlightEventType

Event to listen for

• handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.once