Interface IPolygonMask

[[include:Options/Plugins/PolygonMask.md]]

interface IPolygonMask {
    data?: string | IPolygonMaskLocalSvg;
    draw: IPolygonMaskDraw;
    enable: boolean;
    inline: IPolygonMaskInline;
    move: IPolygonMaskMove;
    position?: ICoordinates;
    scale: number;
    type: PolygonMaskType;
    url?: string;
}

Implemented by

PolygonMask

Index

Properties

data? draw enable inline move position? scale type url?

Properties

`Optional`data

data?: string | IPolygonMaskLocalSvg

The polygon mask SVG data

draw

draw: IPolygonMaskDraw

The polygon mask draw options

enable

enable: boolean

Enables the polygon mask

inline

inline: IPolygonMaskInline

The polygon mask inline options

move

move: IPolygonMaskMove

The polygon mask move options

`Optional`position

position?: ICoordinates

The polygon mask position

scale

scale: number

The polygon mask scale

type

type: PolygonMaskType

The polygon mask type

`Optional`url

url?: string

The polygon mask SVG url