Home > @jsplumbtoolkit/browser-ui-anim > OverlayAnimationOptions
OverlayAnimationOptions interface
Options for animating an overlay along an edge
Signature:
export interface OverlayAnimationOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| dwell? | number | (Optional) How long, in milliseconds, to dwell on the source before beginning to move. Defaults to 350ms. | |
| events? | Record<string, (p: AnimationEventCallbackParams) => any> | (Optional) Optional set of event listeners. | |
| forwards? | boolean | (Optional) Defaults to true, meaning traverse from the source to the target. | |
| paused? | boolean | (Optional) If true, the animation starts in a paused state. | |
| rate? | number | (Optional) Time between frames. Defaults to 30ms. | |
| speed? | number | (Optional) How fast to travel, in pixels per second. Defaults to 100. |