Skip to main content

Type Alias: MapSystemContext<Modules, Layers, Controllers, Context>

MapSystemContext<Modules, Layers, Controllers, Context> = object & Readonly<Context>

Defined in: src/sdk/components/mapsystem/MapSystemContext.ts:13

A context which holds data related to a compiled MapSystem map.

Type declaration

bus

readonly bus: EventBus

The event bus.

deadZone

readonly deadZone: Subscribable<ReadonlyFloat64Array>

A subscribable which provides the dead zone of this context's map.

model

readonly model: MapModel<Modules>

This context's map model.

projectedSize

readonly projectedSize: Subscribable<ReadonlyFloat64Array>

A subscribable which provides the projected size of this context's map.

projection

readonly projection: MapProjection

This context's map projection.

getController()

getController<K>(key): Controllers[K]

Retrieves a controller from this context.

Type Parameters

Type Parameter
K extends string

Parameters

ParameterTypeDescription
keyKThe key of the controller to retrieve.

Returns

Controllers[K]

The controller in this context with the specified key.

getLayer()

getLayer<K>(key): Layers[K]

Retrieves a layer from this context.

Type Parameters

Type Parameter
K extends string

Parameters

ParameterTypeDescription
keyKThe key of the layer to retrieve.

Returns

Layers[K]

The layer in this context with the specified key.

Type Parameters

Type ParameterDefault type
Modules extends ModuleRecordEmptyRecord
Layers extends LayerRecordEmptyRecord
Controllers extends ControllerRecordEmptyRecord
Context extends ContextRecordEmptyRecord