LineAnnotationOptions

Syntax

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

Attributes

startPoint

The start point of the line annotation to draw. Please refer to Point.

Default value: {x: 10, y: 10}

endPoint

The end point of the line annotation to draw. Please refer to Point.

Default value: {x: 110, y: 80}

Line Location

lineEnding

The line ending style of the line annotation.

start

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

Default value: Dynamsoft.DDV.EnumLineEnding.NONE

end

Specify the end point style of the line 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)", 

Line BorderStyle

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 line annotation border. The unit is point.

Default value: [0, 0]