Annotate plugin
Use the Annotate plugin to draw and add shapes in the image context.
This means that if the image is flipped or rotated the annotations are flipped and rotated along with the image. Annotations cannot be drawn outside of the image bounds.
Use the Decorate plugin to draw and add shapes to the crop context, these shapes aren't bound to the image and will always render on top of annotations.
When both plugins are used at the same time, annotations are drawn first and decorations are layered on top.
Property | Default value | Description |
---|---|---|
annotateTools |
|
Markup editor toolbar to show in the annotate view. |
annotateToolShapes |
|
Markup editor tool styles to use. |
annotateActiveTool |
|
Which tool to select in the toolbar. |
annotateEnableButtonFlipVertical |
|
Enable the vertical flip button in the Markup Editor bar. |
annotateEnableDropImagePreset |
|
Set to false to prevent dropping images on the canvas.
|
annotateEnableSelectImagePreset |
|
Set to true to show the image browse button.
|
annotateShapeControls |
|
Style controls available to change shape appearance. |
annotatePresets |
|
An array of annotation presets ("stickers") to render in the presets tool tab. See stickers for more information. |
annotateGridSize |
|
The size of the grid cells in the annotate util. |
annotateSnapToContext |
|
Should we snap to context in the annotate util. |
annotateWillRenderShapePresetToolbar |
|
Set to a function that receives the node tree for the preset toolbar. Should synchronously return the node tree. See willRenderShapePresetToolbar for details.
|
annotateWillRenderShapeStyleControls |
|
Set to a function that receives the shape controls node tree. Should synchronously return the node tree. |
Annotate plugin exports
The core editor module exports the following Annotate plugin objects.
Export | Description |
---|---|
plugin_annotate |
The annotate util view. |
plugin_annotate_locale_en_gb |
The annotate util locales. |