PolylineAnnotationOptions

Syntax

interface PolylineAnnotationOptions {
    points?: Point[];
    lineEnding?: {
        start?: EnumLineEnding;
        end?: EnumLineEnding;
    };
    borderWidth?: number;
    borderColor?: string;
    background?: string;
    opacity?: number; 
    lineDash?: number[];
    flags?: Flags;
}

Attributes

points

The points of the polyline annotation to draw. Please refer to Point.

Default value: [{x: 10, y: 40}, {x: 50, y: 80}, {x: 110, y: 10}]

Remark

The number of elements in the array must be greater than or equal to two.

lineEnding

The line ending style of the polyline annotation.

start

Specify the start point style of the polyline annotation. Please refer to EnumLineEnding.

Default value: Dynamsoft.DDV.EnumLineEnding.NONE

end

Specify the end point style of the polyline annotation. Please refer to EnumLineEnding.

Default value: Dynamsoft.DDV.EnumLineEnding.NONE

borderWidth

The border width of annotation. The unit is point.

Default value: 1

borderColor

The border color of annotation.

Default value: rgb(0,0,0)

Remark

Supported string value of borderColor and background:

• Named color, for example, red, green, etc.
• HEX(#RRGGBB), for example, #ff0000, #008000, etc.
• RGB(rgb(red, green, blue)), for example, rgb(255, 0, 0), rgb(0, 128, 0), etc.
• HSL(hsl(Hue, Saturation, Lightness)), for example, hsl(0, 100%, 50%), hsl(120, 100%, 25%) ,etc.

background

The backgroud style of annotation.

Default value: '', it means no fill.

Example

background: "rgb(255,255,255)", 

Remark

Supported string value of borderColor and background:

• Named color, for example, red, green, etc.
• HEX(#RRGGBB), for example, #ff0000, #008000, etc.
• RGB(rgb(red, green, blue)), for example, rgb(255, 0, 0), rgb(0, 128, 0), etc.
• HSL(hsl(Hue, Saturation, Lightness)), for example, hsl(0, 100%, 50%), hsl(120, 100%, 25%) ,etc.

If set to '', it means no fill.

opacity

The opacity of the whole annotation. The value range is [0,1], value which is greater than 1 will default to 1.

Default value: 1

lineDash

The style of polyline annotation border. The unit is point.

Default value: [0, 0]

Example

lineDash: [10, 10], 

flags

The flags of annotation.

Please refer to Flags.

Related

• Polyline()
• getOptions() under Polyline class
• updateOptions() under Polyline class