Class AEventDispatcher

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

Hierarchy (view full)

AEventDispatcher

Implements

IEventHandler

Index

Constructors

Methods

createEventList fire forward listenersChanged on unforward

Constructors

constructor

new AEventDispatcher(): AEventDispatcher
Returns AEventDispatcher
- Defined in internal/AEventDispatcher.ts:53

Methods

`Protected` createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns string[]
by default no events
- Defined in internal/AEventDispatcher.ts:97

`Protected` fire

fire(type, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
- Defined in internal/AEventDispatcher.ts:101

`Protected` forward

forward(from, ...types): void
forwards one or more events from a given dispatcher to the current one i.e. when one of the given events is fired in 'from' it will be forwarded to all my listeners
Parameters
- from: IEventHandler
  the event dispatcher to forward from
- Rest ...types: string[]
  the event types to forward
Returns void
- Defined in internal/AEventDispatcher.ts:137

`Protected` listenersChanged

listenersChanged(_type, _active): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  event type
- _active: boolean
  registered or de registered
Returns void
- Defined in internal/AEventDispatcher.ts:89

on

on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of IEventHandler.on
- Defined in internal/AEventDispatcher.ts:65

`Protected` unforward

unforward(from, ...types): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- Rest ...types: string[]
  event types to forward
Returns void
- Defined in internal/AEventDispatcher.ts:146