Interface GraphLayout<NodeData, EdgeData>

interface GraphLayout<NodeData = unknown, EdgeData = unknown> {
    capabilities?: LayoutCapabilities;
    name: string;
    run(
        snapshot: LayoutInput<NodeData, EdgeData>,
        context?: LayoutRunContext,
    ): LayoutResult | Promise<LayoutResult>;
}

Type Parameters

NodeData = unknown
EdgeData = unknown

Implemented by

Index

Properties

capabilities? name

Methods

Properties

`Optional` `Readonly`capabilities

capabilities?: LayoutCapabilities

`Readonly`name

name: string

Methods

run

run(
snapshot: LayoutInput<NodeData, EdgeData>,
context?: LayoutRunContext,
): LayoutResult | Promise<LayoutResult>
Parameters
- snapshot: LayoutInput<NodeData, EdgeData>
- Optionalcontext: LayoutRunContext
Returns LayoutResult | Promise<LayoutResult>