Class GraphLayout<T>

Type Parameters

T = Record<string, unknown>

Index

Methods

create addNode removeNode hasNode getNode setPosition setPinned nodeCount addEdge removeEdge hasEdge edgeCount tick stabilize positions getSnapshot forEach clear dispose

Methods

`Static`create

create<T = Record<string, unknown>>(opts?: GraphLayoutOptions): GraphLayout<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- opts: GraphLayoutOptions = {}
Returns GraphLayout<T>
- Defined in runtime/graph-layout.ts:180

addNode

addNode(spec: GraphNodeSpec<T>): boolean
Parameters
- spec: GraphNodeSpec<T>
Returns boolean
- Defined in runtime/graph-layout.ts:187

removeNode

removeNode(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/graph-layout.ts:207

hasNode

hasNode(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/graph-layout.ts:220

getNode

getNode(id: string): NodePosition<T> | null
Parameters
- id: string
Returns NodePosition<T> | null
- Defined in runtime/graph-layout.ts:224

setPosition

setPosition(id: string, x: number, y: number): boolean
Parameters
- id: string
- x: number
- y: number
Returns boolean
- Defined in runtime/graph-layout.ts:229

setPinned

setPinned(id: string, pinned: boolean): boolean
Parameters
- id: string
- pinned: boolean
Returns boolean
- Defined in runtime/graph-layout.ts:241

nodeCount

nodeCount(): number
Returns number
- Defined in runtime/graph-layout.ts:253

addEdge

addEdge(spec: GraphEdgeSpec): boolean
Parameters
- spec: GraphEdgeSpec
Returns boolean
- Defined in runtime/graph-layout.ts:257

removeEdge

removeEdge(fromId: string, toId: string): boolean
Parameters
- fromId: string
- toId: string
Returns boolean
- Defined in runtime/graph-layout.ts:275

hasEdge

hasEdge(fromId: string, toId: string): boolean
Parameters
- fromId: string
- toId: string
Returns boolean
- Defined in runtime/graph-layout.ts:283

edgeCount

edgeCount(): number
Returns number
- Defined in runtime/graph-layout.ts:287

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/graph-layout.ts:293

stabilize

stabilize(maxIterations?: number): number
Parameters
- OptionalmaxIterations: number
Returns number
- Defined in runtime/graph-layout.ts:304

positions

positions(): NodePosition<T>[]
Returns NodePosition<T>[]
- Defined in runtime/graph-layout.ts:319

getSnapshot

getSnapshot(): GraphSnapshot<T>
Returns GraphSnapshot<T>
- Defined in runtime/graph-layout.ts:330

forEach

forEach(cb: (n: NodePosition<T>) => void): void
Parameters
- cb: (n: NodePosition<T>) => void
Returns void
- Defined in runtime/graph-layout.ts:358

clear

clear(): void
Returns void
- Defined in runtime/graph-layout.ts:368

dispose

dispose(): void
Returns void
- Defined in runtime/graph-layout.ts:374