Class default

Parameters and methods that control the behavior of the map and the layers on it.

Implements

MapAdapter<Map, Layer>

Constructors

constructor

new default(): default
Returns default

Properties

controlAdapters

controlAdapters: { ATTRIBUTION: typeof Attribution; ZOOM: typeof ZoomControl } = OlMapAdapter.controlAdapters

Named map controls specific for each framework.

emitter

emitter: EventEmitter<DefaultEventMap> = ...

An instance of the EventEmitter class for listen and emit events

layerAdapters

layerAdapters: {
    GEOJSON: typeof GeoJsonAdapter;
    IMAGE: typeof ImageAdapter;
    OSM: typeof OsmAdapter;
    TILE: typeof TileAdapter;
    WMS: typeof WmsAdapter;
} = OlMapAdapter.layerAdapters

Named adapters for map layers through a generic interface.

`Optional`map

map?: Map

Original map object of GIS framework (Leaflet.Map, Openlayers.Map, MaplibreGL.Map or other)

options

options: MapOptions<Map> = ...

`Static`controlAdapters

controlAdapters: { ATTRIBUTION: typeof Attribution; ZOOM: typeof ZoomControl } = ...

`Static`layerAdapters

layerAdapters: {
    GEOJSON: typeof GeoJsonAdapter;
    IMAGE: typeof ImageAdapter;
    OSM: typeof OsmAdapter;
    TILE: typeof TileAdapter;
    WMS: typeof WmsAdapter;
} = ...

Methods

addControl

addControl(control: Control, position: ControlPosition): undefined | Control
Parameters
- control: Control
- position: ControlPosition
Returns undefined | Control
Implementation of MapAdapter.addControl
- Defined in OlMapAdapter.ts:305

create

create(options: MapOptions<Map>): void
Parameters
- options: MapOptions<Map>
Returns void
Implementation of MapAdapter.create
- Defined in OlMapAdapter.ts:96

createButtonControl

createButtonControl(options: ButtonControlOptions): Control
Parameters
- options: ButtonControlOptions
Returns Control
Implementation of MapAdapter.createButtonControl
- Defined in OlMapAdapter.ts:301

createControl

createControl(control: MapControl, options: CreateControlOptions): Control
Parameters
- control: MapControl
- options: CreateControlOptions
Returns Control
Implementation of MapAdapter.createControl
- Defined in OlMapAdapter.ts:297

destroy

destroy(): void
Returns void
Implementation of MapAdapter.destroy
- Defined in OlMapAdapter.ts:132

fitBounds

fitBounds(e: LngLatBoundsArray, options?: FitOptions): void
Parameters
- e: LngLatBoundsArray
- options: FitOptions = {}
Returns void
Implementation of MapAdapter.fitBounds
- Defined in OlMapAdapter.ts:191

getBounds

getBounds(): undefined | LngLatBoundsArray
Returns undefined | LngLatBoundsArray
Implementation of MapAdapter.getBounds
- Defined in OlMapAdapter.ts:217

getCenter

getCenter(): undefined | LngLatArray
Returns undefined | LngLatArray
Implementation of MapAdapter.getCenter
- Defined in OlMapAdapter.ts:165

getContainer

getContainer(): undefined | HTMLElement
Returns undefined | HTMLElement
Implementation of MapAdapter.getContainer
- Defined in OlMapAdapter.ts:138

getControlContainer

getControlContainer(): HTMLElement
Returns HTMLElement
Implementation of MapAdapter.getControlContainer
- Defined in OlMapAdapter.ts:150

getZoom

getZoom(): undefined | number
Returns undefined | number
Implementation of MapAdapter.getZoom
- Defined in OlMapAdapter.ts:185

hideLayer

hideLayer(layer: BaseLayer): void
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.hideLayer
- Defined in OlMapAdapter.ts:279

onMapClick

onMapClick(evt: MapBrowserPointerEvent, type?: "click" | "dblclick"): void
Parameters
- evt: MapBrowserPointerEvent
- type: "click" | "dblclick" = 'click'
Returns void
Implementation of MapAdapter.onMapClick
- Defined in OlMapAdapter.ts:318

removeControl

removeControl(control: Control): void
Parameters
- control: Control
Returns void
Implementation of MapAdapter.removeControl
- Defined in OlMapAdapter.ts:312

removeLayer

removeLayer(layer: BaseLayer): void
Remove layer from Map
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.removeLayer
- Defined in OlMapAdapter.ts:257

setCenter

setCenter(lngLat: LngLatArray): void
Parameters
- lngLat: LngLatArray
Returns void
Implementation of MapAdapter.setCenter
- Defined in OlMapAdapter.ts:159

setLayerOpacity

setLayerOpacity(layer: BaseLayer, val: number): void
Set the transparency of given layer.
Parameters
- layer: BaseLayer
- val: number
Returns void
Implementation of MapAdapter.setLayerOpacity
- Defined in OlMapAdapter.ts:285

setLayerOrder

setLayerOrder(layer: BaseLayer, order: number): void
Parameters
- layer: BaseLayer
- order: number
Returns void
Implementation of MapAdapter.setLayerOrder
- Defined in OlMapAdapter.ts:291

setRotation

setRotation(angle: number): void
Parameters
- angle: number
Returns void
- Defined in OlMapAdapter.ts:228

setView

setView(lngLat: LngLatArray, zoom?: number): void
Parameters
- lngLat: LngLatArray
- Optionalzoom: number
Returns void
Implementation of MapAdapter.setView
- Defined in OlMapAdapter.ts:234
setView(options: ViewOptions): void
Parameters
- options: ViewOptions
Returns void
Implementation of MapAdapter.setView
- Defined in OlMapAdapter.ts:235

setZoom

setZoom(zoom: number): void
Parameters
- zoom: number
Returns void
Implementation of MapAdapter.setZoom
- Defined in OlMapAdapter.ts:179

showLayer

showLayer(layer: BaseLayer): void
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.showLayer
- Defined in OlMapAdapter.ts:263

Class default

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

controlAdapters

emitter

layerAdapters

Optionalmap

options

StaticcontrolAdapters

StaticlayerAdapters

Methods

addControl

Parameters

Returns undefined | Control

create

Parameters

Returns void

createButtonControl

Parameters

Returns Control

createControl

Parameters

Returns Control

destroy

Returns void

fitBounds

Parameters

Returns void

getBounds

Returns undefined | LngLatBoundsArray

getCenter

Returns undefined | LngLatArray

getContainer

Returns undefined | HTMLElement

getControlContainer

Returns HTMLElement

getZoom

Returns undefined | number

hideLayer

Parameters

Returns void

onMapClick

Parameters

Returns void

removeControl

Parameters

Returns void

removeLayer

Parameters

Returns void

setCenter

Parameters

Returns void

setLayerOpacity

Parameters

Returns void

setLayerOrder

Parameters

Returns void

setRotation

Parameters

Returns void

setView

Parameters

Returns void

Parameters

Returns void

setZoom

Parameters

Returns void

showLayer

Parameters

Returns void

`Optional`map

`Static`controlAdapters

`Static`layerAdapters