Layout

Defined in: layout/Layout.ts:23

Abstract base class for diagram layouts.

Extended by

• CircularLayout
• ForceDirectedLayout
• GridLayout
• LayeredDigraphLayout
• SpotLayout
• TreeLayout

Constructors

Constructor

new Layout(options?): Layout

Defined in: layout/Layout.ts:36

Parameters

options?

LayoutOptions = {}

Returns

Layout

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.

Accessors

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

---

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

---

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

---

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

Methods

apply()

abstract apply(nodes, links): void

Defined in: layout/Layout.ts:46

Apply the layout to the given nodes and links.

Parameters

nodes

Node[]

links

Link[]

Returns

void

---

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

---

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