PolygonDrawAction

AMD: require(["esri/views/draw/PolygonDrawAction"], (PolygonDrawAction) => { /* code goes here */ });
ESM: import PolygonDrawAction from "@arcgis/core/views/draw/PolygonDrawAction";
Class: esri/views/draw/PolygonDrawAction
Inheritance: PolygonDrawAction DrawAction Accessor
Since: ArcGIS API for JavaScript 4.5

This class uses different events to generate a set of vertices to create a new Polygon geometry using Draw. When draw.create("polygon") is called, a reference to PolygonDrawAction is returned. You can listen to events on the PolylineDrawAction instance, which allows users to create polylines that meet criteria specified by the developer.

See also:
Example:
function enableCreatePolygon(draw, view) {
  let 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();
  let polygon = {
    type: "polygon", // autocasts as Polygon
    rings: vertices,
    spatialReference: view.spatialReference
  };

  let 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);
}

Constructors

new PolygonDrawAction(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Controls whether the created geometry will have z coordinates or not.

more detailsDrawAction
Stringmore details

The drawing mode.

more detailsPolygonDrawAction
Number[][]more details

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

more detailsDrawAction
MapViewmore details

A reference to the MapView.

more detailsDrawAction

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

Controls whether the created geometry will have z coordinates or not.

Default Value:true
mode String
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.

Possible Values:"hybrid"|"freehand"|"click"

Default Value:hybrid
Example:
draw.create("polygon", {mode: "freehand"});
vertices Number[][]readonly inherited

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

A reference to the MapView.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Booleanmore details

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

more detailsDrawAction
Booleanmore details

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

more detailsDrawAction
more details

Completes drawing the polygon geometry and fires the draw-complete event.

more detailsPolygonDrawAction
Booleanmore details

Emits an event on the instance.

more detailsDrawAction
FromScreenPointResult|nullmore details

Maps the given screen point to a map point.

more detailsDrawAction
Number[]|nullmore details

Maps the given screen point to a map point.

more detailsDrawAction
more details

Returns the actual z value to be used when drawing geometry.

more detailsPolygonDrawAction
Booleanmore details

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

more detailsDrawAction
Objectmore details

Registers an event handler on the instance.

more detailsDrawAction
more details

Incrementally redo actions recorded in the stack.

more detailsDrawAction
Point|nullmore details

Maps the given screen point to a map point.

more detailsDrawAction
more details

Incrementally undo actions recorded in the stack.

more detailsDrawAction

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){Boolean}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
optional

The event payload.

Returns:
Type Description
Boolean true if a listener was notified
getCoordsAndPointFromScreenPoint(screenPoint){FromScreenPointResult|null}inherited

Maps the given screen point to a map point.

Parameter:
screenPoint ScreenPoint

The location on the screen.

Returns:
Type Description
FromScreenPointResult | null The result object containing, or null if the screen point could not be mapped.
getCoordsFromScreenPoint(screenPoint){Number[]|null}inherited

Maps the given screen point to a map point.

Parameter:
screenPoint ScreenPoint

The location on the screen.

Returns:
Type Description
Number[] | null Array of x,y and z component (if hasZ is enabled) of the point associated with the given screen point or null if screen point could not be mapped.
getGeometryZValue()

Returns the actual z value to be used when drawing geometry. NB: this.defaultZ is the value which was passed to the constructor of the DrawAction the actual defaultZ value may differ, depending on derived draw action implementation.

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. See the Events summary table for a list of supported events.

Parameters:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
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();
}
screenToMap(screenPoint){Point|null}inherited

Maps the given screen point to a map point.

Parameter:
screenPoint ScreenPoint

The location on the screen.

Returns:
Type Description
Point | null MapPoint associated with the given screen point or null if screen point could not be mapped.
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

Name Type Summary Class
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "cursor-update"}
more details

Fires after the pointer moves on the view.

more details PolygonDrawAction
{vertices: Number[][],preventDefault: Function,defaultPrevented: Boolean,type: "draw-complete"}
more details

Fires after the user has completed drawing a polygon.

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

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

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

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

more details PolygonDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "vertex-add"}
more details

Fires when a vertex is added.

more details PolygonDrawAction
{vertices: Number[][],vertexIndex: Number,preventDefault: Function,defaultPrevented: Boolean,type: "vertex-remove"}
more details

Fires when a vertex is removed.

more details PolygonDrawAction

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.

The value 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();
  let 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.

The value 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();
  let 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();
  let 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();
  let 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.

The value 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();
  let 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.

The value 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();
  let polygon = new Polygon({
    rings: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polygon);
  view.graphics.add(graphic);
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.