Protected_initProtected_ngwProtected Readonly_starterReadonlyemitterReadonlykeysReadonlymapReadonlymapFrom runtime params
ReadonlyruntimeStaticcontrolsStaticgetRetrieves an icon with the provided options.
Optionalopt: IconOptions = {}Options for the icon.
Icon paint object.
StaticgetStatickeysProtected_addInternalOptionaloptions: unknownProtected_emitOptionaldata: anyProtected_onShortcut method to create base layer
Optionaloptions: O | LayerAdaptersOptions[K]Organized addition to the map design and controls elements,
calling control.onAdd(this.webMap.mapAdapter)
position relative to the map angles
Optionaloptions: MapControls[K]initialization parameters if the control is set as a string value
Shortcut for WebMapLayers.addGeoJsonLayer to create GeoJson adapter with generic types for working in typescript
Create layer from GeoJson data. Set style and behavior for selection.
Optionaladapter: LayerAdapterDefinition<K>// Add simple layer
webMap.addGeoJsonLayer({ data: geojson, paint: { color: 'red' } });
// Add styled by feature property layer with selection behavior
webMap.addGeoJsonLayer({
data: geojson,
paint: function (feature) {
return { color: feature.properties.color, opacity: 0.5 }
},
selectedPaint: function (feature) {
return { color: feature.properties.selcolor, opacity: 1 }
},
selectable: true,
multiselect: true
});
// Add marker layer styled with use [Icons](icons)
webMap.addGeoJsonLayer({ data: geojson, paint: webMap.getIcon({ color: 'orange' })});
// work with added layer
const layer = webMap.addGeoJsonLayer({ data: geojson, id: 'my_layer_name'});
// access layer by id
webMap.showLayer('my_layer_name');
// or access layer by instance
webMap.showLayer(layer);
Shortcut for WebMapLayers.addLayer to create TileLayer adapter
Registration of map layer.
The name of layer adapter from MapAdapter.layerAdapters. May be custom object or class implemented by MainLayerAdapter.
Specific options for given adapter
Optionalorder: numberPush new the GeoJSON features into given vector layer.
Optionalorder: numberAdd any (style, vector, webmap) NGW layer by resource definition.
set layer identification parameters and render method.
Shortcut for WebMapLayers.addLayer to create TileLayer adapter
Rest...args: PromiseGroup[]use cancelPromises instead
Remove from vector layer all features. it is possible to remove only some objects if you specify a callback function.
Optionalcb: ((feature: Feature<Geometry, GeoJsonProperties>) => boolean)Manual way to create a map (If MapOptions.create is false).
Creating a universal map layout control element. Can be used with any map adapter.
Optionaloptions: CreateControlOptionsCreate any toggler control button
Options for control layout customization and assigning a callback function
Optionalmultiple?: booleanOptionalsignal?: AbortSignalOptionalrequestOptions: NgwFeatureRequestOptions<FeatureProperties>Hide features from a vector layer using a callback function.
Sets a map view that contains the given geographical bounds.
Array of coordinates, measured in degrees, in [west, south, east, north] order.
Optionaloptions: FitOptionsMove map to layer. If the layer is NGW resource, extent will be received from the server
Optionaloptions: FitOptionsOptionaloptions: FitOptionsReturns the map's geographical centerpoint.
lngLat Array of two numbers representing longitude and latitude of the center of the map view.
Get instance of registered control
Any registered control string name
Optionaloptions: MapControls[K]Custom control options
Checking the status of any asynchronous operation
The name of the event whose status is checked
use fetchIdentifyGeoJson instead
Helper method to return added layer object by any definition type.
Helper method to return added layer identificator by any definition type.
Optionaloptions: GetLegendOptionsuse fetchNgwLayerFeature instead
use fetchNgwLayerItem instead
use fetchNgwLayerItems instead
Hide added layer on the map by it definition.
Check if given layer is baselayer
Check if the given layer on the map
Optionalevents: LocationEventshelper method to wait for events to load. By default, card creation is tracked
The name of the event whose status is checked
Optionalcb: ((mapAdapter: MapAdapter<any, any, any>) => void)Optionaloptions: FilterOptions<{ Instance of WEB-GIS framework control. What is returned by the create method
Remove specific layer from map and memory by its definition.
Remove all layer from map and memory.
OptionalallowCb: ((layer: string, adapter: LayerAdapter) => boolean)Mark the layer as selected. If the adapter is a vector layer and supports data selection, you can pass a callback function to specify which data will be selected.
OptionalfindFeatureFun: DataLayerFilterSet the center of the current view.
Array of two numbers representing longitude and latitude of the center of the map view.
Set the cursor icon to be displayed when hover icon on the map container.
Available cursor name from https://developer.mozilla.org/ru/docs/Web/CSS/cursor
Sets the GeoJSON data for given vector layer.
Set transparency for a given layer by number from 0 to 1
Sets the view of the map geographical center and zoom
Optionalzoom: numberThe zoom level to set (0-24).
Show added layer on the map by it definition.
Change added layer visibility on the map by given status or inverse current status.
Optionalstatus: booleanOptionalstatus: booleanUnselect the given layer. If the adapter is a vector layer and supports data selection, you can pass a callback function to specify which data will be unselected.
OptionalfindFeatureFun: DataLayerFilterOptionaloptions: { Optionalparams?: Record<string, string>use fitLayer instead
StaticcreateStaticget
Base class containing the logic of interaction WebMap with NextGIS services.
Example