Class EventDispatcher

JavaScript events for custom objects. Stores all listeners to allow removing all listeners for housekeeping.

Will be replaced by THREE.EventDispatcher once https://github.com/mrdoob/three.js/pull/19844 is released.

Hierarchy

EventDispatcher
- MapView

Index

Constructors

Accessors

Methods

addEventListener dispatchEvent dispose hasEventListener listeners removeAllEventListeners removeEventListener

Constructors

constructor

new EventDispatcher(): EventDispatcher
Returns EventDispatcher

Accessors

eventTypes

get eventTypes(): string[]
Retrieve the registered event types.

Returns string[]
Array of event types.
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:101

Methods

addEventListener

addEventListener(type, listener): void
Add a new event listener to the event type.
Parameters
- type: string
  
  The type of event to listen to.
- listener: ((event) => void)
  
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      
      event: Event
      
      Returns void
Returns void
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:50

dispatchEvent

dispatchEvent(event): void
Dispatch the event to the registered listeners.
Parameters
- event: Event
  
  The event to dispatch.
Returns void
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:120

dispose

dispose(): void
Destroy this EventDispatcher instance.

Unregister all event handlers used. This is method should be called when you stop using EventDispatcher.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:26

hasEventListener

hasEventListener(type, listener?): boolean
Checks if listener is added to an event type.
Parameters
- type: string
  
  The type of event to listen to.
- Optional listener: ((event) => void)
  
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      
      event: Event
      
      Returns void
Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:36

listeners

listeners(type): undefined | ((event) => void)[]
Retrieve the registered listeners to the specified event.
Parameters
- type: string
  
  The type of event to listen to.
Returns undefined | ((event) => void)[]
Array of event listeners.
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:111

removeAllEventListeners

removeAllEventListeners(): void
Remove all event listeners for housekeeping.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:89

removeEventListener

removeEventListener(type, listener?): void
Remove the listener from the event type.
Parameters
- type: string
  
  The type of event to listen to.
- Optional listener: any
  
  The function that gets called when the event is fired. If the value is undefined, all listeners will be removed.
Returns void
- Defined in @xyzmaps/harp-mapview/lib/EventDispatcher.ts:68

Generated using TypeDoc