Javascript API
interfaces
Followeffect

Interface: FollowEffect

Hierarchy

Properties

constraint

constraint: "none" | "x-axis" | "y-axis"

Default

'none'

enabled

enabled: boolean

Whether following is enabled.

Default

true

id

Readonly id: number

Every Effect is assigned a unique numerical id that cannot be changed.

Inherited from

Effect.id


limitDistance

limitDistance: boolean

Whether to limit following to within a certain distance.

Default

false

maxDistance

maxDistance: number

The distance beyond which to stop following the target.

Default

1000

offset

offset: number

The offset.

Default

0

speed

speed: number

How quickly the target is reached. A larger value will reach the target faster.

Default

100

speedLimit

speedLimit: number

The maximum speed to follow in pixels per second.

Default

1000

target

target: string

target object

Default

'none'