Class ForceDirectedLayout<T>

Force-directed layout using the existing PhysicsEngine. This is the default layout strategy — wraps PhysicsEngine to conform to the LayoutStrategy interface.

Type Parameters

T extends NodeData = NodeData

Implements

LayoutStrategy<T>

Index

Constructors

Methods

tick isStable updateConfig getConfig

Constructors

constructor

new ForceDirectedLayout<T extends NodeData = NodeData>(
config?: Partial<PhysicsConfig>,
): ForceDirectedLayout<T>
Type Parameters
- T extends NodeData = NodeData
Parameters
- config: Partial<PhysicsConfig> = {}
Returns ForceDirectedLayout<T>
- Defined in physics/ForceDirectedLayout.ts:14

Methods

tick

tick(
    nodes: Map<string, Node<T>>,
    links: PhysicsLink<T>[],
    filteredNodes: null | Set<string>,
): SimulationMetrics
Run one simulation tick. Returns metrics for equilibrium detection.
Parameters
- nodes: Map<string, Node<T>>
- links: PhysicsLink<T>[]
- filteredNodes: null | Set<string>
Returns SimulationMetrics
Implementation of LayoutStrategy.tick
- Defined in physics/ForceDirectedLayout.ts:18

isStable

isStable(metrics: SimulationMetrics): boolean
Check if the layout has reached a stable state.
Parameters
- metrics: SimulationMetrics
Returns boolean
Implementation of LayoutStrategy.isStable
- Defined in physics/ForceDirectedLayout.ts:28

updateConfig

updateConfig(config: Partial<PhysicsConfig>): void
Update layout configuration.
Parameters
- config: Partial<PhysicsConfig>
Returns void
Implementation of LayoutStrategy.updateConfig
- Defined in physics/ForceDirectedLayout.ts:32

getConfig

getConfig(): PhysicsConfig
Get current configuration.

Returns PhysicsConfig
Implementation of LayoutStrategy.getConfig
- Defined in physics/ForceDirectedLayout.ts:36