function enableCreatePolygon(draw, view) {
  var action = draw.create("polygon");

  // PolygonDrawAction.vertex-add
  // Fires when user clicks, or presses the "F" key.
  // Can also be triggered when the "R" key is pressed to redo.
  action.on("vertex-add", function (evt) {
    createPolygonGraphic(evt.vertices);
  });

  // PolygonDrawAction.vertex-remove
  // Fires when the "Z" key is pressed to undo the last added vertex
  action.on("vertex-remove", function (evt) {
    createPolygonGraphic(evt.vertices);
  });

  // Fires when the pointer moves over the view
  action.on("cursor-update", function (evt) {
    createPolygonGraphic(evt.vertices);
  });

  // Add a graphic representing the completed polygon
  // when user double-clicks on the view or presses the "C" key
  action.on("draw-complete", function (evt) {
    createPolygonGraphic(evt.vertices);
  });
}

function createPolygonGraphic(vertices){
  view.graphics.removeAll();
  var polygon = {
    type: "polygon", // autocasts as Polygon
    rings: vertices,
    spatialReference: view.spatialReference
  };

  var graphic = new Graphic({
    geometry: polygon,
    symbol: {
      type: "simple-fill", // autocasts as SimpleFillSymbol
      color: "purple",
      style: "solid",
      outline: {  // autocasts as SimpleLineSymbol
        color: "white",
        width: 1
      }
    }
  });
  view.graphics.add(graphic);
}

Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

modeString

Since: ArcGIS API for JavaScript 4.7

The drawing mode. It is only relevant when the action is first created. Its value cannot be changed during the action lifecycle.

Possible Values:

Value	Description
hybrid	Vertices are added while the pointer is clicked or dragged.
freehand	Vertices are added while the pointer is dragged.
click	Vertices are added when the pointer is clicked.

Default Value:hybrid

Example:

draw.create("polygon", {mode: "freehand"});

verticesNumber[][]readonly

Two-dimensional array of numbers representing the coordinates of each vertex comprising the geometry being drawn.

viewMapView inherited

A reference to the MapView.

Method Overview

Method Details

canRedo(){Boolean}inherited

Indicates if the redo() method can be called on the action instance.

Returns:

Type	Description
Boolean	Returns true if the redo() method can be called.

canUndo(){Boolean}inherited

Indicates if the undo() method can be called on the action instance.

Returns:

Type	Description
Boolean	Returns true if the undo() method can be called.

complete()

Completes drawing the polygon geometry and fires the draw-complete event. Call this method if the drawing logic needs to be completed other than by double-clicking or pressing the "C" key.

emit(type, event)inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String The name of the event.

event Object The event payload.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

redo()inherited

Incrementally redo actions recorded in the stack. Call canRedo() prior to calling this method to check if this method can be called on the action instance. Calling this method will fire the vertex-add or vertex-remove events depending on the last action.

Example:

if (action.canRedo()) {
  action.redo();
}

undo()inherited

Incrementally undo actions recorded in the stack. Call canUndo() prior to calling this method to check if this method can be called on the action instance. Calling this method will fire the vertex-add or vertex-remove events depending on the last action.

Example:

if (action.canUndo()) {
  action.undo();
}

Event Overview

{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}

{vertices: Number[][],preventDefault: Function,defaultPrevented: Boolean,type: String}

{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}

{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}

{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}

{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: String}

Event Details

cursor-update

Fires after the pointer moves on the view.

Properties:

vertices Number[][] A two-dimensional array of numbers representing the coordinates of each vertex that comprise the geometry.

vertexIndex Number Index of the last vertex added to the vertices array.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type is always cursor-update.

Example:

// listen to PolygonDrawAction.cursor-update
// give a visual feedback to the user on the view
// as user moving the pointer.
action.on("cursor-update", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

draw-complete

Fires after the user has completed drawing a polygon.

Properties:

vertices Number[][] A two-dimensional array of numbers representing the coordinates of each vertex that comprise the geometry.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type is always draw-complete.

Example:

// listen to PolygonDrawAction.draw-complete
// add the graphic representing the completed
// polygon to the view
action.on("draw-complete", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

redo

Since: ArcGIS API for JavaScript 4.7

Fires in response to redo action or when redo() is called.

Properties:

vertices Number[][] Two-dimensional array of numbers representing the coordinates of each vertex that make the geometry.

vertexIndex Number Index of the vertex where redo was applied.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type the event that was redone. For instance, the type would be vertex-add if a vertex was added as a result of redo.

Example:

// Update the graphic on the view as the last action was redone
action.on("redo", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

undo

Since: ArcGIS API for JavaScript 4.7

Fires in response to undo action or when undo() is called.

Properties:

vertices Number[][] Two-dimensional array of numbers representing the coordinates of each vertex that make the geometry.

vertexIndex Number Index of the vertex where undo was applied.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type the event that was undone. For instance, the type would be vertex-remove if a vertex was removed as a result of undo.

Example:

// Update the graphic on the view as the last action was undone
action.on("undo", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

vertex-add

Fires when a vertex is added.

Properties:

vertices Number[][] A two-dimensional array of numbers representing the coordinates of each vertex that make the geometry.

vertexIndex Number Index of the last vertex added to the vertices array.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type is always vertex-add.

Example:

// listen to PolygonDrawAction.vertex-add
// give a visual feedback to the user on the view
// as user moving the pointer.
action.on("vertex-add", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

vertex-remove

Fires when a vertex is removed.

Properties:

vertices Number[][] A two-dimensional array of numbers representing the coordinates of each vertex that make the geometry.

vertexIndex Number Index of the vertex removed from the vertices array.

preventDefault Function Prevents event propagation bubbling up the event chain.

defaultPrevented Boolean Set to true when preventDefault() is called.

type String The type of the event. For this event, the type is always vertex-remove.

Example:

// listen to PolygonDrawAction.vertex-remove
// give a visual feedback to the user on the view
// as user moving the pointer.
action.on("vertex-remove", function (evt) {
  view.graphics.removeAll();
  var polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});