Interface MapRegistry

Provides access to registered map instances.

Maps are identified by a unique id.

Inject an instance of this service by referencing the interface name "map.MapRegistry".

interface MapRegistry {
    "[DECLARE_SERVICE_INTERFACE]": "map.MapRegistry";
    createMapModel(mapId: string, options?: MapConfig): Promise<MapModel>;
    destroy(): void;
    expectMapModel(mapId: string): Promise<MapModel>;
    getMapModel(mapId: string): Promise<MapModel | undefined>;
    getMapModelByRawInstance(olMap: Map): MapModel | undefined;
}

Implements

Service

Index

Methods

createMapModel destroy expectMapModel getMapModel getMapModelByRawInstance

Properties

[DECLARE_SERVICE_INTERFACE]

Methods

createMapModel

createMapModel(mapId: string, options?: MapConfig): Promise<MapModel>
Creates a MapModel without the need to provide a MapConfigProvider. Throws an error if a map with the given id already exists or if the map config is invalid.
Parameters
- mapId: string
- Optionaloptions: MapConfig
Returns Promise<MapModel>
- Defined in MapRegistry.ts:166

destroy

destroy(): void
Destroys the component. Should clean up all resources used by the component.

Returns void
Implementation of Service.destroy
- Defined in MapRegistry.ts:100

expectMapModel

expectMapModel(mapId: string): Promise<MapModel>
Like getMapModel, but throws if no model exists for the given mapId.
Parameters
- mapId: string
Returns Promise<MapModel>
- Defined in MapRegistry.ts:154

getMapModel

getMapModel(mapId: string): Promise<MapModel | undefined>
Returns the map model associated with the given id. Returns undefined if there is no such model.
Parameters
- mapId: string
Returns Promise<MapModel | undefined>
- Defined in MapRegistry.ts:123

getMapModelByRawInstance

getMapModelByRawInstance(olMap: Map): MapModel | undefined
Given a raw OpenLayers map instance, returns the associated MapModel - or undefined if the map is unknown to this registry.

All OpenLayers maps created by this registry (e.g. via MapConfigProvider or createMapModel) have an associated map model.
Parameters
- olMap: Map
Returns MapModel | undefined
- Defined in MapRegistry.ts:185

Properties

[DECLARE_SERVICE_INTERFACE]

"[DECLARE_SERVICE_INTERFACE]": "map.MapRegistry"