DrawAction

Class: esri/views/2d/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:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
MapView

A reference to the MapView.

more details
more detailsDrawAction

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.

A reference to the MapView.

Method Overview

NameReturn TypeSummaryClass
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

Emits an event on the instance.

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

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:
TypeDescription
BooleanReturns true if the redo() method can be called.
canUndo(){Boolean}

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

Returns:
TypeDescription
BooleanReturns true if the undo() method can be called.
emit(type, event)

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}

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:
TypeDescription
BooleanReturns 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:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
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();
}
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();
}
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.