Last date modified: 2025-Jul-02

Interface: IHighlightSetListenerMove()

Listener function for the [[HighlightSetMemento]] move events. This event is fired when a highlight's range changes.

The arguments to this event listener are as follows:

  • highlightSet: The [[HighlightSetMemento]] object
  • highlight: The affected [[HighlightMemento]] object
  • oldRange: The previous range for the highlight, before it was moved
  • Additional arguments that were passed in to onmove or onmoveonce.

For now, we need to expose the raw range object to maintain backwards compatibility and not break existing callers of this method. In the future, this will be downgraded to a memento object

IHighlightSetListenerMove(highlightSet, highlight, oldRange, refObject?, ...args?): void

Listener function for the [[HighlightSetMemento]] move events. This event is fired when a highlight's range changes.

The arguments to this event listener are as follows:

  • highlightSet: The [[HighlightSetMemento]] object
  • highlight: The affected [[HighlightMemento]] object
  • oldRange: The previous range for the highlight, before it was moved
  • Additional arguments that were passed in to onmove or onmoveonce.

For now, we need to expose the raw range object to maintain backwards compatibility and not break existing callers of this method. In the future, this will be downgraded to a memento object

Parameters

highlightSet: HighlightSetMemento

highlight: HighlightMemento

oldRange: TextRange | CellRange | RectRange | TimeRange

refObject?: any

• ...args?: any[]

Returns

void

Return to top of the page
Feedback