Skip to main content
Version: Version 5 beta

Interface: LineAnnotationInterface

Interface for the line annotation popover.

Extends​

  • EventHandlerInterface<"toggled", EventMap["PdfTools.popovers.lineAnnotation.toggled"]>

Properties​

addEventListener()​

addEventListener: (eventName, callback) => void

Adds an event listener for specified events.

Parameters​

• eventName: "toggled"

• callback

Returns​

void

Inherited from​

EventHandlerInterface.addEventListener

colorPickerButton​

colorPickerButton: LineAnnotationColorPickerButtonInterface

Contextual menu actions related to the color picker button.

deleteButton​

deleteButton: LineAnnotationDeleteButtonInterface

Delete button interface for the line annotation popover.

emitToggled()​

emitToggled: (active, annotation?) => void

Emits a toggled event for the line annotation.

Parameters​

• active: boolean

Indicates whether the annotation is active or not.

• annotation?: LineAnnotation

The line annotation to toggle (optional, for edit mode).

Returns​

void

lineEndingButton​

lineEndingButton: LineAnnotationLineEndingButtonInterface

Contextual menu actions related to the line ending button.

lineStyleButton​

lineStyleButton: LineAnnotationLineStyleButtonInterface

Contextual menu actions related to the line style button.

lockButton​

lockButton: LineAnnotationLockButtonInterface

Lock button interface for the line annotation popover.

removeEventListener()​

removeEventListener: (eventName, callback) => void

Removes an event listener for specified events.

Parameters​

• eventName: "toggled"

• callback

Returns​

void

Inherited from​

EventHandlerInterface.removeEventListener

switchLineEndingsButton​

switchLineEndingsButton: LineAnnotationSwitchLineEndingsButtonInterface

Contextual menu actions related to the switch line endings button.