Class default

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

Hierarchy

default

Implements

MapAdapter<Map, TLayer, IControl>

Constructors

constructor

new default(): default
Returns default
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:101

Properties

controlAdapters

controlAdapters: {
[name: string]: any;
} = MapboxglMapAdapter.controlAdapters

Named map controls specific for each framework.

Type declaration

[name: string]: any

emitter

emitter: EventEmitter = ...

An instance of the EventEmitter class for listen and emit events

isLoaded

isLoaded: boolean = false

State of readiness of the card for use.

Default Value

true

layerAdapters

layerAdapters: {
    GEOJSON: typeof GeoJsonAdapter;
    MVT: typeof MvtAdapter;
    OSM: typeof OsmAdapter;
    TILE: typeof TileAdapter;
    WMS: typeof WmsAdapter;
} = MapboxglMapAdapter.layerAdapters

Named adapters for map layers through a generic interface.

Type declaration

GEOJSON: typeof GeoJsonAdapter
MVT: typeof MvtAdapter
OSM: typeof OsmAdapter
TILE: typeof TileAdapter
WMS: typeof WmsAdapter

map

map: Map

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

options

options: MapboxglMapAdapterOptions = {}

`Static` controlAdapters

controlAdapters: {
[name: string]: any;
} = ...

Type declaration

[name: string]: any

`Static` layerAdapters

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

Type declaration

GEOJSON: typeof GeoJsonAdapter
MVT: typeof MvtAdapter
OSM: typeof OsmAdapter
TILE: typeof TileAdapter
WMS: typeof WmsAdapter

Methods

addControl

addControl(control, position): undefined | IControl
Parameters
- control: IControl
- position: ControlPosition
Returns undefined | IControl
Implementation of MapAdapter.addControl
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:380

create

create(options): Promise<unknown>
Parameters
- options: MapboxglMapAdapterOptions
Returns Promise<unknown>
Implementation of MapAdapter.create
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:105

createButtonControl

createButtonControl(options): IControl
Parameters
- options: ButtonControlOptions
Returns IControl
Implementation of MapAdapter.createButtonControl
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:376

createControl

createControl(control, options?): IControl
Parameters
- control: MapControl<any>
- Optional options: CreateControlOptions
Returns IControl
Implementation of MapAdapter.createControl
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:372

destroy

destroy(): void
Returns void
Implementation of MapAdapter.destroy
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:207

fitBounds

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

getBounds

getBounds(): undefined | LngLatBoundsArray
Returns undefined | LngLatBoundsArray
Implementation of MapAdapter.getBounds
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:290

getCenter

getCenter(): undefined | LngLatArray
Returns undefined | LngLatArray
Implementation of MapAdapter.getCenter
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:267

getContainer

getContainer(): undefined | HTMLElement
Returns undefined | HTMLElement
Implementation of MapAdapter.getContainer
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:213

getZoom

getZoom(): undefined | number
Returns undefined | number
Implementation of MapAdapter.getZoom
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:280

hideLayer

hideLayer(layerIds): void
Parameters
- layerIds: string[]
Returns void
Implementation of MapAdapter.hideLayer
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:325

onMapClick

onMapClick(evt): void
Parameters
- evt: MapMouseEvent
Returns void
Implementation of MapAdapter.onMapClick
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:396

removeControl

removeControl(control): void
Parameters
- control: IControl
Returns void
Implementation of MapAdapter.removeControl
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:390

removeLayer

removeLayer(layerIds): void
Remove layer from Map
Parameters
- layerIds: string[]
Returns void
Implementation of MapAdapter.removeLayer
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:332

setCenter

setCenter(latLng): void
Parameters
- latLng: LngLatArray
Returns void
Implementation of MapAdapter.setCenter
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:261

setLayerOpacity

setLayerOpacity(layerIds, opacity): void
Set the transparency of given layer.
Parameters
- layerIds: string[]
- opacity: number
Returns void
Implementation of MapAdapter.setLayerOpacity
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:353

setLayerOrder

setLayerOrder(layerIds, order, layers): void
Parameters
- layerIds: string[]
- order: number
- layers: {
  [x: string]: TLayerAdapter;
  }
  - [x: string]: TLayerAdapter
Returns void
Implementation of MapAdapter.setLayerOrder
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:345

setRotation

setRotation(angle): void
Parameters
- angle: number
Returns void
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:314

setView

setView(lngLat, zoom?): void
Parameters
- lngLat: LngLatArray
- Optional zoom: number
Returns void
Implementation of MapAdapter.setView
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:217
setView(options): void
Parameters
- options: ViewOptions
Returns void
Implementation of MapAdapter.setView
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:218

setZoom

setZoom(zoom): void
Parameters
- zoom: number
Returns void
Implementation of MapAdapter.setZoom
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:274

showLayer

showLayer(layerIds): void
Parameters
- layerIds: string[]
Returns void
Implementation of MapAdapter.showLayer
- Defined in packages/mapboxgl-map-adapter/src/MapboxglMapAdapter.ts:318

Class default

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

controlAdapters

Type declaration

[name: string]: any

emitter

isLoaded

Default Value

layerAdapters

Type declaration

GEOJSON: typeof GeoJsonAdapter

MVT: typeof MvtAdapter

OSM: typeof OsmAdapter

TILE: typeof TileAdapter

WMS: typeof WmsAdapter

map

options

Static controlAdapters

Type declaration

[name: string]: any

Static layerAdapters

Type declaration

GEOJSON: typeof GeoJsonAdapter

MVT: typeof MvtAdapter

OSM: typeof OsmAdapter

TILE: typeof TileAdapter

WMS: typeof WmsAdapter

Methods

addControl

Parameters

control: IControl

position: ControlPosition

Returns undefined | IControl

create

Parameters

options: MapboxglMapAdapterOptions

Returns Promise<unknown>

createButtonControl

Parameters

options: ButtonControlOptions

Returns IControl

createControl

Parameters

control: MapControl<any>

Optional options: CreateControlOptions

Returns IControl

destroy

Returns void

fitBounds

Parameters

e: LngLatBoundsArray

options: FitOptions = {}

Returns void

getBounds

Returns undefined | LngLatBoundsArray

getCenter

Returns undefined | LngLatArray

getContainer

Returns undefined | HTMLElement

getZoom

Returns undefined | number

hideLayer

Parameters

layerIds: string[]

Returns void

onMapClick

Parameters

evt: MapMouseEvent

Returns void

removeControl

Parameters

`Static` controlAdapters

`Static` layerAdapters

`Optional` options: CreateControlOptions

layers: {
[x: string]: TLayerAdapter;
}

`Optional` zoom: number