Multipoint | API Reference | ArcGIS Maps SDK for JavaScript

An ordered collection of points.

Known Limitations

There is currently no support for rendering multipoint geometries in scenes (3D).

See also

Point

Constructors

Multipoint Constructor new Multipoint(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
Object	The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.	Geometry
String	The name of the class.	Accessor
Extent\|null\|undefined	The extent of the geometry.	Geometry
Boolean	Indicates if the geometry has M values.	Geometry
Boolean	Indicates if the geometry has z-values (elevation).	Geometry
Number [][]	An array of points.	Multipoint
SpatialReference	The spatial reference of the geometry.	Geometry
String	The string value representing the type of geometry.	Multipoint

Property Details

cache Inherited Property cache Objectreadonly Inherited from Geometry

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.

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.

extent Inherited Property extent Extent |null |undefinedreadonly Inherited from Geometry

The extent of the geometry. For a point, the extent is null.

hasM Inherited Property hasM Boolean Inherited from Geometry

Indicates if the geometry has M values.

hasZ Inherited Property hasZ Boolean Inherited from Geometry

Indicates if the geometry has z-values (elevation).

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

points Property points Number[][]

An array of points.

spatialReference Inherited Property spatialReference SpatialReferenceautocast Inherited from Geometry

The spatial reference of the geometry.

Default Value:SpatialReference.WGS84 // wkid: 4326

type Property type Stringreadonly

The string value representing the type of geometry.

For Multipoint the type is always "multipoint".

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
Multipoint	Adds a point to the Multipoint.	Multipoint
Multipoint	Creates a deep clone of the Multipoint object.	Multipoint
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Geometry
Point\|null\|undefined	Returns the point at the specified index.	Multipoint
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Point\|null\|undefined	Removes a point from the Multipoint.	Multipoint
Multipoint	Updates the point at the specified index.	Multipoint
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Geometry

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.

addPoint Method addPoint(point){Multipoint}

Adds a point to the Multipoint.

Parameter

point Point|Number []

The point to add to the multipoint. The point can either be a Point or an array of numbers representing XY coordinates.

Returns

Type	Description
Multipoint	Returns the updated Multipoint.

clone Method clone(){Multipoint}

Creates a deep clone of the Multipoint object.

Returns

Type	Description
Multipoint	A new instance of a Multipoint object equal to the object used to call `.clone()`.

fromJSON Inherited Method fromJSON(json){* |null |undefined}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter

json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns

Type	Description
* \| null \| undefined	Returns a new instance of this class.

getPoint Method getPoint(index){Point |null |undefined}

Returns the point at the specified index.

Parameter

index Number

The index of the point in the points property.

Returns

Type	Description
Point \| null \| undefined	The point at the specified index.

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

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

removePoint Method removePoint(index){Point |null |undefined}

Removes a point from the Multipoint. The index specifies which point to remove.

Parameter

index Number

The index of the point to remove.

Returns

Type	Description
Point \| null \| undefined	Returns the removed point.

setPoint Method setPoint(index, point){Multipoint}

Updates the point at the specified index.

Parameters

index Number

The index of the point in the points property.

point Point|Number []

Point geometry that specifies the new location.

Returns

Type	Description
Multipoint	Returns the updated Multipoint.

toJSON Inherited Method toJSON(){Object} Inherited from Geometry

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.