An ordered collection of points.
- See also:
Constructors
-
new Multipoint(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
Object | more details The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. | more details | Geometry | |
String | more details The name of the class. | more details | Accessor | |
Extent | more details The extent of the geometry. | more details | Geometry | |
Boolean | more details Indicates if the geometry has M values. | more details | Geometry | |
Boolean | more details Indicates if the geometry has z-values (elevation). | more details | Geometry | |
Number[][] | more details An array of points. | more details | Multipoint | |
SpatialReference | more details The spatial reference of the geometry. | more details | Geometry | |
String | more details The string value representing the type of geometry. | more details | Multipoint |
Property Details
-
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.
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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.
-
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Multipoint | more details Adds a point to the Multipoint. | more details | Multipoint | |
Multipoint | more details Creates a deep clone of Multipoint object. | more details | Multipoint | |
* | more details 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 | more details Returns the point at the specified index. | more details | Multipoint | |
Point | more details Removes a point from the Multipoint. | more details | Multipoint | |
Multipoint | more details Updates the point at the specified index. | more details | Multipoint | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | Geometry |
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: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 ObjectA 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 NumberThe index of the point in the points property.
Returns:Type Description Point The point at the specified index.
-
removePoint(index){Point}
-
Removes a point from the Multipoint. The index specifies which point to remove.
Parameter:index NumberThe 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 NumberThe index of the point in the points property.
Point geometry that specifies the new location.
Returns:Type Description Multipoint Returns the updated Multipoint.
-
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.