Skip to main content

Interface: AnnotationCommands

Defined in: widgets/annotation/annotationSupport.tsx:27

Events for AnnotationSupport event bus.

See

Properties

PropertyModifierTypeDescription

createAnnotation

public

object

Can be triggered to create a new annotation for specified targets.

createAnnotation.content?

readonly

AnnotationContent

Initial annotation content.

createAnnotation.position?

readonly

Vector

Initial annotation element position.

createAnnotation.targets

readonly

readonly Element[]

Target diagram elements to link created annotation to.

findCapabilities

public

object

Triggered on a request to query implementations for its capabilities.

findCapabilities.capabilities

readonly

Record<string, never>[]

Collects found annotation support capabilities.

renameLink

public

object

Can be triggered to open dialog to rename a link.

This action is always available even when AnnotationSupport is not provided.

renameLink.target

readonly

Link

Target link to rename (change its label).

startDragOperation

public

object

Can be triggered to start drag operaton on an annotation link.

startDragOperation.operation

readonly

DragLinkOperation

Drag link operation to initiate.