Multipoint

AMD: require(["esri/geometry/Multipoint"], (Multipoint) => { /* code goes here */ });
ESM: import Multipoint from "@arcgis/core/geometry/Multipoint";
Class: esri/geometry/Multipoint
Inheritance: Multipoint Geometry Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

An ordered collection of points.

See also

Constructors

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

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.

more details
Geometry
String

The name of the class.

more details
Accessor
Extent

The extent of the geometry.

more details
Geometry
Boolean

Indicates if the geometry has M values.

more details
Geometry
Boolean

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

more details
Geometry
Number[][]

An array of points.

more details
Multipoint
SpatialReference

The spatial reference of the geometry.

more details
Geometry
String

The string value representing the type of geometry.

more details
Multipoint

Property Details

cache Objectreadonly inherited

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 Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

extent Extentreadonly inherited

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

Indicates if the geometry has M values.

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 Number[][]

An array of points.

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)
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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Multipoint

Adds a point to the Multipoint.

more details
Multipoint
Multipoint

Creates a deep clone of Multipoint object.

more details
Multipoint
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
Geometry
Point

Returns the point at the specified index.

more details
Multipoint
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Point

Removes a point from the Multipoint.

more details
Multipoint
Multipoint

Updates the point at the specified index.

more details
Multipoint
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
Geometry

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(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(){Multipoint}

Creates a deep clone of Multipoint object.

Returns
Type Description
Multipoint A new instance of a Multipoint object equal to the object used to call .clone().
fromJSON(json){*}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
* Returns a new instance of this class.
getPoint(index){Point}

Returns the point at the specified index.

Parameter
index Number

The index of the point in the points property.

Returns
Type Description
Point The point at the specified index.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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(index){Point}

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 Returns the removed point.
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(){Object}inherited

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.