Class: Draw

cercaliagl.control/Draw

This class permit to draw features. It is possible to add custom callback functions.

const drawControl = map.getControlByName(cercaliagl$$control$$MapControls.DRAW);
drawControl.getElement().style.display = 'none';
drawControl.onDrawEnd = (feature) => console.log('drawEnd', feature);
drawControl.onModify = (feature) => console.log('onModify', feature);
drawControl.onDelete = (feature) => console.log('onDelete', feature);
drawControl.onSelect = (features) => console.log('onSelect'), features);
drawControl.onDeselect = () => console.log('onDeselect');

new Draw(options) control/Draw.js, line 372

Name Type Description

options

Options

Name	Type	Description
`styles`	Array.<module:cercaliagl/MapStyler~StyleLayerJSON>	Layer
`adaptDrawStylesToFeatureStyle`	boolean	Servers
`freehandOnDrawPolygonMobile`	boolean	Layer
`interactive`	boolean	Map is interactive

Extends

module:cercaliagl/control/Control~Control

Members

allowPolygonIntersection{Boolean}

Allow polygon intersections when drawing, true by default

onDelete{function} {null}

onDeselect{function} {null}

onDrawEnd{function} {null}

onModify{function} {null}

onSelect{function} {null}

Methods

deleteAllFeatures() control/Draw.js, line 945

Delete all drawn features

deleteFeature(id) control/Draw.js, line 739

Delete feature by id

Name	Type	Description
`id`	string	Feature id

disable() control/Draw.js, line 936

Disable control. Show UI buttons.

enable() control/Draw.js, line 927

Enable control. Show UI buttons.

getAllowPolygonIntersections(){boolean} control/Draw.js, line 748

Return if polygon intersections are allowed

Returns:

allow Allow

getCercaliaMap(){module:cercaliagl/Map~Map} inherited control/Control.js, line 112

Returns cercalia Map object

Returns:

Cercalia map.

getClass(){string} inherited control/Control.js, line 85

Get class name.

Returns:

Class name.

getCurrentMode() control/Draw.js, line 708

Get current mode

getElement(){Element} inherited control/Control.js, line 103

Get control HTML Element

Returns:

HTML Element

getFeatureById(id){GeoJSON} control/Draw.js, line 767

Return feature in GeoJSON format by feature id.

Name	Type	Description
`id`	string	Feature Id

Returns:

feature Feature

getGeoJSONFeatures(){Array.<GeoJSON>} control/Draw.js, line 776

Return all drawing features in GeoJSON format.

getId(){string} inherited control/Control.js, line 76

Get control id.

Returns:

Id.

getMap(){module:maplibre-gl~Map} inherited control/Control.js, line 122

Returns mapboxgl Map object

getName(){string|null} inherited control/Control.js, line 94

Get control name. Null if control has not defined name.

Returns:

Class name.

hide() inherited control/Control.js, line 144

Hide control.

loadFeatures(features) control/Draw.js, line 678

Load Cercalia Features to draw control. Then you can modify them or delete.

Name	Type	Description
`features`	Array.<module:cercaliagl/Feature~Feature>	Features

loadGeoJSON(geojson) control/Draw.js, line 730

Load features via GeoJSON or geometry

Name	Type	Description
`geojson`	GeoJSON	GeoJSON

setAllowPolygonIntersections(allow) control/Draw.js, line 757

Set if polygon intersections are allowed

Name	Type	Description
`allow`	boolean	Allow

setDisableDragWhenEditing(disable) control/Draw.js, line 689

Set disable drag when editing

Name	Type	Description
`disable`	boolean	Disable

setDrawCircleMode() control/Draw.js, line 918

Enable draw polygon interaction

setDrawFreehandPolygonMode() control/Draw.js, line 900

Enable draw polygon interaction

setDrawLinestring() control/Draw.js, line 833

Enable draw linestring interaction

setDrawMagneticPolygonMode() control/Draw.js, line 909

Enable draw polygon interaction with magnetic closes

setDrawPolygonMode() control/Draw.js, line 891

Enable draw polygon interaction

setFeatureProperty(featureId, property, value) control/Draw.js, line 719

Sets a property on the given feature

Name	Type	Description
`featureId`	string
`property`	string	property
`value`	string	value

setSelectMode() control/Draw.js, line 811

Enable select mode to select features. After select it is possible to delete features. Hit and hold Shift key if you want to select more features.

setSnapping(enabled) control/Draw.js, line 785

Enable or disable snapping

Name	Type	Description
`enabled`	boolean	Enabled

setStaticMode() control/Draw.js, line 822

Static mode shows drawn features but in this mode it is not possible to edit them.

show() inherited control/Control.js, line 153

Show control.