Interface IMarkupImageParams

Defines the parameters for creating a markup image.

interface IMarkupImageParams {
    height?: number;
    id?: string;
    maxHeight?: number;
    maxWidth?: number;
    position?: { x: number; y: number };
    position2?: { x: number; y: number };
    src?: string;
    width?: number;
}

Properties

height? id? maxHeight? maxWidth? position? position2? src? width?

Properties

Optionalheight

height?: number

Deprecated. Height of the image. The original image is scaled to this height. Specify 0 to set height of the source image. Ignored if position2 is defined.

Default

0

Optionalid

id?: string

Internal markup object identifier.

OptionalmaxHeight

maxHeight?: number

Maximum height of the image. Specify a max height if you want to set the height to the original image but not more than the max.

OptionalmaxWidth

maxWidth?: number

Maximum width of the image. Specify a max width if you want to set the width to the original image but not more than the max.

Optionalposition

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

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

Optionalposition2

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

Screen coordinates of the bottom-right point (position) of the image. Specify 0 to set widt and height of the source image.

Optionalsrc

src?: string

Image source as a base64-encoded Data URL.

Optionalwidth

width?: number

Deprecated. Width of the image. The original image is scaled to this width. Specify 0 to set width of the source image. Ignored if position2 is defined.

Default

0

Settings

Member Visibility

On This Page

Properties