import DrawAction from "@arcgis/core/views/draw/DrawAction.js";const DrawAction = await $arcgis.import("@arcgis/core/views/draw/DrawAction.js");- Inheritance:
- DrawAction→
Accessor
- Subclasses:
- MultipointDrawAction, PointDrawAction, PolygonDrawAction, PolylineDrawAction, SegmentDrawAction
- Since
- ArcGIS Maps SDK for JavaScript 4.7
DrawAction is the base class for all draw actions. DrawActions use the view events to generate a set of coordinates to create new geometries. Each serves a different purpose, allowing you to create a different type geometry such as Point, Multipoint, Polyline, and Polygon.
When the draw.create("type of geometry") method is called, an instance of the relevant draw action is returned. You can then listen to its events to create a new geometry that meets criteria specified by the application.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
vertices readonly | number[][] | |
| |
hasZ
- Type
- boolean
Controls whether the created geometry will have z coordinates or not.
- Default value
- true
vertices
- Type
- number[][]
Two-dimensional array of numbers representing the coordinates of each vertex comprising the geometry being drawn.
Methods
| Method | Signature | Class |
|---|---|---|
canRedo(): boolean | | |
canUndo(): boolean | | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
getCoordsAndPointFromScreenPoint(screenPoint: ScreenPoint): FromScreenPointResult | null | undefined | | |
getCoordsFromScreenPoint(screenPoint: ScreenPoint | null | undefined): number[] | null | undefined | | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
redo(): void | | |
screenToMap(screenPoint: ScreenPoint): Point | null | undefined | | |
undo(): void | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
getCoordsAndPointFromScreenPoint
- Signature
-
getCoordsAndPointFromScreenPoint (screenPoint: ScreenPoint): FromScreenPointResult | null | undefined
Maps the given screen point to a map point.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| screenPoint | The location on the screen. | |
- Returns
- FromScreenPointResult | null | undefined
The result object containing, or
nullif the screen point could not be mapped.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
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
- Signature
-
redo (): void
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.
- Returns
- void
Example
if (action.canRedo()) { action.redo();} undo
- Signature
-
undo (): void
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.
- Returns
- void
Example
if (action.canUndo()) { action.undo();} when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});Type definitions
FromScreenPointResult
The result object of the getCoordsAndPointFromScreenPoint() method. See the table below for more details on each property.