LoadingManager

Defined in: packages/core/src/ui/loading-manager.ts:110

Manages loading states and optional UI overlays.

Remarks

Provides centralized loading state management with optional visual feedback. Emits events for all loading state changes, allowing external UI integration. Can optionally show built-in loading overlays with spinners and error messages.

Features:

• Event-driven state changes
• Optional loading UI overlays
• Customizable messages and spinner styles
• Minimum display time to prevent flashing
• Retry support with visual feedback
• Multiple concurrent loading operations

Example

const manager = new LoadingManager({
  showUI: true,
  minDisplayTime: 300
});

// Listen to loading events
manager.on('loading:start', ({ layerId }) => {
  console.log(`Loading ${layerId}...`);
});

// Show loading state
const container = document.getElementById('map-container');
manager.showLoading('vehicles', container, 'Loading vehicle data...');

// Hide when complete
manager.hideLoading('vehicles', { fromCache: false });

// Show error with retry
manager.showError('vehicles', container, new Error('Failed'), () => {
  // Retry logic
});

Extends

• EventEmitter<LoadingEvents>

Constructors

Constructor

new LoadingManager(config?): LoadingManager

Defined in: packages/core/src/ui/loading-manager.ts:143

Create a new LoadingManager.

Parameters

Parameter	Type	Description
config?	Partial<LoadingConfig>	Loading manager configuration

Returns

LoadingManager

Example

const manager = new LoadingManager({
  showUI: true,
  messages: {
    loading: 'Fetching data...',
    error: 'Could not load data'
  },
  spinnerStyle: 'dots',
  minDisplayTime: 500
});

Overrides

EventEmitter.constructor

Methods

clearAll()

clearAll(): void

Defined in: packages/core/src/ui/loading-manager.ts:376

Clear all loading states and UI.

Returns

void

Example

manager.clearAll();

---

destroy()

destroy(): void

Defined in: packages/core/src/ui/loading-manager.ts:396

Clean up all resources.

Returns

void

Example

manager.destroy();

---

eventNames()

eventNames(): keyof LoadingEvents[]

Defined in: packages/core/src/utils/event-emitter.ts:211

Get all event names that have registered handlers

Returns

keyof LoadingEvents[]

Array of event names

Example

const events = emitter.eventNames();
console.log('Events with handlers:', events);

Inherited from

EventEmitter.eventNames

---

getState()

getState(layerId): LoadingState | null

Defined in: packages/core/src/ui/loading-manager.ts:346

Get loading state for a layer.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier

Returns

LoadingState | null

Loading state or null if not found

Example

const state = manager.getState('earthquakes');
if (state?.isLoading) {
  console.log('Still loading...');
}

---

hasListeners()

hasListeners<K>(event): boolean

Defined in: packages/core/src/utils/event-emitter.ts:228

Check if an event has any registered handlers

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event	K	Event name

Returns

boolean

True if the event has at least one handler

Example

if (emitter.hasListeners('message')) {
  emitter.emit('message', { text: 'Hello' });
}

Inherited from

EventEmitter.hasListeners

---

hideLoading()

hideLoading(layerId, result?): void

Defined in: packages/core/src/ui/loading-manager.ts:211

Hide loading state for a layer.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier
result?	{ fromCache: boolean; }	Optional result information
result.fromCache?	boolean	-

Returns

void

Example

manager.hideLoading('earthquakes', { fromCache: true });

---

isLoading()

isLoading(layerId): boolean

Defined in: packages/core/src/ui/loading-manager.ts:364

Check if a layer is currently loading.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier

Returns

boolean

True if loading, false otherwise

Example

if (manager.isLoading('earthquakes')) {
  console.log('Loading in progress');
}

---

listenerCount()

listenerCount<K>(event): number

Defined in: packages/core/src/utils/event-emitter.ts:195

Get the number of handlers registered for an event

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event	K	Event name

Returns

number

Number of registered handlers

Example

const count = emitter.listenerCount('message');
console.log(`${count} handlers registered`);

Inherited from

EventEmitter.listenerCount

---

off()

off<K>(event, handler): void

Defined in: packages/core/src/utils/event-emitter.ts:120

Remove an event handler

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event	K	Event name
handler	EventHandler<LoadingEvents[K]>	Handler function to remove

Returns

void

Example

const handler = (data) => console.log(data);
emitter.on('message', handler);
emitter.off('message', handler);

Inherited from

EventEmitter.off

---

on()

on<K>(event, handler): () => void

Defined in: packages/core/src/utils/event-emitter.ts:65

Register an event handler

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event	K	Event name to listen for
handler	EventHandler<LoadingEvents[K]>	Callback function to invoke when event is emitted

Returns

Unsubscribe function that removes this specific handler

() => void

Example

const unsubscribe = emitter.on('message', (data) => {
  console.log(data.text);
});

// Later, to unsubscribe:
unsubscribe();

Inherited from

EventEmitter.on

---

once()

once<K>(event, handler): void

Defined in: packages/core/src/utils/event-emitter.ts:95

Register a one-time event handler

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event	K	Event name to listen for
handler	EventHandler<LoadingEvents[K]>	Callback function to invoke once

Returns

void

Remarks

The handler will be automatically removed after being invoked once.

Example

emitter.once('connect', () => {
  console.log('Connected!');
});

Inherited from

EventEmitter.once

---

removeAllListeners()

removeAllListeners<K>(event?): void

Defined in: packages/core/src/utils/event-emitter.ts:175

Remove all handlers for an event, or all handlers for all events

Type Parameters

Type Parameter
K extends keyof LoadingEvents

Parameters

Parameter	Type	Description
event?	K	Optional event name. If omitted, removes all handlers for all events.

Returns

void

Example

// Remove all handlers for 'message' event
emitter.removeAllListeners('message');

// Remove all handlers for all events
emitter.removeAllListeners();

Inherited from

EventEmitter.removeAllListeners

---

showError()

showError(layerId, container, error, onRetry?): void

Defined in: packages/core/src/ui/loading-manager.ts:260

Show error state for a layer.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier
container	HTMLElement	Container element for UI overlay
error	Error	Error that occurred
onRetry?	() => void	Optional retry callback

Returns

void

Example

manager.showError('earthquakes', container, error, () => {
  // Retry loading
  fetchData();
});

---

showLoading()

showLoading(layerId, container, message?): void

Defined in: packages/core/src/ui/loading-manager.ts:169

Show loading state for a layer.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier
container	HTMLElement	Container element for UI overlay
message?	string	Custom loading message

Returns

void

Example

const container = document.getElementById('map');
manager.showLoading('earthquakes', container, 'Loading earthquake data...');

---

showRetrying()

showRetrying(layerId, attempt, delay): void

Defined in: packages/core/src/ui/loading-manager.ts:316

Show retrying state for a layer.

Parameters

Parameter	Type	Description
layerId	string	Layer identifier
attempt	number	Current retry attempt number
delay	number	Delay before retry in milliseconds

Returns

void

Example

manager.showRetrying('earthquakes', 2, 2000);