require(["esri/geometry/Multipoint"], function(Multipoint) { /* code goes here */ });
Class: esri/geometry/Multipoint
Inheritance: Multipoint Geometry Accessor
Since: ArcGIS API 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.
NameTypeSummaryClass
Object

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

more details
more detailsGeometry
String

The name of the class.

more details
more detailsAccessor
Extent

The extent of the geometry.

more details
more detailsGeometry
Boolean

Indicates if the geometry has M values.

more details
more detailsGeometry
Boolean

Indicates if the geometry has Z (elevation) values.

more details
more detailsGeometry
Number[][]

An array of points.

more details
more detailsMultipoint
SpatialReference

The spatial reference of the geometry.

more details
more detailsGeometry
String

For Multipoint, the type is always multipoint.

more details
more detailsMultipoint

Property Details

cacheObjectreadonly inherited

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

declaredClassStringreadonly inherited

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

extentExtentreadonly inherited

The extent of the geometry. For points, the extent is null.

Indicates if the geometry has M values.

Indicates if the geometry has Z (elevation) values.

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.

An array of points.

The spatial reference of the geometry.

Default Value: WGS84 (wkid: 4326)

typeStringreadonly

For Multipoint, the type is always multipoint.

Method Overview

NameReturn TypeSummaryClass
Multipoint

Adds a point to the Multipoint.

more details
more detailsMultipoint
Multipoint

Creates a deep clone of Multipoint object.

more details
more detailsMultipoint
*

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

more details
more detailsGeometry
Point

Returns the point at the specified index.

more details
more detailsMultipoint
Point

Removes a point from the Multipoint.

more details
more detailsMultipoint
Multipoint

Updates the point at the specified index.

more details
more detailsMultipoint
Object

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

more details
more detailsGeometry

Method Details

addPoint(point){Multipoint}

Adds a point to the Multipoint.

Parameter:

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

Returns:
TypeDescription
MultipointReturns the updated Multipoint.

clone(){Multipoint}

Creates a deep clone of Multipoint object.

Returns:
TypeDescription
MultipointA 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 a product in the ArcGIS platform. 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:
TypeDescription
*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:
TypeDescription
PointThe point at the specified index.

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:
TypeDescription
PointReturns 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

Point geometry that specifies the new location.

Returns:
TypeDescription
MultipointReturns the updated Multipoint.

toJSON(){Object}inherited

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.