Skip to main content

Home > @jsplumbtoolkit/browser-ui-anim > SurfaceAnimator > tracePath

SurfaceAnimator.tracePath() method#

Traces an overlay along a path.

Signature:

tracePath(params: {        path?: Path;        source?: Vertex | string;        target: Vertex | string;        options?: OverlayAnimationOptions;        overlay: OverlaySpec;        paused?: boolean;        listener?: PathTransportListener;    }): PathTransport;

Parameters#

ParameterTypeDescription
params{ path?: Path; source?: Vertex | string; target: Vertex | string; options?: OverlayAnimationOptions; overlay: OverlaySpec; paused?: boolean; listener?: PathTransportListener; }Path tracing options

Returns:

PathTransport