Class default

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

Implements

MapAdapter<Map, any, Control>

Constructors

constructor

new default(): default
Returns default

Properties

controlAdapters

controlAdapters: { ATTRIBUTION: typeof AttributionControl; ZOOM: typeof Zoom } = LeafletMapAdapter.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: { [name: string]: Type<LayerAdapter<Map, any, any>> } = LeafletMapAdapter.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 AttributionControl; ZOOM: typeof Zoom } = ...

`Static`layerAdapters

layerAdapters: { [name: string]: Type<LayerAdapter<Map, any, any>> } = ...

`Static`Map

Map: typeof Map = Map

Methods

addControl

addControl(
control: Control,
position: string,
): undefined | Control<ControlOptions>
Parameters
- control: Control
- position: string
Returns undefined | Control<ControlOptions>
Implementation of MapAdapter.addControl
- Defined in LeafletMapAdapter.ts:263

create

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

createButtonControl

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

createControl

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

destroy

destroy(): void
Returns void
Implementation of MapAdapter.destroy
- Defined in LeafletMapAdapter.ts:123

fitBounds

fitBounds(bounds: LngLatBoundsArray, options?: FitOptions): void
Parameters
- bounds: LngLatBoundsArray
- options: FitOptions = {}
Returns void
Implementation of MapAdapter.fitBounds
- Defined in LeafletMapAdapter.ts:233

getBounds

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

getCenter

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

getContainer

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

getControlContainer

getControlContainer(): HTMLElement
Returns HTMLElement
Implementation of MapAdapter.getControlContainer
- Defined in LeafletMapAdapter.ts:134

getLayerAdapter

getLayerAdapter(name: string): Type<LayerAdapter<Map, any, any>>
Parameters
- name: string
Returns Type<LayerAdapter<Map, any, any>>
- Defined in LeafletMapAdapter.ts:251

getZoom

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

hideLayer

hideLayer(layer: Layer): void
Parameters
- layer: Layer
Returns void
Implementation of MapAdapter.hideLayer
- Defined in LeafletMapAdapter.ts:287

locate

locate(opt: LocateOptions, events?: LocationEvents): Locate
Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed). Note that, if your page doesn't use HTTPS, this method will fail in modern browsers (Chrome 50 and newer) See Locate options for more details.
Parameters
- opt: LocateOptions
- Optionalevents: LocationEvents
Returns Locate
Implementation of MapAdapter.locate
- Defined in LeafletMapAdapter.ts:311

onMapClick

onMapClick(evt: LeafletMouseEvent): void
Parameters
- evt: LeafletMouseEvent
Returns void
Implementation of MapAdapter.onMapClick
- Defined in LeafletMapAdapter.ts:305

removeControl

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

removeLayer

removeLayer(layer: Layer): void
Remove layer from Map
Parameters
- layer: Layer
Returns void
Implementation of MapAdapter.removeLayer
- Defined in LeafletMapAdapter.ts:277

setCenter

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

setCursor

setCursor(cursor: string): void
Parameters
- cursor: string
Returns void
Implementation of MapAdapter.setCursor
- Defined in LeafletMapAdapter.ts:142

setLayerOpacity

setLayerOpacity(layer: Layer | GridLayer, value: number): void
Set the transparency of given layer.
Parameters
- layer: Layer | GridLayer
- value: number
Returns void
Implementation of MapAdapter.setLayerOpacity
- Defined in LeafletMapAdapter.ts:291

setLayerOrder

setLayerOrder(
    layer: Layer,
    order: number,
    layers: { [x: string]: LayerAdapter },
): void
Parameters
- layer: Layer
- order: number
- layers: { [x: string]: LayerAdapter }
Returns void
Implementation of MapAdapter.setLayerOrder
- Defined in LeafletMapAdapter.ts:297

setView

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

setZoom

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

showLayer

showLayer(layer: Layer): void
Parameters
- layer: Layer
Returns void
Implementation of MapAdapter.showLayer
- Defined in LeafletMapAdapter.ts:281

Class default

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

controlAdapters

emitter

layerAdapters

Optionalmap

options

StaticcontrolAdapters

StaticlayerAdapters

StaticMap

Methods

addControl

Parameters

Returns undefined | Control<ControlOptions>

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

getLayerAdapter

Parameters

Returns Type<LayerAdapter<Map, any, any>>

getZoom

Returns undefined | number

hideLayer

Parameters

Returns void

locate

Parameters

Returns Locate

onMapClick

Parameters

Returns void

removeControl

Parameters

Returns void

removeLayer

Parameters

Returns void

setCenter

Parameters

Returns void

setCursor

Parameters

Returns void

setLayerOpacity

Parameters

Returns void

setLayerOrder

Parameters

Returns void

setView

Parameters

Returns void

Parameters

`Optional`map

`Static`controlAdapters

`Static`layerAdapters

`Static`Map