LinkingTool

Defined in: tool/LinkingTool.ts:9

Tool for creating links by dragging from a node to another node.

Extends

• LinkingBaseTool

Constructors

Constructor

new LinkingTool(): LinkingTool

Returns

LinkingTool

Inherited from

LinkingBaseTool.constructor

Accessors

archetypeLinkData

Get Signature

get archetypeLinkData(): LinkData | null

Defined in: tool/LinkingTool.ts:13

GoJS-compatible: A template of properties for links created by this tool.

Returns

LinkData | null

Set Signature

set archetypeLinkData(value): void

Defined in: tool/LinkingTool.ts:17

Parameters

value

LinkData | null

Returns

void

---

diagram

Get Signature

get diagram(): Diagram | null

Defined in: tool/Tool.ts:13

Get the diagram this tool belongs to.

Returns

Diagram | null

Set Signature

set diagram(value): void

Defined in: tool/Tool.ts:18

Set the diagram this tool belongs to.

Parameters

value

Diagram | null

Returns

void

Inherited from

ZoomingTool.diagram

---

isActive

Get Signature

get isActive(): boolean

Defined in: tool/Tool.ts:23

Check if this tool is currently active.

Returns

boolean

Inherited from

LinkingBaseTool.isActive

---

isDragging

Get Signature

get isDragging(): boolean

Defined in: tool/LinkingBaseTool.ts:20

Whether a linking drag is in progress.

Returns

boolean

Inherited from

LinkingBaseTool.isDragging

---

isEnabled

Get Signature

get isEnabled(): boolean

Defined in: tool/Tool.ts:28

Check if this tool is enabled.

Returns

boolean

Set Signature

set isEnabled(value): void

Defined in: tool/Tool.ts:33

Enable or disable this tool.

Parameters

value

boolean

Returns

void

Inherited from

ZoomingTool.isEnabled

---

isLinking

Get Signature

get isLinking(): boolean

Defined in: tool/LinkingTool.ts:22

Whether a linking drag is in progress.

Returns

boolean

---

isValidLink

Get Signature

get isValidLink(): boolean

Defined in: tool/LinkingBaseTool.ts:44

Whether the current link being created is valid.

Returns

boolean

Inherited from

LinkingBaseTool.isValidLink

---

preventCycles

Get Signature

get preventCycles(): boolean

Defined in: tool/LinkingBaseTool.ts:35

Whether cycle creation is prevented.

Returns

boolean

Set Signature

set preventCycles(value): void

Defined in: tool/LinkingBaseTool.ts:39

Parameters

value

boolean

Returns

void

Inherited from

LinkingBaseTool.preventCycles

---

sourceNode

Get Signature

get sourceNode(): Node | null

Defined in: tool/LinkingTool.ts:27

The source node of the link being created.

Returns

Node | null

Overrides

LinkingBaseTool.sourceNode

---

targetNode

Get Signature

get targetNode(): Node | null

Defined in: tool/LinkingTool.ts:32

The current target node under the cursor, or null.

Returns

Node | null

Overrides

LinkingBaseTool.targetNode

Methods

canStart()

canStart(_toolName, e): boolean

Defined in: tool/LinkingTool.ts:37

GoJS-compatible: start drawing a link when pressing on an actual port.

Parameters

_toolName

string

e

MouseEvent

Returns

boolean

Overrides

LinkingBaseTool.canStart

---

createLink()

createLink(source, target): boolean

Defined in: tool/LinkingTool.ts:119

Create a link between two nodes in the model.

Parameters

source

Node

target

Node

Returns

boolean

---

doActivate()

doActivate(): void

Defined in: tool/Tool.ts:38

Called when the tool becomes the active tool.

Returns

void

Inherited from

LinkingBaseTool.doActivate

---

doClick()

doClick(_e): void

Defined in: tool/Tool.ts:78

Called when a click event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

LinkingBaseTool.doClick

---

doDeactivate()

doDeactivate(): void

Defined in: tool/Tool.ts:43

Called when the tool is deactivated.

Returns

void

Inherited from

LinkingBaseTool.doDeactivate

---

doDoubleClick()

doDoubleClick(_e): void

Defined in: tool/Tool.ts:83

Called when a double click event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

LinkingBaseTool.doDoubleClick

---

doKeyDown()

doKeyDown(_e): void

Defined in: tool/Tool.ts:68

Called when a key down event occurs.

Parameters

_e

KeyboardEvent

Returns

void

Inherited from

LinkingBaseTool.doKeyDown

---

doKeyUp()

doKeyUp(_e): void

Defined in: tool/Tool.ts:73

Called when a key up event occurs.

Parameters

_e

KeyboardEvent

Returns

void

Inherited from

LinkingBaseTool.doKeyUp

---

doMouseDown()

doMouseDown(e): void

Defined in: tool/LinkingTool.ts:52

Called when a mouse down event occurs.

Parameters

e

MouseEvent

Returns

void

Overrides

LinkingBaseTool.doMouseDown

---

doMouseMove()

doMouseMove(e): void

Defined in: tool/LinkingTool.ts:76

Called when a mouse move event occurs.

Parameters

e

MouseEvent

Returns

void

Overrides

LinkingBaseTool.doMouseMove

---

doMouseUp()

doMouseUp(_e): void

Defined in: tool/LinkingTool.ts:99

Called when a mouse up event occurs.

Parameters

_e

MouseEvent

Returns

void

Overrides

LinkingBaseTool.doMouseUp

---

doMouseWheel()

doMouseWheel(_e): void

Defined in: tool/Tool.ts:63

Called when a mouse wheel event occurs.

Parameters

_e

WheelEvent

Returns

void

Inherited from

LinkingBaseTool.doMouseWheel

---

doStart()

doStart(_e): void

Defined in: tool/Tool.ts:90

GoJS-compatible: Called when a tool operation starts (after canStart returns true).

Parameters

_e

MouseEvent

Returns

void

Inherited from

LinkingBaseTool.doStart

---

doStop()

doStop(): void

Defined in: tool/Tool.ts:97

GoJS-compatible: Called when a tool operation stops.

Returns

void

Inherited from

LinkingBaseTool.doStop

---

findPartAt()

findPartAt(x, y): Part | null

Defined in: tool/Tool.ts:110

Find a part at the given diagram coordinates.

Parameters

x

number

y

number

Returns

Part | null

Inherited from

LinkingBaseTool.findPartAt

---

getDiagramPoint()

getDiagramPoint(e): object

Defined in: tool/Tool.ts:116

Get the mouse position in diagram coordinates.

Parameters

e

MouseEvent

Returns

object

x

x: number

y

y: number

Inherited from

LinkingBaseTool.getDiagramPoint

---

wouldCreateCycle()

wouldCreateCycle(from, to, model): boolean

Defined in: tool/LinkingBaseTool.ts:77

Check whether adding a link from from to to would create a cycle.

Parameters

from

string | number

to

string | number

model

getLinksFrom

(key) => readonly object[]

Returns

boolean

Inherited from

LinkingBaseTool.wouldCreateCycle