Interface MapOptions<M, C>

List of controls that will be initialized when creating a map instance. It can be defined as a string, then points to the corresponding entry in the controlAdapters.

Default Value

['ZOOM', 'ATTRIBUTION']
Copy

Example

{
  controls: [
    'ZOOM',
    new CustomControl()
  ]
}
Copy

Set options for those controls that are specified by name.

Example

{
  controls: ['ZOOM', 'button1', 'button2'],
  controlsOptions: {
    'ZOOM': { position: 'top-right' },
    'button1': { control: 'BUTTON', position: 'top-left' },
    'button2': { control: 'BUTTON' },
  }
}
Copy

Аutomatic creation of a map from the constructor

Default Value

false
Copy

Example

const webMap = new WebMap(options);
// create: false
webMap.create().then(() => doSomething());
// create: true
webMap.emitter.on('created', () => doSomething());
Copy

options to specify the initial position of the map

A pre-initialized instance of the map

The main initialization property of WebMap. Determines the way of interaction with the selected GIS framework. Available: Leaflet; Openlayers; MapboxGL

special settings for the selected map adapter

The callback function is calling before adding each layer

A way to save the state of a map to external services

Example

import RuntimeParams from '@nextgis/url-runtime-params';
// this will allow to write in the url params of map center and zoomlevel when moving
new WebMap({
  mapAdapter: new MapAdapter(),
  runtimeParams: [new RuntimeParams]
})
Copy

One way to extend WebMap functionality with the help of kits.

The HTML element in which NgwMap will render the map, or the element's string id. The specified element must have no children.