require(["esri/views/draw/PointDrawAction"], (PointDrawAction) => { /* code goes here */ });
import PointDrawAction from "@arcgis/core/views/draw/PointDrawAction.js";
esri/views/draw/PointDrawAction
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.
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
Controls whether the created geometry will have z coordinates or not. | DrawAction | ||
An array of x,y coordinates for the point geometry. | PointDrawAction | ||
A reference to the MapView. | DrawAction |
Property Details
-
hasZ
InheritedPropertyhasZ Boolean
Inherited from DrawAction -
Controls whether the created geometry will have z coordinates or not.
- Default Value:true
-
Since: ArcGIS Maps SDK for JavaScript 4.19PointDrawAction since 4.5, vertices added at 4.19. -
An array of x,y coordinates for the point geometry.
-
Inherited from DrawAction
-
A reference to the MapView.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Indicates if the redo() method can be called on the action instance. | DrawAction | ||
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 | ||
Emits an event on the instance. | DrawAction | ||
Maps the given screen point to a map point. | DrawAction | ||
Maps the given screen point to a map point. | DrawAction | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | DrawAction | ||
Returns true if a named group of handles exist. | Accessor | ||
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 | ||
Maps the given screen point to a map point. | DrawAction | ||
Incrementally undo actions recorded in the stack. | DrawAction |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodcanRedo(){Boolean}
Inherited from DrawAction -
Indicates if the redo() method can be called on the action instance.
Returns
-
canUndo
InheritedMethodcanUndo(){Boolean}
Inherited from DrawAction -
Indicates if the undo() method can be called on the action instance.
Returns
-
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
InheritedMethodemit(type, event){Boolean}
Inherited from DrawAction -
Emits an event on the instance. This method should only be used when creating subclasses of this class.
ReturnsType Description Boolean true
if a listener was notified
-
getCoordsAndPointFromScreenPoint
InheritedMethodgetCoordsAndPointFromScreenPoint(screenPoint){FromScreenPointResult |null}
Inherited from DrawAction -
Maps the given screen point to a map point.
ParameterscreenPoint ScreenPointThe location on the screen.
ReturnsType Description FromScreenPointResult | null The result object containing, or null
if the screen point could not be mapped.
-
Inherited from DrawAction
-
Maps the given screen point to a map point.
ParameterscreenPoint ScreenPointThe location on the screen.
Returns
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from DrawAction -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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
InheritedMethodon(type, listener){Object}
Inherited from DrawAction -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
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.
Exampleif (action.canRedo()) { action.redo(); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from DrawAction
-
Maps the given screen point to a map point.
ParameterscreenPoint ScreenPointThe location on the screen.
Returns
-
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.
Exampleif (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
-
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
-
An array of numbers representing an x,y coordinate pair in the spatial reference of the view.
preventDefault FunctionPrevents event propagation bubbling up the event chain.
defaultPrevented BooleanSet to true when
preventDefault()
is called.type StringThe type of the event.
The value is always "cursor-update".
Exampleaction.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); });
-
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
-
An array of numbers representing an x,y coordinate pair in the spatial reference of the view.
preventDefault FunctionPrevents event propagation bubbling up the event chain.
defaultPrevented BooleanSet to
true
whenpreventDefault()
is called.type StringThe type of the event.
The value is always "draw-complete".
Exampleaction.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); });