Interface Simulation

interface Simulation {
    changeLayout(
        type: LayoutType,
        simulationOptions?: DeepPartial<SimulationOptions.SimulationOptions>,
    ): Promise<void>;
    getForceSimulation(): SimulationForces;
    getSimulation(): Simulation<Node, undefined>;
    isDragging(): boolean;
    pause(): void;
    reheat(alpha?: number): void;
    restart(): void;
    start(): Promise<void>;
    stop(): void;
    update(): void;
    waitForSimulationStop(): Promise<void>;
}

Index

Methods

changeLayout getForceSimulation getSimulation isDragging pause reheat restart start stop update waitForSimulationStop

Methods

changeLayout

changeLayout(
type: LayoutType,
simulationOptions?: DeepPartial<SimulationOptions.SimulationOptions>,
): Promise<void>
Allows to change the layout of the graph
Parameters
- type: LayoutType
- simulationOptions: DeepPartial<SimulationOptions.SimulationOptions> = {}
Returns Promise<void>
Example
```
changeLayout('tree', {
    layout: {
         horizontal: false,
         rootIdAlgorithmFinder: 'FirstZeroInDegree'
    }
})
```
- Defined in Simulation.ts:569

getForceSimulation

getForceSimulation(): SimulationForces
Returns SimulationForces
- Defined in Simulation.ts:548

getSimulation

getSimulation(): Simulation<Node, undefined>
Returns Simulation<Node, undefined>
- Defined in Simulation.ts:552

isDragging

isDragging(): boolean
Returns boolean
- Defined in Simulation.ts:544

pause

pause(): void
Pause the simulation

Returns void
- Defined in Simulation.ts:272

reheat

reheat(alpha?: number): void
Restart the simulation with a bit of heat
Parameters
- alpha: number = 0.7
Returns void
- Defined in Simulation.ts:478

restart

restart(): void
Restart the simulation with rendering on each animation frame.

Returns void
- Defined in Simulation.ts:279

start

start(): Promise<void>
Start the simulation with rendering on each animation frame.

Returns Promise<void>
- Defined in Simulation.ts:287

stop

stop(): void
Manually stop the simulation and cancel animation frame.

Returns void
- Defined in Simulation.ts:307

update

update(): void
Returns void
- Defined in Simulation.ts:223

waitForSimulationStop

waitForSimulationStop(): Promise<void>
Returns a promise that resolves when the simulation stops naturally. Useful for performing actions (like fitAndCenter) after stabilization.

Returns Promise<void>
- Defined in Simulation.ts:367