BlockSuite API Documentation / @blocksuite/blocks / ConnectorTool
Class: ConnectorTool
Extends
BaseTool<ConnectorToolOptions>
Constructors
new ConnectorTool()
new ConnectorTool(
gfx):ConnectorTool
Parameters
gfx
GfxController
Returns
Inherited from
BaseTool<ConnectorToolOptions>.constructor
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:23
Properties
activatedOption
activatedOption:
ConnectorToolOptions
Inherited from
BaseTool.activatedOption
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:11
addHook()
addHook: <
K>(evtName,handler) =>void
Add a hook before the event is handled by the tool. Return false to prevent the tool from handling the event.
Type Parameters
• K extends "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "contextMenu" | keyof BuiltInEventMap
Parameters
evtName
K
handler
(evtState) => boolean | void
Returns
void
Inherited from
BaseTool.addHook
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:12
disposable
protectedreadonlydisposable:DisposableGroup
The disposable will be disposed when the tool is unloaded.
Inherited from
BaseTool.disposable
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:16
gfx
readonlygfx:GfxController
Inherited from
BaseTool.gfx
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:8
toolName
statictoolName:string='connector'
Overrides
BaseTool.toolName
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:38
Accessors
active
Get Signature
get active():
boolean
Returns
boolean
Inherited from
BaseTool.active
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:17
allowDragWithRightButton
Get Signature
get allowDragWithRightButton():
boolean
Returns
boolean
Inherited from
BaseTool.allowDragWithRightButton
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:18
controller
Get Signature
get controller():
ToolController
Returns
ToolController
Inherited from
BaseTool.controller
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:19
doc
Get Signature
get doc():
Doc
Returns
Inherited from
BaseTool.doc
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:20
std
Get Signature
get std():
BlockStdScope
Returns
Inherited from
BaseTool.std
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:21
toolName
Get Signature
get toolName():
string
Returns
string
Inherited from
BaseTool.toolName
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:22
Methods
activate()
activate(
_):void
Called when the tool is activated.
Parameters
_
The data passed as second argument when calling ToolController.use.
Returns
void
Inherited from
BaseTool.activate
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:29
click()
click():
void
Returns
void
Overrides
BaseTool.click
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:93
contextMenu()
contextMenu(
_):void
Parameters
_
Returns
void
Inherited from
BaseTool.contextMenu
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:31
deactivate()
deactivate():
void
Called when the tool is deactivated.
Returns
void
Overrides
BaseTool.deactivate
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:109
doubleClick()
doubleClick(
_):void
Parameters
_
Returns
void
Inherited from
BaseTool.doubleClick
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:36
dragEnd()
dragEnd():
void
Returns
void
Overrides
BaseTool.dragEnd
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:125
dragMove()
dragMove(
e):void
Parameters
e
Returns
void
Overrides
BaseTool.dragMove
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:136
dragStart()
dragStart():
void
Returns
void
Overrides
BaseTool.dragStart
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:140
findTargetByPoint()
findTargetByPoint(
point):void
Parameters
point
IVec
Returns
void
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:146
mounted()
mounted():
void
Called when the tool is registered.
Returns
void
Inherited from
BaseTool.mounted
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:43
pointerDown()
pointerDown(
e):void
Parameters
e
Returns
void
Overrides
BaseTool.pointerDown
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:162
pointerMove()
pointerMove(
e):void
Parameters
e
Returns
void
Overrides
BaseTool.pointerMove
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:167
pointerOut()
pointerOut(
_):void
Parameters
_
Returns
void
Inherited from
BaseTool.pointerOut
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:46
pointerUp()
pointerUp(
_):void
Parameters
_
Returns
void
Overrides
BaseTool.pointerUp
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:189
quickConnect()
quickConnect(
point,element):void
Parameters
point
IVec
element
GfxModel
Returns
void
Defined in
packages/blocks/src/root-block/edgeless/gfx-tool/connector-tool.ts:193
tripleClick()
tripleClick(
_):void
Parameters
_
Returns
void
Inherited from
BaseTool.tripleClick
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:48
unmounted()
unmounted():
void
Called when the tool is unloaded, usually when the whole ToolController is destroyed.
Returns
void
Inherited from
BaseTool.unmounted
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:52
setup()
staticsetup(di):void
Parameters
di
Container
Returns
void
Inherited from
BaseTool.setup
Defined in
packages/framework/block-std/dist/gfx/tool/tool.d.ts:24