Skip to main content
Version: Version 5 beta

Interface: AnnotationContextualMenuInterface

Interface for the annotation contextual menu.

Extends

  • EventHandlerInterface<"toggled", EventMap["PdfTools.contextualMenus.annotation.toggled"]>

Properties

addEventListener()

addEventListener: (eventName, callback) => void

Adds an event listener for specified events.

Parameters

eventName: "toggled"

callback

Returns

void

Inherited from

EventHandlerInterface.addEventListener


deleteButton

deleteButton: AnnotationDeleteButtonInterface

Contextual menu actions related to the annotation delete button.


editButton

editButton: AnnotationEditButtonInterface

Contextual menu actions related to the annotation edit button.


emitToggled()

emitToggled: (active, options?) => void

Emits a toggled event for the annotation.

Parameters

active: boolean

Indicates whether the annotation is active or not.

options?: ContextualMenuOptions

The options for the contextual menu.

Returns

void


lockButton

lockButton: AnnotationLockButtonInterface

Contextual menu actions related to the annotation lock button.


removeEventListener()

removeEventListener: (eventName, callback) => void

Removes an event listener for specified events.

Parameters

eventName: "toggled"

callback

Returns

void

Inherited from

EventHandlerInterface.removeEventListener