DrawToolLayer

DrawToolLayer is a layer that hosts drawing results, extending OverlayLayer. It does not render itself; instead it dispatches geometries by type to its internal marker/line/polygon child layers and always keeps itself hidden. Before use you must register the layer class for each type via setLayerClass().

import { Map, DrawToolLayer, MarkerLayer, LineStringLayer, PolygonLayer } from "maptalks";

const map = new Map("map", { center: [0, 0], zoom: 2 });

DrawToolLayer.setLayerClass(MarkerLayer, LineStringLayer, PolygonLayer);

const layer = new DrawToolLayer("draw-tool").addTo(map);

Constructor

new DrawToolLayer(id, geometries?, options?)

Parameters:

• id String layer id.
• geometries Geometry[] (optional) geometries to add.
• options Object layer options (optional).

options

Option	Type	Description	Default
renderer	String	renderer (DrawToolLayer has no renderer)	null
depthFunc	String	depth function	'always'
sceneConfig	Object	scene config, set to { depthFunc } during construction	null
enableAltitude	Boolean	whether altitude is enabled	—
enableSimplify	Boolean	whether simplification is enabled	—

Static Methods

• DrawToolLayer.setLayerClass(markerLayerClass, lineLayerClass, polygonLayerClass): void — set the layer class for each geometry type

Member Methods

• addGeometry(geometries: Geometry | Geometry[]): this — add geometries and dispatch them to child layers by type
• removeGeometry(geometries: Geometry | Geometry[]): void — remove geometries
• getGeometryById(id): Geometry — look up a geometry by id in the child layers
• clear(): this — clear
• bringToFront(): this — bring the child layers to front

Events

Common layer events (show/hide, setopacity, add/remove, etc.) — see OverlayLayer / Layer.