Class Key

Hierarchy

Dispatcher
- Key

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Key(): Key

- Defined in plottable.d.ts:4678
This constructor should not be invoked directly.

constructor

Returns Key

Properties

Protected _eventToProcessingFunction

_eventToProcessingFunction: object

Type declaration

[eventName: string]: function
- - (e: Event): any
  - Parameters
    - e: Event
    Returns any

Static Private _DISPATCHER_KEY

_DISPATCHER_KEY: any

Static Private _KEYDOWN_EVENT_NAME

_KEYDOWN_EVENT_NAME: any

Static Private _KEYUP_EVENT_NAME

_KEYUP_EVENT_NAME: any

Methods

Protected _addCallbackForEvent

_addCallbackForEvent(eventName: string, callback: Function): void

Inherited from Dispatcher._addCallbackForEvent
- Defined in plottable.d.ts:4459
Parameters
- eventName: string
- callback: Function
Returns void

Protected _callCallbacksForEvent

_callCallbacksForEvent(eventName: string, ...args: any[]): void

Inherited from Dispatcher._callCallbacksForEvent
- Defined in plottable.d.ts:4461
Parameters
- eventName: string
- Rest ...args: any[]
Returns void

Private _processKeydown

_processKeydown(event: any): any

- Defined in plottable.d.ts:4685
Parameters
- event: any
Returns any

Private _processKeyup

_processKeyup(event: any): any

- Defined in plottable.d.ts:4686
Parameters
- event: any
Returns any

Protected _removeCallbackForEvent

_removeCallbackForEvent(eventName: string, callback: Function): void

Inherited from Dispatcher._removeCallbackForEvent
- Defined in plottable.d.ts:4460
Parameters
- eventName: string
- callback: Function
Returns void

offKeyDown

offKeyDown(callback: KeyCallback)

- Defined in plottable.d.ts:4700
Removes the callback to be called whenever a key is pressed.

Parameters
- callback: KeyCallback

offKeyUp

offKeyUp(callback: KeyCallback)

- Defined in plottable.d.ts:4713
Removes the callback to be called whenever a key is released.

Parameters
- callback: KeyCallback

onKeyDown

onKeyDown(callback: KeyCallback)

- Defined in plottable.d.ts:4693
Registers a callback to be called whenever a key is pressed.

Parameters
- callback: KeyCallback

onKeyUp

onKeyUp(callback: KeyCallback)

- Defined in plottable.d.ts:4706
Registers a callback to be called whenever a key is released.

Parameters
- callback: KeyCallback

Static getDispatcher

getDispatcher(): Key

- Defined in plottable.d.ts:4678
Gets a Key Dispatcher. If one already exists it will be returned; otherwise, a new one will be created.

Returns Key

Generated using TypeDoc