Skip to main content
Version: Version 5 beta

Interface: ShapeAnnotationInterface

Interface for the shape annotation popover.

Extends

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

Properties

addEventListener()

addEventListener: (eventName, callback) => void

Adds an event listener for specified events.

Parameters

eventName: "toggled"

callback

Returns

void

Inherited from

EventHandlerInterface.addEventListener


cloudShapeButton

cloudShapeButton: ShapeAnnotationCloudShapeButtonInterface

Contextual menu actions related to the cloud shape button.


deleteButton

deleteButton: ShapeAnnotationDeleteButtonInterface

Delete button interface for the shape annotation popover.


emitToggled()

emitToggled: (active, annotation?) => void

Emits a toggled event for the shape annotation.

Parameters

active: boolean

Indicates whether the annotation is active or not.

annotation?: Annotation

The shape annotation to toggle.

Returns

void


fillColorPickerButton

fillColorPickerButton: ShapeAnnotationFillColorPickerButtonInterface

Contextual menu actions related to the fill color picker button.


lineColorPickerButton

lineColorPickerButton: ShapeAnnotationLineColorPickerButtonInterface

Contextual menu actions related to the line color picker button.


lineStyleButton

lineStyleButton: ShapeAnnotationLineStyleButtonInterface

Contextual menu actions related to the line style button.


lockButton

lockButton: ShapeAnnotationLockButtonInterface

Lock button interface for the shape annotation popover.


removeEventListener()

removeEventListener: (eventName, callback) => void

Removes an event listener for specified events.

Parameters

eventName: "toggled"

callback

Returns

void

Inherited from

EventHandlerInterface.removeEventListener