Resource Base
Table of contents

AnnotationConfig

Syntax

interface AnnotationConfig {
    toolbarConfig?: ToolbarConfig;
    paletteConfig?: PaletteConfig;
    annotationSelectionStyle?: AnnotationSelectionStyle;
    inkCreateDelay?: number; 
    showOnTopWhenSelected?: boolean; 
    enableContinuousDrawing?: boolean;
    defaultStyleConfig?: {
        rectangle?: RectangleStyle;
        ellipse?: EllipseStyle;
        polygon?: PolygonStyle;
        polyline?: PolylineStyle;
        line?: LineStyle;
        ink?: InkStyle;
        textBox?: TextBoxStyle;
        textTypewriter?: TextTypewriterStyle;
        stamp?: StampStyle;
    };
}

Attributes

toolbarConfig

The configurations of floating toolbar for annotation, please refer to ToolbarConfig.

paletteConfig

The configurations of floating palette for annotation, please refer to PaletteConfig.

annotationSelectionStyle

The style of annotation selection, please refer to AnnotationSelectionStyle.

inkCreateDelay

Specify the ink creation delay. The delay allows users to create the annotation with multiple strokes. Unit is millisecond.

Default value: 1000

annotationsAdded event will be triggered delay.

Only works for the built-in UI.

showOnTopWhenSelected

Whether to show the annotation(s) on top layer when it is selected.

Default value: false

enableContinuousDrawing

Whether to continue drawing the annotation. This is invalid for the ‘ink’ type.

Default value: false

defaultStyleConfig

The initial style configurations for each type of annotation, please refer to RectangleStyle EllipseStyle PolygonStyle PolylineStyle LineStyle InkStyle TextBoxStyle TextTypewriterStyle StampStyle

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version(2.0)
    • Version 1.x
      • Version 1.1
    Change +