import EdgeTool from 'canvas-graph-creator/src/js/tool/edge-tool.js'

public class | source

EdgeTool

Extends:

Tool → EdgeTool

Tool for adding edges to the graph.

Member Summary

Public Members
public	dest: *
public	start: *

Method Summary

Public Methods
public	cancel() Cancel any
public	deselect() Deselect the selected node (if any).
public	selectNode(graph: Graph, node: Node) Called when a node is selected.
public	selectNone(event: Event, graph: Graph, x: number, y: number) Handler for clicking empty space.
public	selectObject(event: Event, graph: Graph, obj: Node \| Edge \| Label, x: number, y: number) Handler for object selection.

Inherited Summary

From class Tool
public	currentMode: *
public	abortSelect(event: Event, graph: Graph, x: number, y: number) Handler for aborted selections.
public	activate() Called when changing to this tool (if necessary).
public	cancel() Called when switching to a different tool to cancel any incomplete actions.
public	changeMode(mode: string) Called when the mode is changed.
public	dragNone(event: Event, graph: Graph, x: number, y: number) Handler for dragging mouse on empty space.
public	dragObject(event: Event, graph: Graph, srcObj: Node \| Edge \| Label, x: number, y: number) Handler for object dragging.
public	dragOverObject(event: Event, graph: Graph, obj: Node \| Edge \| Label, x: number, y: number) Handler for dragging mouse over an object.
public	dropOnNone(event: Event, graph: Graph, droppedObj: Node \| Edge \| Label, x: number, y: number) Handler for dropping object on empty space.
public	dropOnObject(event: Event, graph: Graph, droppedObj: Node \| Edge \| Label, destObj: Node \| Edge \| Label, x: number, y: number) Handler for object dropping on another object.
public	hasInputs(): boolean Returns a boolean indicating whether or not the tool has inputs.
public	hasModeInputs(): boolean Returns a boolean indicating whether or not the tool has mode-specific inputs.
public	hasModes(): boolean Returns a boolean indicating whether or not the tool has modes.
public	preDragNone(event: Event, graph: Graph, x: number, y: number) Called before the dragNone() handler.
public	preDragObject(event: Event, graph: Graph, srcObj: Node \| Edge \| Label, x: number, y: number): boolean Returns a boolean indicating whether or not the tool should be able to handle dragging.
public	preSelectNone(event: Event, graph: Graph, x: number, y: number) Called before the selectNone() handler.
public	preSelectObject(event: Event, graph: Graph, obj: Node \| Edge \| Label, x: number, y: number): boolean Returns a boolean indicating whether or not the tool should be able to handle selection.
public	selectNone(event: Event, graph: Graph, x: number, y: number) Handler for clicking empty space.
public	selectObject(event: Event, graph: Graph, obj: Node \| Edge \| Label, x: number, y: number) Handler for object selection.

Public Members

public dest: * source

public start: * source

Public Methods

public cancel() source

Cancel any

Override:

Tool#cancel

public deselect() source

Deselect the selected node (if any).

public selectNode(graph: Graph, node: Node) source

Called when a node is selected. Determines whether an edge should be added or not.

Params:

Name	Type	Attribute	Description
graph	Graph		The current Graph object.
node	Node		The selected node.

public selectNone(event: Event, graph: Graph, x: number, y: number) source

Handler for clicking empty space. Deselect any selected nodes.

Override:

Tool#selectNone

Params:

Name	Type	Attribute	Description
event	Event		Event object from event listener.
graph	Graph		The current graph object.
x	number		Mouse x-coordinate (in canvas coordinates).
y	number		Mouse y-coordinate (in canvas coordinates).

public selectObject(event: Event, graph: Graph, obj: Node | Edge | Label, x: number, y: number) source

Handler for object selection. For this tool, only nodes can be selected. When a second node is selected, an edge is created and the tool state is reset.

Override:

Tool#selectObject

Params:

Name	Type	Attribute	Description
event	Event		Event object from event listener.
graph	Graph		The current graph object.
obj	Node \| Edge \| Label		Selected graph component.
x	number		Mouse x-coordinate (in canvas coordinates).
y	number		Mouse y-coordinate (in canvas coordinates).