Graphty

Appearance

@graphty/graphty-element / managers / LayoutManager

Class: LayoutManager ​

Defined in: src/managers/LayoutManager.ts:29

Manages layout engines and their lifecycle Coordinates layout updates and transitions

Implements ​

Constructors ​

Constructor ​

new LayoutManager(eventManager, dataManager, styles): LayoutManager

Defined in: src/managers/LayoutManager.ts:58

Creates an instance of LayoutManager

Parameters ​

eventManager ​

EventManager

Event manager for emitting layout events

dataManager ​

DataManager

Data manager for accessing nodes and edges

styles ​

Styles

Styles instance for layout configuration

Returns ​

LayoutManager

Properties ​

layoutEngine? ​

optional layoutEngine: LayoutEngine

Defined in: src/managers/LayoutManager.ts:30

Accessors ​

edges ​

Get Signature ​

get edges(): Iterable<Edge>

Defined in: src/managers/LayoutManager.ts:301

Get edges from layout engine

Returns ​

Iterable<Edge>

Iterable of edges managed by the layout engine

isSettled ​

Get Signature ​

get isSettled(): boolean

Defined in: src/managers/LayoutManager.ts:274

Check if layout has settled

Returns ​

boolean

True if layout has settled, false otherwise

layoutType ​

Get Signature ​

get layoutType(): string | undefined

Defined in: src/managers/LayoutManager.ts:309

Get current layout type

Returns ​

string | undefined

Current layout type identifier or undefined if no layout is set

nodes ​

Get Signature ​

get nodes(): Iterable<Node>

Defined in: src/managers/LayoutManager.ts:293

Get nodes from layout engine

Returns ​

Iterable<Node>

Iterable of nodes managed by the layout engine

running ​

Get Signature ​

get running(): boolean

Defined in: src/managers/LayoutManager.ts:38

Gets the running state of the layout

Returns ​

boolean

True if layout is running, false otherwise

Set Signature ​

set running(value): void

Defined in: src/managers/LayoutManager.ts:45

Sets the running state of the layout

Parameters ​
value ​

boolean

Returns ​

void

Methods ​

applyTemplateLayout() ​

applyTemplateLayout(layoutType?, layoutOptions?): Promise<void>

Defined in: src/managers/LayoutManager.ts:358

Apply layout from style template if specified

Parameters ​

layoutType? ​

string

Layout type identifier from template

layoutOptions? ​

object

Layout options from template

Returns ​

Promise<void>

dispose() ​

dispose(): void

Defined in: src/managers/LayoutManager.ts:92

Disposes of the layout manager and cleans up resources

Returns ​

void

Implementation of ​

Manager.dispose

getEdgePath() ​

getEdgePath(edge): [number, number, number][] | undefined

Defined in: src/managers/LayoutManager.ts:262

Get edge path from layout engine

Parameters ​

edge ​

Edge

Edge to get path for

Returns ​

[number, number, number][] | undefined

Edge path as array of [x, y, z] points or undefined if not available

getNodePosition() ​

getNodePosition(node): [number, number, number] | undefined

Defined in: src/managers/LayoutManager.ts:248

Get node position from layout engine

Parameters ​

node ​

Node

Node to get position for

Returns ​

[number, number, number] | undefined

Node position as [x, y, z] or undefined if not available

getStats() ​

getStats(): object

Defined in: src/managers/LayoutManager.ts:405

Get layout statistics

Returns ​

object

Object containing layout statistics

edgeCount ​

edgeCount: number

isRunning ​

isRunning: boolean

isSettled ​

isSettled: boolean

layoutType ​

layoutType: string | undefined

nodeCount ​

nodeCount: number

hasLayoutEngine() ​

hasLayoutEngine(): boolean

Defined in: src/managers/LayoutManager.ts:428

Check if layout engine is currently set

Returns ​

boolean

True if layout engine is set, false otherwise

init() ​

init(): Promise<void>

Defined in: src/managers/LayoutManager.ts:84

Initializes the layout manager

Returns ​

Promise<void>

Promise that resolves when initialization is complete

Implementation of ​

Manager.init

setGraphContext() ​

setGraphContext(context): void

Defined in: src/managers/LayoutManager.ts:68

Set the GraphContext for error reporting

Parameters ​

context ​

GraphContext

GraphContext instance

Returns ​

void

setLayout() ​

setLayout(type, opts): Promise<void>

Defined in: src/managers/LayoutManager.ts:230

Public method for setting layout This goes through the queue when called from Graph

Parameters ​

type ​

string

Layout type identifier

opts ​

object = {}

Layout-specific options

Returns ​

Promise<void>

Promise that resolves when layout is set

step() ​

step(): void

Defined in: src/managers/LayoutManager.ts:237

Step the layout engine forward

Returns ​

void

updateLayoutDimension() ​

updateLayoutDimension(twoD): Promise<void>

Defined in: src/managers/LayoutManager.ts:317

Update layout dimension when 2D/3D mode changes

Parameters ​

twoD ​

boolean

Whether to use 2D mode

Returns ​

Promise<void>

updatePositions() ​

updatePositions(nodes): Promise<void>

Defined in: src/managers/LayoutManager.ts:437

Update positions for newly added nodes This is called when nodes are added to an existing layout

Parameters ​

nodes ​

Node[]

Array of nodes to update positions for

Returns ​

Promise<void>

updateStyles() ​

updateStyles(styles): void

Defined in: src/managers/LayoutManager.ts:76

Update the styles reference when a new style template is loaded

Parameters ​

styles ​

Styles

New styles instance

Returns ​

void