InkAnnotationOptions

Syntax

interface InkAnnotationOptions {
    points?: Point[][];
    borderWidth?: number;
    borderColor?: string;
    opacity?: number;
    flags?: Flags;
    rotation?: number;
}

points

The points of the ink annotation to draw. An ink annotation can include multiple strokes. Please refer to Point.

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

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:

• 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.

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

flags

The flags of annotation.

Please refer to Flags.

rotation

The rotation angle of annotation.

Default value: 0

Remark

• Positive value means clockwise rotation, negative value means counterclockwise rotation.

Related

• Ink()
• getOptions() under Ink class
• updateOptions() under Ink class