DrawAction

require(["esri/views/draw/DrawAction"], function(DrawAction) { /* code goes here */ });
Class: esri/views/draw/DrawAction
Inheritance: DrawAction Accessor
Since: ArcGIS API for JavaScript 4.7

DrawAction is the base class for all draw actions. DrawActions use the view events to generate a set of coordinates to create new geometries. Each serves a different purpose, allowing you to create a different type geometry such as point, multipoint, polyline, and polygon.

When the draw.create("type of geometry") method is called, an instance of the relevant draw action is returned. You can then listen to its events to create a new geometry that meets criteria specified by the application.

See also:

Constructors

new DrawAction(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
String

The name of the class.

more details
more detailsAccessor
Boolean

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

more details
more detailsDrawAction
Number[][]

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

more details
more detailsDrawAction
MapView

A reference to the MapView.

more details
more detailsDrawAction

Property Details

declaredClass Stringreadonly inherited

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

hasZ Boolean

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

Default Value:true
vertices Number[][]readonly

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

view MapView

A reference to the MapView.

Method Overview

Name Return Type Summary Class
Boolean

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

more details
more detailsDrawAction
Boolean

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

more details
more detailsDrawAction
Boolean

Emits an event on the instance.

more details
more detailsDrawAction
FromScreenPointResult|null

Maps the given screen point to a map point.

more details
more detailsDrawAction
Number[]|null

Maps the given screen point to a map point.

more details
more detailsDrawAction
Boolean

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

more details
more detailsDrawAction
Object

Registers an event handler on the instance.

more details
more detailsDrawAction

Incrementally redo actions recorded in the stack.

more details
more detailsDrawAction
Point|null

Maps the given screen point to a map point.

more details
more detailsDrawAction

Incrementally undo actions recorded in the stack.

more details
more detailsDrawAction

Method Details

canRedo(){Boolean}

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}

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.
emit(type, event){Boolean}

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}

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}

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.
hasEventListener(type){Boolean}

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}

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

Parameters:

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()

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}

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()

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

Type Definitions

FromScreenPointResult

The result object of the getCoordsAndPointFromScreenPoint() method. See the table below for more details on each property.

Properties:
vertex Number[]

Array of x, y, and z component (if hasZ is enabled).

mapPoint Point

The map point of the point associated with the given screen point.

ScreenPoint

An object representing a point on the screen.

Properties:
x Number

The x coordinate.

y Number

The y coordinate.