Interface LayoutStrategy<T>

Interface for pluggable layout algorithms. The default is ForceDirectedLayout (wraps PhysicsEngine). Implement this to provide tree, radial, grid, or other layouts.

interface LayoutStrategy<T extends NodeData = NodeData> {
    tick(
        nodes: Map<string, Node<T>>,
        links: PhysicsLink<T>[],
        filteredNodes: null | Set<string>,
    ): SimulationMetrics;
    isStable(metrics: SimulationMetrics): boolean;
    updateConfig(config: Partial<PhysicsConfig>): void;
    getConfig(): PhysicsConfig;
}

Type Parameters

T extends NodeData = NodeData

Implemented by

Index

Methods

tick isStable updateConfig getConfig

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
- Defined in physics/LayoutStrategy.ts:12

isStable

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

updateConfig

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

getConfig

getConfig(): PhysicsConfig
Get current configuration.

Returns PhysicsConfig
- Defined in physics/LayoutStrategy.ts:25

Interface LayoutStrategy<T>

Type Parameters

Implemented by

Index

Methods

Methods

tick

Parameters

Returns SimulationMetrics

isStable

Parameters

Returns boolean

updateConfig

Parameters

Returns void

getConfig

Returns PhysicsConfig

Settings

On This Page