Property Overview

Property Details

declaredClass Stringreadonly inherited

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

mode String

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
freehand	Vertices are added while the pointer is dragged.
click	Vertices are added when the pointer is clicked. SegmentDrawActions are created from 2 vertices.

Possible Values:"freehand"|"click"

Default Value:freehand

Example:

draw.create("rectangle", {mode: "click"});

vertices Number[][]readonly

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

view MapView 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.

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

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|String[] A event type, or an array of event types, 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(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();
}

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: "cursor-update"}

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

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

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 SegmentDrawAction.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 geometry.

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 SegmentDrawAction.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);
});

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 SegmentDrawAction.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);
});