pivotick - v1.5.0
    Preparing search index...

    Interface Simulation

    interface Simulation {
        applyPhysicsPreset(name: PhysicsPresetName): void;
        changeLayout(
            type: LayoutType,
            simulationOptions?: DeepPartial<SimulationOptions.SimulationOptions>,
        ): Promise<void>;
        disable(): void;
        enable(): void;
        getForceSimulation(): SimulationForces;
        getLayoutType(): LayoutType;
        getPhysicsKnobs(): PhysicsKnobs;
        getSimulation(): Simulation<Node, undefined>;
        isDragging(): boolean;
        isEnabled(): boolean;
        isFitViewOnExpandCollapse(): boolean;
        isFreezeNodesOnDrag(): boolean;
        isGridSnappingEnabled(): boolean;
        pause(): void;
        refreshForcesAndReheat(alpha?: number): void;
        reheat(alpha?: number): void;
        restart(): void;
        setCollisionRadius(knob: number): void;
        setFriction(knob: number): void;
        setLinkDistance(knob: number): void;
        setRepulsion(knob: number): void;
        snapToGrid(value: number): number;
        start(recomputeLayout?: boolean): Promise<void>;
        stop(): void;
        toggleFitViewOnExpandCollapse(): void;
        toggleFreezeNodesOnDrag(): void;
        toggleGridSnapping(): void;
        update(): void;
        waitForSimulationStop(): Promise<void>;
    }
    Index

    Methods

    applyPhysicsPreset changeLayout disable enable getForceSimulation getLayoutType getPhysicsKnobs getSimulation isDragging isEnabled isFitViewOnExpandCollapse isFreezeNodesOnDrag isGridSnappingEnabled pause refreshForcesAndReheat reheat restart setCollisionRadius setFriction setLinkDistance setRepulsion snapToGrid start stop toggleFitViewOnExpandCollapse toggleFreezeNodesOnDrag toggleGridSnapping update waitForSimulationStop

    Methods

    • Re-read the node-dependent force accessors and reheat.

      d3-force caches per-node radius/strength when a force is initialised (i.e. when nodes are set), not on every tick — so mutating a node's radius after the sim is running has no effect until the forces are re-initialised. Re-setting the nodes does that; the reheat then lets collision/charge re-lay-out with the new sizes. Used when a custom node measures its size after the initial layout has already cooled. No-op when disabled.

      Parameters

      • alpha: number = 0.5

      Returns void

    • Restart the simulation with a bit of heat

      Parameters

      • alpha: number = 0.7

      Returns void

    • Restart the simulation with rendering on each animation frame.

      Returns void

    • Node spacing. Knob 4–60 → d3CollideRadiusMultiplier (scales each node's collision radius).

      Parameters

      • knob: number

      Returns void

    • Motion damping. Knob 0–100 → d3VelocityDecay (÷100). Applied live each tick — no reheat.

      Parameters

      • knob: number

      Returns void

    • Preferred edge length. Knob 40–260 (px) → d3LinkDistance.

      Parameters

      • knob: number

      Returns void

    • Push-apart strength. Knob 0–100 → d3ManyBodyStrength.

      Parameters

      • knob: number

      Returns void

    • Snap a graph-space coordinate to the grid when grid-snapping is enabled (a no-op otherwise). Public so non-simulation draggables (e.g. notes) can snap on the same grid as nodes.

      Parameters

      • value: number

      Returns number

    • Start the simulation with rendering on each animation frame.

      Parameters

      • recomputeLayout: boolean = true

      Returns Promise<void>

    • Manually stop the simulation and cancel animation frame.

      Returns void

    • Returns a promise that resolves when the simulation stops naturally. Useful for performing actions (like fitAndCenter) after stabilization.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods