Skip to content

Interface: SankeyTraceLinkFlow ​

Flow particles (a Holochart extension): dots streaming along every link from its source to its target, spread across its width, as many as its size and density call for. Off unless link.flow is set (flow: {} turns them on). They dim with links outside a hover highlight, and hold still under prefers-reduced-motion: reduce.

Properties ​

PropertyTypeDefault valueDescription
color?PerPointColorundefinedParticle color, or one per link. Default: the link color, opaque.
density?PerPointNumber2Particles per 100 px of link length for every 10 px of link width (thinner links get one lane), or one density per link; 0 draws none. Minimum: 0
opacity?number1Particle opacity. Range: 0 – 1
size?PerPointNumber3Particle diameter in CSS px, or one per link. Minimum: 0
speed?PerPointNumber50Particle speed along the link in CSS px per second, or one per link; 0 holds the particles still. Minimum: 0
time?numberundefinedFreeze the particles where they are this many seconds into the animation: a still frame, e.g. for image export and visual tests. Default: the particles move.

Released under the MIT License.