# Class ClickSelectingTool

GoJS® Diagramming Components
version 3.0.14
by Northwoods Software®

#### Hierarchy

- Tool
  - ClickSelectingTool

The ClickSelectingTool selects and deselects Parts when there is a click. It does this by calling Tool.standardMouseSelect. It is also responsible for handling and dispatching click events on GraphObjects by calling Tool.standardMouseClick.

Note that this tool avoids raising click events on objects that are in temporary layers. This is to prevent parts such as selection adornments from interfering with clicking on selected nodes or links. (Adornments are in the "Adornment" Layer, which Layer.isTemporary.) However this means that if you add a GraphObject.click event handler on a GraphObject in an Adornment, it will not be called. You can get it to be called by setting GraphObject.isActionable to true on that object in the adornment.

This tool is a standard mouse-up tool, the ToolManager.clickSelectingTool.

This tool does not utilize any Adornments or tool handles. This tool does not modify the model or conduct any transaction.

An example customization of this tool is shown in the Tree Map sample, where the Tool.standardMouseSelect method is overridden to permit the user to cycle through the chain of containing groups, changing the selection on each click to the next containing group.

If you want to programmatically select a Part, you can set Part.isSelected or call Diagram.select. If you want to know which Part is at a particular point, you can call Diagram.findPartAt.

#####
Index

### Constructors

constructor

### Methods

canStart
doMouseUp

#####
Inherited Index

### Accessors

Tool.diagram
Tool.isActive
Tool.isEnabled
Tool.name
Tool.transactionResult

### Methods

Tool.canStartMultiTouch
Tool.cancelWaitAfter
Tool.doActivate
Tool.doCancel
Tool.doDeactivate
Tool.doKeyDown
Tool.doKeyUp
Tool.doMouseDown
Tool.doMouseMove
Tool.doMouseWheel
Tool.doStart
Tool.doStop
Tool.doWaitAfter
Tool.findToolHandleAt
Tool.isBeyondDragSize
Tool.standardMouseClick
Tool.standardMouseOver
Tool.standardMouseSelect
Tool.standardMouseWheel
Tool.standardPinchZoomMove
Tool.standardPinchZoomStart
Tool.standardWaitAfter
Tool.startTransaction
Tool.stopTool
Tool.stopTransaction
Tool.updateAdornments

## Constructors

### constructor

- new ClickSelectingTool(init?: Partial<ClickSelectingTool>): ClickSelectingTool

- You do not normally need to create an instance of this tool because one already exists as the ToolManager.clickSelectingTool.

  The Tool.name of this tool is "ClickSelecting".

  #### Parameters

  - ##### `Optional` init: Partial<ClickSelectingTool>

  #### Returns ClickSelectingTool

## Methods

### `Virtual` `Override` canStart

- canStart(): boolean

- This tool can run whenever a click occurs.

  This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

  #### Returns boolean

### `Override` doMouseUp

- doMouseUp(): void

- Upon a click, this calls Tool.standardMouseSelect to change the Diagram.selection collection, then calls Tool.standardMouseClick to perform the normal click behaviors, and then stops this tool.

  #### Returns void

Copyright © 1998-2024 by Northwoods Software Corporation.