Interface LayoutEngine

Interface that all layout engines implement. Engines are stateless; each call to compute() is independent.

interface LayoutEngine {
    compute(ugm: UGM, options?: LayoutOptions): Promise<LayoutResult>;
    id: string;
    name: string;
}

Implemented by

Index

Properties

Methods

Properties

`Readonly`id

id: string

Short identifier (e.g., "force", "hierarchical", "dagre").

`Readonly`name

name: string

Human-readable name for the UI (e.g., "Force-Directed").

Methods

compute

compute(ugm: UGM, options?: LayoutOptions): Promise<LayoutResult>
Compute positions for all nodes in the UGM. Pinned nodes must appear in the result at their pinned positions.
Parameters
- ugm: UGM
- Optionaloptions: LayoutOptions
Returns Promise<LayoutResult>
- Defined in core/src/layout/types.ts:45