PointDrawAction

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

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:
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 "C" 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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Number[]

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

more details
more detailsPointDrawAction
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[][]

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

more details
more detailsPointDrawAction
MapView

A reference to the MapView.

more details
more detailsDrawAction

Property Details

coordinates Number[]readonly
Since: ArcGIS API for JavaScript 4.6
Deprecated since version 4.19. Use vertices instead.

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

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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

Default Value:true
vertices Number[][]readonly
Since: ArcGIS API for JavaScript 4.19

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

A reference to the MapView.

Method Overview

Show inherited methods Hide inherited methods
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

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

more details
more detailsPointDrawAction
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}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 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 "C" 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.
on(type, listener){Object}inherited

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

Name Type Summary Class
{coordinates: Number[],preventDefault: Function,defaultPrevented: Boolean,type: "cursor-update"}

Fires after the pointer moves on the view.

more details
more details PointDrawAction
{coordinates: Number[],preventDefault: Function,defaultPrevented: Boolean,type: "draw-complete"}

Fires after when the user has completed drawing a point.

more details
more details PointDrawAction

Event Details

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

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