Class VertexListeners

Classdesc

An event listeners wrapper. This is just a set of three listener queues (drag, dragStart, dragEnd) and their respective firing functions.

Constructors

constructor

new VertexListeners(vertex): VertexListeners
The constructor.
Parameters
- vertex: Vertex
  The vertex to use these listeners on (just a backward reference).
Returns VertexListeners
Name
VertexListeners
- Defined in src/ts/VertexListeners.ts:49

Properties

`Private` click

click: VertListener[]

`Private` drag

drag: VertListener[]

`Private` dragEnd

dragEnd: VertListener[]

`Private` dragStart

dragStart: VertListener[]

`Private` vertex

vertex: Vertex

Methods

addClickListener

addClickListener(listener): VertexListeners
Add a click listener.
Parameters
- listener: VertListener
  The click listener to add (a callback).
Returns VertexListeners
this (for chaining)

Method
addClickListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:66

addDragEndListener

addDragEndListener(listener): VertexListeners
Add a dragEnd listener.
Parameters
- listener: ((e) => void)
  The drag-end listener to add (a callback).
  - - (e): void
    - Parameters
      e: VertEvent
      Returns void
Returns VertexListeners
this (for chaining)

Method
addDragListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:170

addDragListener

addDragListener(listener): VertexListeners
Add a drag listener.
Parameters
- listener: VertListener
  The drag listener to add (a callback).
Returns VertexListeners
this (for chaining)

Method
addDragListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:104

addDragStartListener

addDragStartListener(listener): VertexListeners
Add a dragStart listener.
Parameters
- listener: VertListener
  The drag-start listener to add (a callback).
Returns VertexListeners
this (for chaining)

Method
addDragListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:137

fireClickEvent

fireClickEvent(e): void
Fire a click event with the given event instance to all installed click listeners.
Parameters
- e: XMouseEvent | VertEvent
  The click event itself to be fired to all installed drag listeners.
Returns void
Method
fireClickEvent

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:206

fireDragEndEvent

fireDragEndEvent(e): void
Fire a dragEnd event with the given event instance to all installed drag-end listeners.
Parameters
- e: XMouseEvent | VertEvent
  The drag-end event itself to be fired to all installed dragEnd listeners.
Returns void
Method
fireDragEndEvent

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:248

fireDragEvent

fireDragEvent(e): void
Fire a drag event with the given event instance to all installed drag listeners.
Parameters
- e: XMouseEvent | VertEvent
  The drag event itself to be fired to all installed drag listeners.
Returns void
Method
fireDragEvent

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:220

fireDragStartEvent

fireDragStartEvent(e): void
Fire a dragStart event with the given event instance to all installed drag-start listeners.
Parameters
- e: XMouseEvent | VertEvent
  The drag-start event itself to be fired to all installed dragStart listeners.
Returns void
Method
fireDragStartEvent

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:234

removeAllListeners

removeAllListeners(): void
Removes all listeners from this listeners object.

Returns void
- Defined in src/ts/VertexListeners.ts:255

removeClickListener

removeClickListener(listener): VertexListeners
Remove a drag listener.
Parameters
- listener: VertListener
  The drag listener to remove (a callback).
Returns VertexListeners
this (for chaining)

Method
removeDragListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:85

removeDragEndListener

removeDragEndListener(listener): VertexListeners
Remove a drag listener.
Parameters
- listener: ((e) => void)
  The drag listener to remove (a callback).
  - - (e): void
    - Parameters
      e: VertEvent
      Returns void
Returns VertexListeners
this (for chaining)

Method
removeDragEndListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:190

removeDragListener

removeDragListener(listener): VertexListeners
Remove a drag listener.
Parameters
- listener: VertListener
  The drag listener to remove (a callback).
Returns VertexListeners
this (for chaining)

Method
removeDragListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:123

removeDragStartListener

removeDragStartListener(listener): VertexListeners
Remove a dragStart listener.
Parameters
- listener: VertListener
  The drag listener to remove (a callback).
Returns VertexListeners
this (for chaining)

Method
addDragStartListener

Instance
Memberof
VertexListeners
- Defined in src/ts/VertexListeners.ts:156

`Static` `Private` _addListener

_addListener(listeners, newListener): boolean
Private
Parameters
- listeners: ((e) => void)[]
- newListener: ((e) => void)
  - - (e): void
    - Parameters
      e: VertEvent
      Returns void
Returns boolean
- Defined in src/ts/VertexListeners.ts:277

`Static` `Private` _fireEvent

_fireEvent(_self, listeners, e): void
Private
Parameters
- _self: VertexListeners
- listeners: ((e) => void)[]
- e: XMouseEvent | VertEvent
Returns void
- Defined in src/ts/VertexListeners.ts:265

`Static` `Private` _removeListener

_removeListener(listeners, oldListener): ((e) => void)[]
Private
Parameters
- listeners: ((e) => void)[]
- oldListener: ((e) => void)
  - - (e): void
    - Parameters
      e: VertEvent
      Returns void
Returns ((e) => void)[]
- Defined in src/ts/VertexListeners.ts:288

Generated using TypeDoc