Interface IPolygonMask

Polygon Mask

key option type example notes
enable boolean true / false
draw.enable boolean true / false
draw.lineWidth number 0.5
draw.lineColor color object This color object is the same described here {@link IColor}
position object { "x": 50, "y": 50 } The position specified is not absolute, it will be used as a percent value.
scale number 1
type string none
inside
outside
inline
move.radius number 10
url string demo/svg/deer.svg this file will be downloaded with an ajax request, if it won't load you have some XSS issues
interface IPolygonMask {
    data?: string | IPolygonMaskLocalSvg;
    draw: IPolygonMaskDraw;
    enable: boolean;
    inline: IPolygonMaskInline;
    move: IPolygonMaskMove;
    position?: ICoordinates;
    scale: number;
    type: PolygonMaskType;
    url?: string;
}

Implemented by

Properties

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

Properties

Optional data

data?: string | IPolygonMaskLocalSvg

draw

draw: IPolygonMaskDraw

enable

enable: boolean

inline

inline: IPolygonMaskInline

move

move: IPolygonMaskMove

Optional position

position?: ICoordinates

scale

scale: number

type

type: PolygonMaskType

Optional url

url?: string

Settings

Member Visibility

Theme

On This Page

datadrawenableinlinemovepositionscaletypeurl