Interface: ITransientHighlightManagerEventApi

Remarks

Partial ITransientHighlightManager interface that defineds the event handler API methods

Methods

offadd()

offadd(setId, addCallback, refObject?): void

Unregister previously registered onadd listener from set with given ID

Parameters

• setId: string

ID of the set to register event against

• addCallback: IHighlightSetListenerAdd

Event listener to unregister

• refObject?: any

Returns

void

---

offclick()

offclick(clickCallback, refObject?): void

Unregister previously registered onHighlightActiveChange listener.

Parameters

• clickCallback: IHighlightListenerClick

Event listener to unregister

• refObject?: any

Returns

void

---

offdone()

offdone(setId, doneCallback, refObject?): void

Unregister previously registered ondonelistener from set with given ID

Parameters

• setId: string

ID of the set to register event against

• doneCallback: IHighlightSetListenerDone

Event listener to unregister

• refObject?: any

Returns

void

---

offHighlightActiveChange()

offHighlightActiveChange(activeChangeCallback, refObject?): void

Unregister previously registered onHighlightActiveChange listener.

Parameters

• activeChangeCallback: IHighlightListenerActive

Event listener to unregister

• refObject?: any

Returns

void

---

offHighlightVisibilityChange()

offHighlightVisibilityChange(visibilityChangeCallback, refObject?): void

Parameters

• visibilityChangeCallback: IHighlightListenerVisibility

• refObject?: any

Returns

void

---

offmove()

offmove(setId, moveCallback, refObject?): void

Unregister previously registered onmove listener from set with given ID

Parameters

• setId: string

ID of the set to register event against

• moveCallback: IHighlightSetListenerMove

Event listener to unregister

• refObject?: any

Returns

void

---

offremove()

offremove(setId, moveCallback, refObject?): void

Unregister previously registered onremove listener from set with given ID

Parameters

• setId: string

ID of the set to register event against

• moveCallback: IHighlightSetListenerRemove

Event listener to unregister

• refObject?: any

Returns

void

---

onadd()

onadd(setId, addCallback, refObject?): void

Register an event listener that will be called when a highlight is added to the set with the given ID

Parameters

• setId: string

ID of the set to register event against

• addCallback: IHighlightSetListenerAdd

Event listener to register

• refObject?: any

Returns

void

---

onclick()

onclick(clickCallback, setIds?, refObject?): void

Register an event listener that will be called when a highlight is clicked

Parameters

• clickCallback: IHighlightListenerClick

Event listener to register

• setIds?: string[]

reference to highlight set IDs that should be monitored. Callback is called on every change, so this will simply filter highlights not in a referenced set

• refObject?: any

Returns

void

---

ondone()

ondone(setId, doneCallback, refObject?): void

Register an event listener that will be called when a highlightset is done scanning the document

Parameters

• setId: string

ID of the set to register event against

• doneCallback: IHighlightSetListenerDone

Event listener to register

• refObject?: any

Returns

void

---

onHighlightActiveChange()

onHighlightActiveChange(activeChangeCallback, setIds?, refObject?): void

Register an event listener that will be called when a highlights active state changes

Parameters

• activeChangeCallback: IHighlightListenerActive

Event listener to register

• setIds?: string[]

reference to highlight set IDs that should be monitored. Callback is called on every change, this will simply filter highlights not in a referenced set

• refObject?: any

Returns

void

---

onHighlightVisibilityChange()

onHighlightVisibilityChange(visibilityChangeCallback, setIds?, refObject?): void

Parameters

• visibilityChangeCallback: IHighlightListenerVisibility

• setIds?: string[]

• refObject?: any

Returns

void

---

onmove()

onmove(setId, moveCallback, refObject?): void

Register an event listener that will be called when a highlight in the set with the given ID is moved

Parameters

• setId: string

ID of the set to register event against

• moveCallback: IHighlightSetListenerMove

Event listener to register

• refObject?: any

Returns

void

---

onremove()

onremove(setId, moveCallback, refObject?): void

Register an event listener that will be called when a highlight is removed from the set with the given ID

Parameters

• setId: string

ID of the set to register event against

• moveCallback: IHighlightSetListenerRemove

Event listener to register

• refObject?: any

Returns

void