Class default

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

Hierarchy

default

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.

Type declaration

ATTRIBUTION: typeof Attribution
ZOOM: typeof ZoomControl

emitter

emitter: EventEmitter = ...

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.

Type declaration

GEOJSON: typeof GeoJsonAdapter
IMAGE: typeof ImageAdapter
OSM: typeof OsmAdapter
TILE: typeof TileAdapter
WMS: typeof WmsAdapter

`Optional` map

map?: Map

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

options

options: MapOptions<Map, any> = ...

`Static` controlAdapters

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

Type declaration

ATTRIBUTION: typeof Attribution
ZOOM: typeof ZoomControl

`Static` layerAdapters

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

Type declaration

GEOJSON: typeof GeoJsonAdapter
IMAGE: typeof ImageAdapter
OSM: typeof OsmAdapter
TILE: typeof TileAdapter
WMS: typeof WmsAdapter

Methods

addControl

addControl(control, position): undefined | Control
Parameters
- control: Control
- position: ControlPosition
Returns undefined | Control
Implementation of MapAdapter.addControl
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:307

create

create(options): void
Parameters
- options: MapOptions<Map, any>
Returns void
Implementation of MapAdapter.create
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:98

createButtonControl

createButtonControl(options): Control
Parameters
- options: ButtonControlOptions
Returns Control
Implementation of MapAdapter.createButtonControl
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:303

createControl

createControl(control, options): Control
Parameters
- control: MapControl<any>
- options: CreateControlOptions
Returns Control
Implementation of MapAdapter.createControl
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:299

destroy

destroy(): void
Returns void
Implementation of MapAdapter.destroy
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:134

fitBounds

fitBounds(e, options?): void
Parameters
- e: LngLatBoundsArray
- options: FitOptions = {}
Returns void
Implementation of MapAdapter.fitBounds
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:193

getBounds

getBounds(): undefined | LngLatBoundsArray
Returns undefined | LngLatBoundsArray
Implementation of MapAdapter.getBounds
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:219

getCenter

getCenter(): undefined | LngLatArray
Returns undefined | LngLatArray
Implementation of MapAdapter.getCenter
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:167

getContainer

getContainer(): undefined | HTMLElement
Returns undefined | HTMLElement
Implementation of MapAdapter.getContainer
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:140

getControlContainer

getControlContainer(): HTMLElement
Returns HTMLElement
Implementation of MapAdapter.getControlContainer
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:152

getZoom

getZoom(): undefined | number
Returns undefined | number
Implementation of MapAdapter.getZoom
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:187

hideLayer

hideLayer(layer): void
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.hideLayer
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:281

onMapClick

onMapClick(evt): void
Parameters
- evt: MapBrowserPointerEvent
Returns void
Implementation of MapAdapter.onMapClick
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:320

removeControl

removeControl(control): void
Parameters
- control: Control
Returns void
Implementation of MapAdapter.removeControl
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:314

removeLayer

removeLayer(layer): void
Remove layer from Map
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.removeLayer
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:259

setCenter

setCenter(lngLat): void
Parameters
- lngLat: LngLatArray
Returns void
Implementation of MapAdapter.setCenter
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:161

setLayerOpacity

setLayerOpacity(layer, val): void
Set the transparency of given layer.
Parameters
- layer: BaseLayer
- val: number
Returns void
Implementation of MapAdapter.setLayerOpacity
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:287

setLayerOrder

setLayerOrder(layer, order): void
Parameters
- layer: BaseLayer
- order: number
Returns void
Implementation of MapAdapter.setLayerOrder
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:293

setRotation

setRotation(angle): void
Parameters
- angle: number
Returns void
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:230

setView

setView(lngLat, zoom?): void
Parameters
- lngLat: LngLatArray
- Optional zoom: number
Returns void
Implementation of MapAdapter.setView
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:236
setView(options): void
Parameters
- options: ViewOptions
Returns void
Implementation of MapAdapter.setView
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:237

setZoom

setZoom(zoom): void
Parameters
- zoom: number
Returns void
Implementation of MapAdapter.setZoom
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:181

showLayer

showLayer(layer): void
Parameters
- layer: BaseLayer
Returns void
Implementation of MapAdapter.showLayer
- Defined in packages/ol-map-adapter/src/OlMapAdapter.ts:265

Class default

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

controlAdapters

Type declaration

ATTRIBUTION: typeof Attribution

ZOOM: typeof ZoomControl

emitter

layerAdapters

Type declaration

GEOJSON: typeof GeoJsonAdapter

IMAGE: typeof ImageAdapter

OSM: typeof OsmAdapter

TILE: typeof TileAdapter

WMS: typeof WmsAdapter

Optional map

options

Static controlAdapters

Type declaration

ATTRIBUTION: typeof Attribution

ZOOM: typeof ZoomControl

Static layerAdapters

Type declaration

GEOJSON: typeof GeoJsonAdapter

IMAGE: typeof ImageAdapter

OSM: typeof OsmAdapter

TILE: typeof TileAdapter

WMS: typeof WmsAdapter

Methods

addControl

Parameters

control: Control

position: ControlPosition

Returns undefined | Control

create

Parameters

options: MapOptions<Map, any>

Returns void

createButtonControl

Parameters

options: ButtonControlOptions

Returns Control

createControl

Parameters

control: MapControl<any>

options: CreateControlOptions

Returns Control

destroy

Returns void

fitBounds

Parameters

e: LngLatBoundsArray

options: FitOptions = {}

Returns void

getBounds

Returns undefined | LngLatBoundsArray

getCenter

Returns undefined | LngLatArray

getContainer

Returns undefined | HTMLElement

getControlContainer

Returns HTMLElement

getZoom

Returns undefined | number

hideLayer

Parameters

layer: BaseLayer

Returns void

onMapClick

Parameters

evt: MapBrowserPointerEvent

Returns void

`Optional` map

`Static` controlAdapters

`Static` layerAdapters

`Optional` zoom: number