MouseCaptor

Defined in: packages/sigma/src/core/captors/mouse.ts:58

Mouse captor class.

Extends

• default<MouseCaptorEvents, N, E, G>

Type Parameters

N

N extends Attributes = Attributes

E

E extends Attributes = Attributes

G

G extends Attributes = Attributes

Constructors

Constructor

new MouseCaptor<N, E, G>(container, renderer): MouseCaptor<N, E, G>

Defined in: packages/sigma/src/core/captors/mouse.ts:87

Parameters

container

HTMLElement

renderer

Sigma<N, E, G>

Returns

MouseCaptor<N, E, G>

Overrides

Captor<MouseCaptorEvents, N, E, G>.constructor

Properties

clicks

clicks: number = 0

Defined in: packages/sigma/src/core/captors/mouse.ts:74

---

consecutiveBoundaryWheelEvents

consecutiveBoundaryWheelEvents: number = 0

Defined in: packages/sigma/src/core/captors/mouse.ts:83

---

container

container: HTMLElement

Defined in: packages/sigma/src/core/captors/captor.ts:142

Inherited from

TouchCaptor.container

---

currentWheelDirection

currentWheelDirection: -1 | 0 | 1 = 0

Defined in: packages/sigma/src/core/captors/mouse.ts:81

---

doubleClickTimeout

doubleClickTimeout: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:75

---

downStartTime

downStartTime: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:66

---

draggedEvents

draggedEvents: number = 0

Defined in: packages/sigma/src/core/captors/mouse.ts:65

---

enabled

enabled: boolean = true

Defined in: packages/sigma/src/core/captors/mouse.ts:64

---

isMouseDown

isMouseDown: boolean = false

Defined in: packages/sigma/src/core/captors/mouse.ts:69

---

isMoving

isMoving: boolean = false

Defined in: packages/sigma/src/core/captors/mouse.ts:70

---

isPanningStage

isPanningStage: boolean = false

Defined in: packages/sigma/src/core/captors/mouse.ts:71

---

isRightMouseDown

isRightMouseDown: boolean = false

Defined in: packages/sigma/src/core/captors/mouse.ts:77

---

lastMouseX

lastMouseX: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:67

---

lastMouseY

lastMouseY: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:68

---

lastWheelTriggerTime?

optional lastWheelTriggerTime?: number

Defined in: packages/sigma/src/core/captors/mouse.ts:82

---

movingTimeout

movingTimeout: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:72

---

rawEmitter

rawEmitter: EventEmitter

Defined in: packages/sigma/src/types.ts:190

Inherited from

Captor.rawEmitter

---

renderer

renderer: Sigma<N, E, G>

Defined in: packages/sigma/src/core/captors/captor.ts:143

Inherited from

Captor.renderer

---

settings

settings: MouseSettings = DEFAULT_MOUSE_SETTINGS

Defined in: packages/sigma/src/core/captors/mouse.ts:85

---

startCameraAngle

startCameraAngle: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:79

---

startCameraState

startCameraState: CameraState | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:73

---

startRotationAngle

startRotationAngle: number | null = null

Defined in: packages/sigma/src/core/captors/mouse.ts:78

Methods

addListener()

addListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:196

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.addListener

---

emit()

emit<Event>(type, …args): boolean

Defined in: packages/sigma/src/types.ts:195

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

args

…Parameters<MouseCaptorEvents[Event]>

Returns

boolean

Inherited from

Captor.emit

---

eventNames()

eventNames<Event>(): Event[]

Defined in: packages/sigma/src/types.ts:192

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Returns

Event[]

Inherited from

Captor.eventNames

---

getMaxListeners()

getMaxListeners(): number

Defined in: packages/sigma/src/types.ts:194

Returns

number

Inherited from

Captor.getMaxListeners

---

handleClick()

handleClick(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:126

Parameters

e

MouseEvent

Returns

void

---

handleDoubleClick()

handleDoubleClick(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:160

Parameters

e

MouseEvent

Returns

void

---

handleDown()

handleDown(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:181

Parameters

e

MouseEvent

Returns

void

---

handleEnter()

handleEnter(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:368

Parameters

e

MouseEvent

Returns

void

---

handleLeave()

handleLeave(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:364

Parameters

e

MouseEvent

Returns

void

---

handleMove()

handleMove(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:276

Parameters

e

MouseEvent

Returns

void

---

handleRightClick()

handleRightClick(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:150

Parameters

e

MouseEvent

Returns

void

---

handleUp()

handleUp(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:212

Parameters

e

MouseEvent

Returns

void

---

handleWheel()

handleWheel(e): void

Defined in: packages/sigma/src/core/captors/mouse.ts:372

Parameters

e

WheelEvent

Returns

void

---

kill()

kill(): void

Defined in: packages/sigma/src/core/captors/mouse.ts:112

Returns

void

Overrides

Captor.kill

---

listenerCount()

listenerCount<Event>(type): number

Defined in: packages/sigma/src/types.ts:205

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

Returns

number

Inherited from

Captor.listenerCount

---

listeners()

listeners<Event>(type): MouseCaptorEvents[Event][]

Defined in: packages/sigma/src/types.ts:204

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

Returns

MouseCaptorEvents[Event][]

Inherited from

Captor.listeners

---

off()

off<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:202

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.off

---

on()

on<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:197

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.on

---

once()

once<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:198

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.once

---

prependListener()

prependListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:199

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.prependListener

---

prependOnceListener()

prependOnceListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:200

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.prependOnceListener

---

rawListeners()

rawListeners<Event>(type): MouseCaptorEvents[Event][]

Defined in: packages/sigma/src/types.ts:206

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

Returns

MouseCaptorEvents[Event][]

Inherited from

Captor.rawListeners

---

removeAllListeners()

removeAllListeners<Event>(type?): this

Defined in: packages/sigma/src/types.ts:203

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type?

Event

Returns

this

Inherited from

Captor.removeAllListeners

---

removeListener()

removeListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:201

Type Parameters

Event

Event extends keyof MouseCaptorEvents

Parameters

type

Event

listener

MouseCaptorEvents[Event]

Returns

this

Inherited from

Captor.removeListener

---

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/sigma/src/types.ts:193

Parameters

n

number

Returns

this

Inherited from

Captor.setMaxListeners

---

setSettings()

setSettings(settings): void

Defined in: packages/sigma/src/core/captors/mouse.ts:438

Parameters

settings

MouseSettings

Returns

void