import Draw from "@arcgis/core/views/draw/Draw.js";const Draw = await $arcgis.import("@arcgis/core/views/draw/Draw.js");- Inheritance:
- Draw→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.5
The Draw class provides advanced drawing capabilities for developers who need complete control over creating temporary graphics with different geometries. For example, if you want to prevent users from drawing graphics with self-intersecting lines or overlapping polygons, then you can use this class to implement these rules. The draw experience is built upon draw actions, which use the view events to generate a set of coordinates for creating new geometries. Each geometry type has a corresponding draw action class.
This class provides a simple interface for interacting with draw actions. After initializing a Draw instance, you can call create() to return a reference to the relevant draw action. This draw action may then be used to create new geometries of the specified type.
Pointer and keyboard gestures
Pointer and keyboard gestures for drawing points, polylines, and polygons are described in the tables below.
Drawing points
| Gesture | Action |
|---|---|
| Left-click | Adds a point at the pointer location. |
| Enter | Adds a point at the pointer location. |
Drawing polylines and polygons
| Gesture | Action |
|---|---|
| Left-click | Adds a vertex at the pointer location. |
| Left-drag | Adds a vertex for each pointer move. |
| Enter or Double-click | Completes the polyline or polygon. |
| F | Adds a vertex to the polyline or polygon. |
| Z | Incrementally undos actions recorded in the stack. |
| R | Incrementally redos actions recorded in the stack. |
To provide users with a simpler drawing experience, then use SketchViewModel class.
Example
// create a new instance of drawlet draw = new Draw({ view: view});
// create an instance of draw polyline action// the polyline vertices will be only added when// the pointer is clicked on the viewlet action = draw.create("polyline", {mode: "click"});
// fires when a vertex is addedaction.on("vertex-add", function (evt) { measureLine(evt.vertices);});
// fires when the pointer movesaction.on("cursor-update", function (evt) { measureLine(evt.vertices);});
// fires when the drawing is completedaction.on("draw-complete", function (evt) { measureLine(evt.vertices);});
// fires when a vertex is removedaction.on("vertex-remove", function (evt) { measureLine(evt.vertices);});
function measureLine(vertices) { view.graphics.removeAll();
let line = createLine(vertices); let lineLength = geometryEngine.geodesicLength(line, "miles"); let graphic = createGraphic(line); view.graphics.add(graphic);}
function createLine(vertices) { let polyline = { type: "polyline", // autocasts as new Polyline() paths: vertices, spatialReference: view.spatialReference } return polyline;}Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// Typical usagelet draw = new Draw({ view: view});Properties
| Property | Type | Class |
|---|---|---|
DrawAction | null | undefined | | |
declaredClass readonly inherited | ||
| |
activeAction
- Type
- DrawAction | null | undefined
A reference to the active draw action. An instance of the draw action is created when create() method is called.
Methods
complete
- Signature
-
complete (): void
- Since
- ArcGIS Maps SDK for JavaScript 4.7
Complete the current active drawing.
- Returns
- void
create
- Signature
-
create (drawAction: ToolType, drawOptions?: DrawOptions): DrawAction
Creates an instance of the requested draw action.
Parameters
| Parameter | Type | Description | Required | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| drawAction | Name of the draw action to create. See the table below for a list of possible values and type of draw action it creates. Possible Values
| | |||||||||||||
| drawOptions | Object of the drawing options for the geometry to be created. | |
- Returns
- DrawAction
Returns an instance of the requested draw action.
Example
let pointAction = draw.create("point"); reset
- Signature
-
reset (): void
- Since
- ArcGIS Maps SDK for JavaScript 4.6
Resets the drawing by clearing the active action.
- Returns
- void