PointDrawAction | API Reference | ArcGIS Maps SDK for JavaScript 4.31

This class uses the view events to generate a set of coordinates to create a new Point geometry using Draw. When the draw.create("point") method is called, a reference to PointDrawAction is returned. Listen to PointDrawAction's cursor-update and the draw-complete events to handle the creation of the point geometry.

See also

Sample - Prevent drawing a self-intersecting line

Example

function enableCreatePoint(draw, view) {
  let action = draw.create("point");

  // PointDrawAction.cursor-update
  // Give a visual feedback to users as they move the pointer over the view
  action.on("cursor-update", function (evt) {
    createPointGraphic(evt.coordinates);
  });

  // PointDrawAction.draw-complete
  // Create a point when user clicks on the view or presses the "Enter" key.
  action.on("draw-complete", function (evt) {
    createPointGraphic(evt.coordinates);
  });
}

function createPointGraphic(coordinates){
  view.graphics.removeAll();
  let point = {
    type: "point", // autocasts as /Point
    x: coordinates[0],
    y: coordinates[1],
    spatialReference: view.spatialReference
  };

  let graphic = new Graphic({
    geometry: point,
    symbol: {
      type: "simple-marker", // autocasts as SimpleMarkerSymbol
      style: "square",
      color: "red",
      size: "16px",
      outline: { // autocasts as SimpleLineSymbol
        color: [255, 255, 0],
        width: 3
      }
    }
  });
  view.graphics.add(graphic);
}

Constructors

PointDrawAction Constructor new PointDrawAction(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Boolean	Controls whether the created geometry will have z coordinates or not.	DrawAction
Number [][]	An array of x,y coordinates for the point geometry.	PointDrawAction
MapView\|SceneView	A reference to the MapView.	DrawAction

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

hasZ Inherited Property hasZ Boolean Inherited from DrawAction

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

Default Value:true

vertices Property vertices Number[][]readonly Since: ArcGIS Maps SDK for JavaScript 4.19 PointDrawAction since 4.5, vertices added at 4.19.

An array of x,y coordinates for the point geometry.

view Inherited Property view MapView |SceneView Inherited from DrawAction

A reference to the MapView.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Indicates if the redo() method can be called on the action instance.	DrawAction
Boolean	Indicates if the undo() method can be called on the action instance.	DrawAction
	Completes drawing the point geometry and fires the draw-complete event.	PointDrawAction
Boolean	Emits an event on the instance.	DrawAction
FromScreenPointResult\|null	Maps the given screen point to a map point.	DrawAction
Number []\|null	Maps the given screen point to a map point.	DrawAction
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	DrawAction
Boolean	Returns true if a named group of handles exist.	Accessor
Object	Registers an event handler on the instance.	DrawAction
	Incrementally redo actions recorded in the stack.	DrawAction
	Removes a group of handles owned by the object.	Accessor
Point\|null	Maps the given screen point to a map point.	DrawAction
	Incrementally undo actions recorded in the stack.	DrawAction

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 Inherited Method canRedo(){Boolean} Inherited from DrawAction

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 Inherited Method canUndo(){Boolean} Inherited from DrawAction

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

Completes drawing the point 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 Inherited Method emit(type, event){Boolean} Inherited from DrawAction

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 Inherited Method getCoordsAndPointFromScreenPoint(screenPoint){FromScreenPointResult |null} Inherited from DrawAction

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 Inherited Method getCoordsFromScreenPoint(screenPoint){Number[] |null} Inherited from DrawAction

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 Inherited Method hasEventListener(type){Boolean} Inherited from DrawAction

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method on(type, listener){Object} Inherited from DrawAction

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 Method redo() Inherited from DrawAction

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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Inherited Method screenToMap(screenPoint){Point |null} Inherited from DrawAction

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 Method undo() Inherited from DrawAction

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

Name	Type	Summary	Class
	{coordinates: Number [],preventDefault: Function,defaultPrevented: Boolean,type: "cursor-update"}	Fires after the pointer moves on the view.	PointDrawAction
	{coordinates: Number [],preventDefault: Function,defaultPrevented: Boolean,type: "draw-complete"}	Fires after when the user has completed drawing a point.	PointDrawAction

Event Details

cursor-update Event cursor-update

Fires after the pointer moves on the view. It returns the location of the pointer on the view as an array of numbers representing an x,y coordinate pair in the spatial reference of the view.

Properties: coordinates Number []

An array of numbers representing an x,y coordinate pair in the spatial reference of the view.

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

action.on("cursor-update", function (evt) {
  view.graphics.removeAll();
  let point = new Point({
    x: evt.coordinates[0],
    y: evt.coordinates[1],
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(point);
  view.graphics.add(graphic);
});

draw-complete Event draw-complete

Fires after when the user has completed drawing a point. It returns the location of the pointer on the view as an array of numbers representing an x,y coordinate pair in the spatial reference of the view.

Properties: coordinates Number []

An array of numbers representing an x,y coordinate pair in the spatial reference of the view.

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

action.on("draw-complete", function (evt) {
  view.graphics.removeAll();
  let point = new Point({
    x: evt.coordinates[0],
    y: evt.coordinates[1],
    spatialReference: view.spatialReference
  });
  let graphic = createGraphic(point);
  view.graphics.add(graphic);
});