Interface IMarkupRectangleParams

Defines the parameters for creating a markup rectangle.

interface IMarkupRectangleParams {
    color?: string;
    height?: number;
    id?: string;
    lineWidth?: number;
    position?: { x: number; y: number };
    position2?: { x: number; y: number };
    width?: number;
}

Properties

color? height? id? lineWidth? position? position2? width?

Properties

Optionalcolor

color?: string

Line color as a string in hexadecimal color syntax #RGB color using its primary color components (red, green, blue) written as hexadecimal numbers.

Default

"#ff0000"

Optionalheight

height?: number

Height of the rectangle. Ignored if position2 is defined.

Default

200

Optionalid

id?: string

Internal markup object identifier.

OptionallineWidth

lineWidth?: number

Line width.

Default

4

Optionalposition

position?: { x: number; y: number }

Screen coordinates of the top-left point (position) of the rectangle.

Optionalposition2

position2?: { x: number; y: number }

Screen coordinates of the bottom-right point (position) of the rectangle.

Optionalwidth

width?: number

Width of the rectangle. Ignored if position2 is defined.

Default

200

Settings

Member Visibility

On This Page

Properties