PolylineDrawAction

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

This class uses different events to generate a set of vertices to create a new Polyline geometry using Draw. When draw.create("polyline") is called, a reference to this class 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 enableCreatePolyline(draw, view) {
  var action = draw.create("polyline");

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

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

  // listen to PolylineDrawAction.cursor-update
  // fires when the pointer moves over the view
  action.on("cursor-update", function (evt) {
    createPolylineGraphic(evt.vertices);
  });

  // listen to PolylineDrawAction.draw-complete
  // event to create a graphic when user double-clicks
  // on the view or presses the "C" key
  action.on("draw-complete", function (evt) {
    createPolylineGraphic(evt.vertices);
  });
}

function createPolylineGraphic(vertices){
  view.graphics.removeAll();
  var polyline = {
    type: "polyline", // autocasts as Polyline
    paths: vertices,
    spatialReference: view.spatialReference
  };

  var graphic = new Graphic({
    geometry: polyline,
    symbol: {
      type: "simple-line", // autocasts as SimpleLineSymbol
      color: [4, 90, 141],
      width: 3,
      cap: "round",
      join: "round"
    }
 });
 view.graphic.add(graphic);
}

Constructors

new PolylineDrawAction(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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Number[][]

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

more details
more detailsPolylineDrawAction
MapView

A reference to the MapView.

more details
more detailsPolylineDrawAction

Property Details

declaredClassStringreadonly inherited

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

verticesNumber[][]readonly

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

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 detailsPolylineDrawAction
Boolean

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

more details
more detailsPolylineDrawAction

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

more details
more detailsPolylineDrawAction

Emits an event on the instance.

more details
more detailsPolylineDrawAction
Boolean

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

more details
more detailsPolylineDrawAction
Object

Registers an event handler on the instance.

more details
more detailsPolylineDrawAction

Incrementally redo actions recorded in the stack.

more details
more detailsPolylineDrawAction

Incrementally undo actions recorded in the stack.

more details
more detailsPolylineDrawAction

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

Completes drawing the polyline 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)protected

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 event 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 event depending on the last action.

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

Event Overview

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

Fires after the pointer moves on the view.

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

Fires after the user has completed drawing a polyline.

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

Fires when a vertex is added.

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

Fires when a vertex is removed.

more details
more detailsPolylineDrawAction

Event Details

cursor-update

Fires after the pointer moves on the view.

Properties:
vertices Number[][]

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 cursor-update.

Example:
// Give a visual feedback to the user as the pointer moves on the view.
action.on("cursor-update", function (evt) {
  view.graphics.removeAll();
  var polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  var graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});
draw-complete

Fires after the user has completed drawing a polyline.

Properties:
vertices Number[][]

Two-dimensional array of numbers representing the coordinates of each vertex that make 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 PolylineDrawAction.draw-complete
// add the graphic representing the completed
// polyline to the view
action.on("draw-complete", function (evt) {
  removeGraphic(graphic);
  var polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});
vertex-add

Fires when a vertex is added.

Properties:
vertices Number[][]

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:
// fires when a vertex is added.
action.on("vertex-add", function (evt) {
  view.graphics.removeAll();
  var polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  var graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});
vertex-remove

Fires when a vertex is removed.

Properties:
vertices Number[][]

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:
// Update the graphic on the view as vertex is removed
action.on("vertex-remove", function (evt) {
  view.graphics.removeAll();
  var polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  var graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});

API Reference search results

NameTypeModule

There were no match results from your search criteria.