Skip to content

Options

The plugin supports the following configuration options:

PropertyDescriptionTypeDefaultVersion
freeTextEnable or disable the Free Text tool. When using FreeTextOption, you can customize the icon, font colors, and font sizes.boolean | FreeTextOptiontrue1.0.0
highlightEnable or disable the Highlight tool. When using HighlightOption, you can customize the icon and colors.boolean | HighlightOptiontrue1.0.0
imageEnable or disable the Image tool. When using ImageOption, you can customize the icon.boolean | ImageOptiontrue1.0.0
onAnnotationCreatedTriggered when a new annotation is created. Receives the created annotation data as an argument.AnnotationCallbackundefined1.2.0
onAnnotationUpdatedTriggered when an existing annotation is modified, such as when its position, size, or content changes.AnnotationCallbackundefined1.2.0
onAnnotationDeletedTriggered when an annotation is removed from the document. Receives the deleted annotation data as an argument.AnnotationCallbackundefined1.2.0

Custom Components

We are currently designing on how to make the components customizable easily. If you're looking to create a custom Annotation component, please submit a feature request via Support and Feedback section