PolylineDrawAction

function enableCreatePolyline(draw, view) {
  let 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 "Enter" key
  action.on("draw-complete", function (evt) {
    createPolylineGraphic(evt.vertices);
  });
}

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

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

Property Overview

Property Details

declaredClass Stringreadonly inherited

Since: ArcGIS Maps SDK for JavaScript 4.7

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

hasZ Boolean inherited

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

Default Value:true

mode String

Since: ArcGIS Maps SDK 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("polyline", {mode: "freehand"});

vertices Number[][]readonly inherited

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

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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 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 "Enter" 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.

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.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

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

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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

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

redo

Since: ArcGIS Maps SDK 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 polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});

undo

Since: ArcGIS Maps SDK 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 polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  let 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. The value is always "vertex-add".

Example

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

Example

// Update the graphic on the view as vertex is removed
action.on("vertex-remove", function (evt) {
  view.graphics.removeAll();
  let polyline = new Polyline({
    paths: evt.vertices,
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(polyline);
  view.graphics.add(graphic);
});