MouseCaptor
Defined in: packages/sigma/src/core/captors/mouse.ts:63
Mouse captor class.
Extends
Section titled “Extends”default<MouseCaptorEvents,N,E,G>
Type Parameters
Section titled “Type Parameters”N extends Attributes = Attributes
E extends Attributes = Attributes
G extends Attributes = Attributes
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MouseCaptor<
N,E,G>(container,renderer):MouseCaptor<N,E,G>
Defined in: packages/sigma/src/core/captors/mouse.ts:92
Parameters
Section titled “Parameters”container
Section titled “container”HTMLElement
renderer
Section titled “renderer”Sigma<N, E, G>
Returns
Section titled “Returns”MouseCaptor<N, E, G>
Overrides
Section titled “Overrides”Captor<MouseCaptorEvents, N, E, G>.constructor
Properties
Section titled “Properties”clicks
Section titled “clicks”clicks:
number=0
Defined in: packages/sigma/src/core/captors/mouse.ts:79
container
Section titled “container”container:
HTMLElement
Defined in: packages/sigma/src/core/captors/captor.ts:141
Inherited from
Section titled “Inherited from”currentWheelDirection
Section titled “currentWheelDirection”currentWheelDirection:
-1|0|1=0
Defined in: packages/sigma/src/core/captors/mouse.ts:86
doubleClickTimeout
Section titled “doubleClickTimeout”doubleClickTimeout:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:80
downStartTime
Section titled “downStartTime”downStartTime:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:71
draggedEvents
Section titled “draggedEvents”draggedEvents:
number=0
Defined in: packages/sigma/src/core/captors/mouse.ts:70
enabled
Section titled “enabled”enabled:
boolean=true
Defined in: packages/sigma/src/core/captors/mouse.ts:69
isMouseDown
Section titled “isMouseDown”isMouseDown:
boolean=false
Defined in: packages/sigma/src/core/captors/mouse.ts:74
isMoving
Section titled “isMoving”isMoving:
boolean=false
Defined in: packages/sigma/src/core/captors/mouse.ts:75
isPanningStage
Section titled “isPanningStage”isPanningStage:
boolean=false
Defined in: packages/sigma/src/core/captors/mouse.ts:76
isRightMouseDown
Section titled “isRightMouseDown”isRightMouseDown:
boolean=false
Defined in: packages/sigma/src/core/captors/mouse.ts:82
lastMouseX
Section titled “lastMouseX”lastMouseX:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:72
lastMouseY
Section titled “lastMouseY”lastMouseY:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:73
lastWheelTriggerTime?
Section titled “lastWheelTriggerTime?”
optionallastWheelTriggerTime?:number
Defined in: packages/sigma/src/core/captors/mouse.ts:87
movingTimeout
Section titled “movingTimeout”movingTimeout:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:77
rawEmitter
Section titled “rawEmitter”rawEmitter:
EventEmitter
Defined in: packages/sigma/src/types.ts:253
Inherited from
Section titled “Inherited from”Captor.rawEmitter
renderer
Section titled “renderer”renderer:
Sigma<N,E,G>
Defined in: packages/sigma/src/core/captors/captor.ts:142
Inherited from
Section titled “Inherited from”Captor.renderer
settings
Section titled “settings”settings:
MouseSettings=DEFAULT_MOUSE_SETTINGS
Defined in: packages/sigma/src/core/captors/mouse.ts:90
startCameraAngle
Section titled “startCameraAngle”startCameraAngle:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:84
startCameraState
Section titled “startCameraState”startCameraState:
CameraState|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:78
startRotationAngle
Section titled “startRotationAngle”startRotationAngle:
number|null=null
Defined in: packages/sigma/src/core/captors/mouse.ts:83
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:259
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.addListener
emit()
Section titled “emit()”emit<
Event>(type, …args):boolean
Defined in: packages/sigma/src/types.ts:258
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
…Parameters<MouseCaptorEvents[Event]>
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Captor.emit
eventNames()
Section titled “eventNames()”eventNames<
Event>():Event[]
Defined in: packages/sigma/src/types.ts:255
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Returns
Section titled “Returns”Event[]
Inherited from
Section titled “Inherited from”Captor.eventNames
getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: packages/sigma/src/types.ts:257
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Captor.getMaxListeners
handleClick()
Section titled “handleClick()”handleClick(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:132
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleDoubleClick()
Section titled “handleDoubleClick()”handleDoubleClick(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:166
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleDown()
Section titled “handleDown()”handleDown(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:187
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleEnter()
Section titled “handleEnter()”handleEnter(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:380
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleLeave()
Section titled “handleLeave()”handleLeave(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:375
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleMove()
Section titled “handleMove()”handleMove(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:287
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleRightClick()
Section titled “handleRightClick()”handleRightClick(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:156
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleUp()
Section titled “handleUp()”handleUp(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:218
Parameters
Section titled “Parameters”MouseEvent
Returns
Section titled “Returns”void
handleWheel()
Section titled “handleWheel()”handleWheel(
e):void
Defined in: packages/sigma/src/core/captors/mouse.ts:385
Parameters
Section titled “Parameters”WheelEvent
Returns
Section titled “Returns”void
kill()
Section titled “kill()”kill():
void
Defined in: packages/sigma/src/core/captors/mouse.ts:119
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Captor.kill
listenerCount()
Section titled “listenerCount()”listenerCount<
Event>(type):number
Defined in: packages/sigma/src/types.ts:268
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Captor.listenerCount
listeners()
Section titled “listeners()”listeners<
Event>(type):MouseCaptorEvents[Event][]
Defined in: packages/sigma/src/types.ts:267
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”MouseCaptorEvents[Event][]
Inherited from
Section titled “Inherited from”Captor.listeners
off<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:265
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.off
on<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:260
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.on
once()
Section titled “once()”once<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:261
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.once
prependListener()
Section titled “prependListener()”prependListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:262
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.prependListener
prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:263
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.prependOnceListener
rawListeners()
Section titled “rawListeners()”rawListeners<
Event>(type):MouseCaptorEvents[Event][]
Defined in: packages/sigma/src/types.ts:269
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”MouseCaptorEvents[Event][]
Inherited from
Section titled “Inherited from”Captor.rawListeners
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners<
Event>(type?):this
Defined in: packages/sigma/src/types.ts:266
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener<
Event>(type,listener):this
Defined in: packages/sigma/src/types.ts:264
Type Parameters
Section titled “Type Parameters”Event extends keyof MouseCaptorEvents
Parameters
Section titled “Parameters”Event
listener
Section titled “listener”MouseCaptorEvents[Event]
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.removeListener
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
n):this
Defined in: packages/sigma/src/types.ts:256
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Captor.setMaxListeners
setSettings()
Section titled “setSettings()”setSettings(
settings):void
Defined in: packages/sigma/src/core/captors/mouse.ts:442
Parameters
Section titled “Parameters”settings
Section titled “settings”MouseSettings
Returns
Section titled “Returns”void