ForceDirectedLayout

Defined in: layout/ForceDirectedLayout.ts:36

Force-directed layout using a simple spring-electric model. Repulsion (the O(n²) part of the naive algorithm) is approximated with a BarnesHutTree, making each iteration O(n log n) — see theta to tune the accuracy/speed trade-off.

Extends

• Layout

Constructors

Constructor

new ForceDirectedLayout(options?): ForceDirectedLayout

Defined in: layout/ForceDirectedLayout.ts:43

Parameters

options?

ForceDirectedLayoutOptions = {}

Returns

ForceDirectedLayout

Overrides

Layout.constructor

Properties

diagram

diagram: Diagram | null = null

Defined in: layout/Layout.ts:34

GoJS-compatible: the Diagram this layout is assigned to (set by Diagram.layout = ...), used by doLayout() when called with no explicit collection.

Inherited from

Layout.diagram

Accessors

defaultSpringLength

Get Signature

get defaultSpringLength(): number

Defined in: layout/ForceDirectedLayout.ts:53

GoJS-compatible: The default spring length between linked nodes.

Returns

number

Set Signature

set defaultSpringLength(value): void

Defined in: layout/ForceDirectedLayout.ts:57

Parameters

value

number

Returns

void

---

isFinal

Get Signature

get isFinal(): boolean

Defined in: layout/Layout.ts:234

GoJS-compatible: Whether this is the final layout of a cycle.

Returns

boolean

Set Signature

set isFinal(value): void

Defined in: layout/Layout.ts:238

Parameters

value

boolean

Returns

void

Inherited from

Layout.isFinal

---

isInitial

Get Signature

get isInitial(): boolean

Defined in: layout/Layout.ts:225

GoJS-compatible: Whether this is the initial layout of the diagram.

Returns

boolean

Set Signature

set isInitial(value): void

Defined in: layout/Layout.ts:229

Parameters

value

boolean

Returns

void

Inherited from

Layout.isInitial

---

isOngoing

Get Signature

get isOngoing(): boolean

Defined in: layout/Layout.ts:243

GoJS-compatible: Whether the layout is ongoing (auto-layout is active).

Returns

boolean

Set Signature

set isOngoing(value): void

Defined in: layout/Layout.ts:247

Parameters

value

boolean

Returns

void

Inherited from

Layout.isOngoing

---

network

Get Signature

get network(): LayoutNetwork | null

Defined in: layout/Layout.ts:200

GoJS-compatible: The current layout network (or null).

Returns

LayoutNetwork | null

Set Signature

set network(value): void

Defined in: layout/Layout.ts:204

Parameters

value

LayoutNetwork | null

Returns

void

Inherited from

Layout.network

Methods

apply()

apply(nodes, links): void

Defined in: layout/ForceDirectedLayout.ts:61

Apply the layout to the given nodes and links.

Parameters

nodes

Node[]

links

Link[]

Returns

void

Overrides

Layout.apply

---

doLayout()

doLayout(collection?): void

Defined in: layout/Layout.ts:176

GoJS-compatible: Perform the layout on a collection of parts (or this diagram’s parts).

Parameters

collection?

links?

readonly Link[]

nodes?

readonly Node[]

Returns

void

Inherited from

Layout.doLayout

---

layoutParts()

layoutParts(parts): void

Defined in: layout/Layout.ts:183

GoJS-compatible: Perform the layout on the given parts.

Parameters

parts

readonly Part[]

Returns

void

Inherited from

Layout.layoutParts