weasel API - v0.8.0
    Preparing search index...

    Interface UseSimulationOptions<TNode>

    interface UseSimulationOptions<TNode extends SimulationNode> {
        alpha?: number;
        alphaDecay?: number;
        alphaMin?: number;
        alphaTarget?: number;
        cancelFrame?: (handle: number) => void;
        forces?: SimulationForce<TNode>[];
        nodes: TNode[];
        onEnd?: () => void;
        onTick?: (nodes: TNode[]) => void;
        requestFrame?: (cb: (t: number) => void) => number;
        velocityDecay?: number;
    }

    Type Parameters

    Index

    Properties

    alpha? alphaDecay? alphaMin? alphaTarget? cancelFrame? forces? nodes onEnd? onTick? requestFrame? velocityDecay?

    Properties

    alpha?: number

    Initial alpha. Default 1.

    alphaDecay?: number

    Per-tick decay rate toward alphaTarget. Default 1 - 0.001^(1/300) ≈ 0.0228.

    alphaMin?: number

    Settle threshold. When alpha drops below and alphaTarget is 0, onEnd fires. Default 0.001.

    alphaTarget?: number

    Target alpha. Set above alphaMin to keep sim warm (e.g. during drag). Default 0.

    cancelFrame?: (handle: number) => void
    forces?: SimulationForce<TNode>[]

    Forces applied per tick. Each may implement initialize for setup.

    nodes: TNode[]

    Mutable array of nodes. Kit + forces mutate vx/vy/x/y in place.

    onEnd?: () => void

    Fired once when the sim settles (alpha < alphaMin && alphaTarget === 0).

    onTick?: (nodes: TNode[]) => void

    Fired after each integration step.

    requestFrame?: (cb: (t: number) => void) => number

    Optional rAF injection. Defaults to window.requestAnimationFrame.

    velocityDecay?: number

    Friction multiplier on velocity per tick: vx *= (1 - velocityDecay). Default 0.4.

    Settings

    Member Visibility

    On This Page

    Properties