Class PolygonMask

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

Implements

Index

Constructors

Properties

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

Methods

Constructors

constructor

new PolygonMask(): PolygonMask
Returns PolygonMask
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/Options/Classes/PolygonMask.ts:29

Properties

`Optional` data

data?: string | PolygonMaskLocalSvg

draw

draw: PolygonMaskDraw

enable

enable: boolean

inline

inline: PolygonMaskInline

move

move: PolygonMaskMove

`Optional` position

position?: ICoordinates

scale

scale: number

type

type: PolygonMaskType

`Optional` url

url?: string

Methods

load

load(data?): void
Parameters
- Optional data: RecursivePartial<IPolygonMask>
Returns void
Implementation of IOptionLoader.load
- Defined in docs-gen/tmp/tsparticles/plugins/polygonMask/src/Options/Classes/PolygonMask.ts:38