On this page

Class Evented<E>`Abstract`

Abstract class that provides event handling capabilities.

Type Parameters

E extends Event<string>

Hierarchy (View Summary)

Evented
- SplatModel
- Map

Index

Constructors

constructor

new Evented<E extends Event<string>>(): Evented<E>
Type Parameters
- E extends Event<string>
Returns Evented<E>

Properties

`Protected`loaded

loaded: boolean = false

Methods

off

off<EventType extends string>(
eventType: EventType,
handler: (event: Extract<E, { type: EventType }>) => void,
): void
Removes a listener for a specific event type.
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
  The type of event to remove the listener from.
- handler: (event: Extract<E, { type: EventType }>) => void
  The listener function to remove.
Returns void
- Defined in Evented.ts:64

on

on<EventType extends string>(
eventType: EventType,
handler: (event: Extract<E, { type: EventType }>) => void,
): void
Adds a listener for a specific event type.
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
  The type of event to listen for.
- handler: (event: Extract<E, { type: EventType }>) => void
  The function to call when the event is fired.
Returns void
Example
```
map.on('load', () => {
  console.log('Map loaded!');
});
```
- Defined in Evented.ts:32

once

once<EventType extends string>(
eventType: EventType,
handler: (event: Extract<E, { type: EventType }>) => void,
): void
Adds a listener for a specific event type that will be called only once.
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
  The type of event to listen for.
- handler: (event: Extract<E, { type: EventType }>) => void
  The function to call when the event is fired.
Returns void
Example
```
map.once('splatmodel:load', () => {
  console.log('First SplatModel loaded!');
});
```
- Defined in Evented.ts:51

Class Evented<E>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns Evented<E>

Properties

Protectedloaded

Methods

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Example

once

Type Parameters

Parameters

Returns void

Example

Was this helpful?

Class Evented<E>`Abstract`

`Protected`loaded