ToolManager

Defined in: tool/ToolManager.ts:9

Manages interaction tools for a diagram. Supports GoJS-style multi-tool lists with canStart() auto-selection.

Constructors

Constructor

new ToolManager(diagram): ToolManager

Defined in: tool/ToolManager.ts:25

Parameters

diagram

Diagram

Returns

ToolManager

Accessors

currentTool

Get Signature

get currentTool(): Tool | null

Defined in: tool/ToolManager.ts:68

GoJS-compatible: The currently active tool (or null).

Returns

Tool | null

---

draggingTool

Get Signature

get draggingTool(): DraggingTool | undefined

Defined in: tool/ToolManager.ts:73

GoJS-compatible: The registered dragging tool, for configuring guided dragging.

Returns

DraggingTool | undefined

---

mouseDownTools

Get Signature

get mouseDownTools(): readonly Tool[]

Defined in: tool/ToolManager.ts:78

GoJS-compatible: The tool list consulted on mouse-down events.

Returns

readonly Tool[]

---

mouseMoveTools

Get Signature

get mouseMoveTools(): readonly Tool[]

Defined in: tool/ToolManager.ts:83

GoJS-compatible: The tool list consulted on mouse-move events.

Returns

readonly Tool[]

---

mouseUpTools

Get Signature

get mouseUpTools(): readonly Tool[]

Defined in: tool/ToolManager.ts:88

GoJS-compatible: The tool list consulted on mouse-up events.

Returns

readonly Tool[]

Methods

activateTool()

activateTool(name): boolean

Defined in: tool/ToolManager.ts:186

Activate a tool by name.

Parameters

name

string

Returns

boolean

---

addToolToList()

addToolToList(listName, tool): void

Defined in: tool/ToolManager.ts:93

GoJS-compatible: Add a tool to a specific event list.

Parameters

listName

"click" | "wheel" | "mouseDown" | "mouseMove" | "mouseUp" | "doubleClick" | "keyDown" | "keyUp"

tool

Tool

Returns

void

---

deactivateTool()

deactivateTool(): void

Defined in: tool/ToolManager.ts:202

Deactivate the current tool.

Returns

void

---

getActiveTool()

getActiveTool(): Tool | null

Defined in: tool/ToolManager.ts:212

Get the currently active tool.

Returns

Tool | null

---

getActiveToolName()

getActiveToolName(): string | null

Defined in: tool/ToolManager.ts:217

Get the name of the currently active tool.

Returns

string | null

---

getTool()

getTool(name): Tool | undefined

Defined in: tool/ToolManager.ts:53

Get a tool by name.

Parameters

name

string

Returns

Tool | undefined

---

getToolList()

getToolList(listName): readonly Tool[]

Defined in: tool/ToolManager.ts:132

Get a specific event tool list.

Parameters

listName

"click" | "wheel" | "mouseDown" | "mouseMove" | "mouseUp" | "doubleClick" | "keyDown" | "keyUp"

Returns

readonly Tool[]

---

getToolNames()

getToolNames(): string[]

Defined in: tool/ToolManager.ts:63

Get all registered tool names.

Returns

string[]

---

handleClick()

handleClick(e): void

Defined in: tool/ToolManager.ts:347

Handle click event.

Parameters

e

MouseEvent

Returns

void

---

handleDoubleClick()

handleDoubleClick(e): void

Defined in: tool/ToolManager.ts:361

Handle double click event.

Parameters

e

MouseEvent

Returns

void

---

handleKeyDown()

handleKeyDown(e): void

Defined in: tool/ToolManager.ts:319

Handle key down event.

Parameters

e

KeyboardEvent

Returns

void

---

handleKeyUp()

handleKeyUp(e): void

Defined in: tool/ToolManager.ts:333

Handle key up event.

Parameters

e

KeyboardEvent

Returns

void

---

handleMouseDown()

handleMouseDown(e): void

Defined in: tool/ToolManager.ts:234

Handle mouse down event.

Parameters

e

MouseEvent

Returns

void

---

handleMouseMove()

handleMouseMove(e): void

Defined in: tool/ToolManager.ts:254

Handle mouse move event.

Parameters

e

MouseEvent

Returns

void

---

handleMouseUp()

handleMouseUp(e): void

Defined in: tool/ToolManager.ts:275

Handle mouse up event.

Parameters

e

MouseEvent

Returns

void

---

handleMouseWheel()

handleMouseWheel(e): void

Defined in: tool/ToolManager.ts:298

Handle mouse wheel event.

Parameters

e

WheelEvent

Returns

void

---

hasTool()

hasTool(name): boolean

Defined in: tool/ToolManager.ts:58

Check if a tool is registered.

Parameters

name

string

Returns

boolean

---

registerTool()

registerTool(name, tool): void

Defined in: tool/ToolManager.ts:30

Register a tool with a name.

Parameters

name

string

tool

Tool

Returns

void

---

removeToolFromList()

removeToolFromList(listName, tool): boolean

Defined in: tool/ToolManager.ts:112

GoJS-compatible: Remove a tool from a specific event list.

Parameters

listName

"click" | "wheel" | "mouseDown" | "mouseMove" | "mouseUp" | "doubleClick" | "keyDown" | "keyUp"

tool

Tool

Returns

boolean

---

unregisterTool()

unregisterTool(name): boolean

Defined in: tool/ToolManager.ts:36

Unregister a tool by name.

Parameters

name

string

Returns

boolean