Optional authOptional baseUrl of NGW server like this https://demo.nextgis.com
Optional boundsInitial extent of the map, array of degrees in [west, south, east, north] order.
Overrides the center and zoom parameters.
LngLatBoundsArray
// whole world
bounds: [0, -90, 180, 90]
Optional centerInitial position of the map, array of two degrees [longitude, latitude]. LngLatArray
Optional companyOptional connectorOptional controlsList 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.
['ZOOM', 'ATTRIBUTION']
{
controls: [
'ZOOM',
new CustomControl()
]
}
Optional controlsSet options for those controls that are specified by name.
{
controls: ['ZOOM', 'button1', 'button2'],
controlsOptions: {
'ZOOM': { position: 'top-right' },
'button1': { control: 'BUTTON', position: 'top-left' },
'button2': { control: 'BUTTON' },
}
}
Optional createАutomatic creation of a map from the constructor
false
const webMap = new WebMap(options);
// create: false
webMap.create().then(() => doSomething());
// create: true
webMap.emitter.on('created', () => doSomething());
Optional fitoptions to specify the initial position of the map
Optional Internal identificationGet information from NGW webmap layers by click. TODO: find usage
false
Optional mapA pre-initialized instance of the map
Optional mapThe main initialization property of WebMap. Determines the way of interaction with the selected GIS framework. Available: Leaflet; Openlayers; MapboxGL
Optional mapspecial settings for the selected map adapter
Optional maxOptional maxThe maximum zoom level of the map (0-24).
Optional minThe minimum zoom level of the map (0-24).
Optional onThe callback function is calling before adding each layer
Optional osmShortcut to add OSM baselayer.
Optional paintOptional pixelOptional qmsId number of resource from QMS. If specified through an array, the first element will be the resource identifier, and the second will be the name for identification in the application.
const ngwMap = new NgwMap({qmsId: [465, 'qms-basemap']});
ngwMap.hideLayer('qms-basemap');
Optional resourcesList of NGW resources to be displayed on the map.
The resources list may include:
resource (the comment "also for resource" above refers to it)NgwMap.create({
baseUrl: "https://demo.nextgis.com",
target: "map",
resources: [
// Basemap resource
1665,
// Digital Elevation Model (DEM)-style
4117,
// Hillshade-style
{ resource: 4115, adapter: "TILE", opacity: 0.3 },
// Elevation contours-style
'contours-style',
// Vector from Order boundary-style
{
resource: 4111,
fit: true,
adapter: "GEOJSON",
adapterOptions: { paint: { color: "red", fill: false, weight: 4 } },
},
],
});
Optional runtimeA way to save the state of a map to external services
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]
})
Optional selectedOptional setOptional starterOne way to extend WebMap functionality with the help of kits.
Optional targetThe HTML element in which NgwMap will render the map, or the element's string id. The specified element must have no children.
Optional tileOptional viewOptional webmapId number of webmap resource from NGW cloud. If specified through an array, the first element will be the webmapId from NGW, and the second will be the name for identification in the application.
const ngwMap = new NgwMap({webmapId: [3985, 'my-webmap']});
ngwMap.hideLayer('my-webmap');
Optional whitlabelOptional zoomThe initial zoom level of the map (0-24).
Generated using TypeDoc
User credentials for authorization in NGW. Provides the ability to display protected resources