Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Multipoint
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.geometry.Multipoint")
Description
(Added at v1.0)
An ordered collection of points.Samples
Search for samples that use this class.Class hierarchy
esri/geometry.Geometry |_esri/geometry.Multipoint
Constructors
| Name | Summary |
|---|---|
| new esri.geometry.Multipoint(spatialReference) | Creates a new Multipoint object. |
| new esri.geometry.Multipoint(json) | Creates a new Multipoint object using a JSON object. |
Properties
| Name | Type | Summary |
|---|---|---|
| cache | Object | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. |
| points | Number[][] | An array of one or more points. |
| spatialReference | SpatialReference | The spatial reference of the geometry. |
| type | String | The type of geometry. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addPoint(point) | Multipoint | Adds a point to the Multipoint. |
| clearCache() | None | Sets the cache property to undefined. |
| getCacheValue(name) | Object | Returns the value for a named property stored in the cache. |
| getExtent() | Extent | Gets the extent of all the points. |
| getPoint(index) | Point | Returns the point at the specified index. |
| removePoint(index) | Point | Removes a point from the Multipoint. |
| setCacheValue(name, value) | None | Sets the value for a named property stored in the cache. |
| setPoint(index, point) | Multipoint | Updates the point at the specified index. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new Multipoint object.
Parameters:
< |
Required | Spatial reference of the geometry. |
Sample:
var multiPoint = new esri.geometry.Multipoint(new esri.SpatialReference({ wkid:4326 }));
Creates a new Multipoint object using a JSON object.
Parameters:
< |
Required | JSON object representing the geometry. |
Sample:
var mpJson ={"points":[[-122.63,45.51],[-122.56,45.51],[-122.56,45.55]],"spatialReference":({" wkid":4326 })};
var multipoint = new esri.geometry.Multipoint(mpJson);
Property Details
<Object
ObjectThe 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
undefined. (Added at v3.13)Default value:
undefined<Number[][]
Number[][]An array of one or more points.
Sample:
var mp = new esri.geometry.Multipoint(new esri.SpatialReference({wkid:4326}));
mp.points = [[-122.63,45.51],[-122.56,45.51],[-122.56,45.55],[-122.62,45.],[-122.59,45.53]];
See also: addPoint()
<SpatialReference
SpatialReferenceThe spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
Method Details
Adds a point to the Multipoint. The point can be one of the following: an Esri Point, a number array, or a JSON object.
Return type:
MultipointParameters:
< |
Required | The point to add. The point is either an Point or an array of numbers representing the x,y coordinates. |
Sample:
Point example:
multipoint.addPoint(new esri.geometry.Point(-122.63,45.51));
JSON example:
multipoint.addPoint({"x": -122.65, "y": 45.53 });
See also: points
Returns the value for a named property stored in the cache. (Added at v3.13)
Return type:
ObjectParameters:
< |
Required | The property name of the value to retrieve from the cache. |
Gets the extent of all the points. If only one point is present, the extent has a width and height of 0.
Return type:
ExtentReturns the point at the specified index. (Added at v2.0)
Return type:
PointParameters:
< |
Required | Positional index of the point in the points property. |
Removes a point from the Multipoint. The index specifies which point to remove.
Return type:
PointParameters:
< |
Required | The index of the point to remove. |
Sets the value for a named property stored in the cache. (Added at v3.13)
Updates the point at the specified index. (Added at v2.0)
Return type:
MultipointSets the spatial reference.
Return type:
GeometryParameters:
< |
Required | Spatial reference of the geometry. |