import MultipointDrawAction from "@arcgis/core/views/draw/MultipointDrawAction.js";const MultipointDrawAction = await $arcgis.import("@arcgis/core/views/draw/MultipointDrawAction.js");- Inheritance
- MultipointDrawAction→
DrawAction→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.6
This class uses the view events to generate a set of coordinates to create a new Multipoint geometry using Draw. When the draw.create("multipoint") method is called, a reference to MultipointDrawAction is returned. You can listen to events on the MultipointDrawAction instance, which allows users to create a multipoint that meets criteria specified by the application.
Known Limitations
Currently the MultipointDrawAction is only supported in a MapView.
- Example
- function enableCreateMultipoint(draw, view) {let action = draw.create("multipoint");// Give a visual feedback to users as they move the pointer over the viewaction.on("cursor-update", function (evt) {createMultipointGraphic(evt.vertices);});// Fires when the user clicks, or presses the "F" key on the view// Can also fire when the "R" key is pressed to redo.action.on("vertex-add", function (evt) {createMultipointGraphic(evt.vertices);});// Fires when the "Z" key is pressed to undo the last added pointaction.on("vertex-remove", function (evt) {createMultipointGraphic(evt.vertices);});// Create a point when user clicks on the view or presses the "Enter" key.action.on("draw-complete", function (evt) {createMultipointGraphic(evt.vertices);});}function createMultipointGraphic(vertices) {view.graphics.removeAll();let multipoint = new Multipoint({points: vertices,spatialReference: view.spatialReference});graphic = new Graphic({geometry: multipoint,symbol: {type: "simple-marker",style: "square",color: "red",size: "16px",outline: {color: [255, 255, 0],width: 3}}});view.graphics.add(graphic);}
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| readonly inherited | ||
| inherited | ||
| readonly inherited | number[][] | |
| inherited |
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.
view
- Type
- MapViewOrSceneView
A reference to the MapView.
Methods
| Method | Signature | Class |
|---|---|---|
| inherited | canRedo(): boolean | |
| inherited | canUndo(): boolean | |
| complete(): void | | |
| inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
| inherited | getCoordsAndPointFromScreenPoint(screenPoint: ScreenPoint): FromScreenPointResult | null | undefined | |
| inherited | getCoordsFromScreenPoint(screenPoint: ScreenPoint | null | undefined): number[] | null | undefined | |
| inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
| inherited | isFulfilled(): boolean | |
| inherited | isRejected(): boolean | |
| inherited | isResolved(): boolean | |
| inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
| inherited | redo(): void | |
| inherited | screenToMap(screenPoint: ScreenPoint): Point | null | undefined | |
| inherited | undo(): void | |
| inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
canRedo
- Signature
-
canRedo (): boolean
Indicates if the redo() method can be called on the action instance.
canUndo
- Signature
-
canUndo (): boolean
Indicates if the undo() method can be called on the action instance.
complete
- Signature
-
complete (): void
Completes drawing the Multipoint 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.
- Returns
- void
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.
getCoordsFromScreenPoint
- Signature
-
getCoordsFromScreenPoint (screenPoint: ScreenPoint | null | undefined): number[] | null | undefined
Maps the given screen point to a map point.
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();}
screenToMap
- Signature
-
screenToMap (screenPoint: ScreenPoint): Point | null | undefined
Maps the given screen point to a map point.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| screenPoint | The location on the screen. | |
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});
Events
cursor-update
cursor-update: CustomEvent<CursorUpdateEvent> Fires after the pointer moves on the view.
- Example
- // fires when the pointer moves on the view.action.on("cursor-update", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});
draw-complete
draw-complete: CustomEvent<DrawCompleteEvent> Fires after the user has completed drawing a Multipoint.
- Example
- // fires when completed drawing the multipoint.action.on("draw-complete", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});
redo
redo: CustomEvent<VertexAddEvent | VertexRemoveEvent> - Since
- ArcGIS Maps SDK for JavaScript 4.7
Fires in response to redo action or when redo() is called.
- Example
- // Update the graphic on the view as the last action was redoneaction.on("redo", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});
undo
undo: CustomEvent<VertexAddEvent | VertexRemoveEvent> - Since
- ArcGIS Maps SDK for JavaScript 4.7
Fires in response to undo action or when undo() is called.
- Example
- // Update the graphic on the view as the last action was undoneaction.on("undo", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});
vertex-add
vertex-add: CustomEvent<VertexAddEvent> Fires when a point is added to the multipoint.
- Example
- // fires when a point is added to the multipoint.action.on("vertex-add", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});
vertex-remove
vertex-remove: CustomEvent<VertexRemoveEvent> Fires when a point is removed from the multipoint.
- Example
- // fires when a point is removed from multipoint.action.on("vertex-remove", function (evt) {view.graphics.removeAll();let multipoint = new Multipoint({points: evt.vertices,spatialReference: view.spatialReference});let graphic = createGraphic(multipoint);view.graphics.add(graphic);});