Skip to main content

Class: DefaultLayouts

Defined in: src/layout.worker.ts:14

Provides a web worker with basic diagram layout algorithms.

Constructors​

Constructor​

new DefaultLayouts(): DefaultLayouts

Returns​

DefaultLayouts

Methods​

defaultLayout()​

defaultLayout(graph, state, options?): Promise<LayoutState>

Defined in: src/layout.worker.ts:21

Default layout algorithm, the same as blockingDefaultLayout but non-blocking due to being run in a worker.

Parameters​

ParameterType

graph

LayoutGraph

state

LayoutState

options?

DefaultLayoutOptions

Returns​

Promise<LayoutState>

See​

blockingDefaultLayout


flowLayout()​

flowLayout(graph, state, options?): Promise<LayoutState>

Defined in: src/layout.worker.ts:43

Flow layout algorithm from cola.js.

Parameters​

ParameterType

graph

LayoutGraph

state

LayoutState

options?

ColaFlowLayoutOptions

Returns​

Promise<LayoutState>


forceLayout()​

forceLayout(graph, state, options?): Promise<LayoutState>

Defined in: src/layout.worker.ts:32

Force-directed layout algorithm from cola.js.

Parameters​

ParameterType

graph

LayoutGraph

state

LayoutState

options?

ColaForceLayoutOptions

Returns​

Promise<LayoutState>


removeOverlaps()​

removeOverlaps(graph, state): Promise<LayoutState>

Defined in: src/layout.worker.ts:54

Remove overlaps algorithm from cola.js.

Parameters​

ParameterType

graph

LayoutGraph

state

LayoutState

Returns​

Promise<LayoutState>