Skip to main content
Version: Version 5 beta

Interface: DocumentAnnotationsInterface

Interface for annotation event handling.

Extends

  • EventHandlerInterface<"added" | "updated" | "deleted", EventMap[AnnotationEvents]>

Properties

addEventListener()

addEventListener: (eventName, callback) => void

Adds an event listener for specified events.

Parameters

eventName: "updated" | "added" | "deleted"

callback: (annotation) => void | (annotation) => void | (annotation) => void

Returns

void

Inherited from

EventHandlerInterface.addEventListener


emitAdded()

emitAdded: (annotation) => void

Triggers an event indicating that an annotation was added.

Parameters

annotation: Annotation

Returns

void


emitDeleted()

emitDeleted: (annotation) => void

Triggers an event indicating that an annotation was deleted.

Parameters

annotation: Annotation

Returns

void


emitUpdated()

emitUpdated: (annotation) => void

Triggers an event indicating that an annotation was updated.

Parameters

annotation: Annotation

Returns

void


removeEventListener()

removeEventListener: (eventName, callback) => void

Removes an event listener for specified events.

Parameters

eventName: "updated" | "added" | "deleted"

callback: (annotation) => void | (annotation) => void | (annotation) => void

Returns

void

Inherited from

EventHandlerInterface.removeEventListener