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 ]
require(["esri/geometry/Multipoint"], function(Multipoint) { /* code goes here */ });
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 Multipoint(spatialReference) | Creates a new Multipoint object. |
| new 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:
require([
"esri/geometry/Multipoint", "esri/SpatialReference", ...
], function(Multipoint, SpatialReference, ... ) {
var multiPoint = new Multipoint(new SpatialReference({ wkid:4326 }));
...
});
Creates a new Multipoint object using a JSON object.
Parameters:
< |
Required | JSON object representing the geometry. |
Sample:
require([
"esri/geometry/Multipoint", ...
], function(Multipoint, ... ) {
var mpJson ={"points":[[-122.63,45.51],[-122.56,45.51],[-122.56,45.55]],"spatialReference":({" wkid":4326 })};
var multipoint = new 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:
undefinedSample:
var map;
require([
"esri/InfoTemplate",
"esri/layers/FeatureLayer",
"esri/map",
"esri/tasks/query", "dojo/domReady!"
], function (InfoTemplate, FeatureLayer, Map, Query){
map = new Map("map", {
basemap: "topo",
center: [-122.45, 37.75], // longitude, latitude
zoom: 10
});
var infoTemplate = new InfoTemplate("Attributes", "${*}");
var countiesFeatureLayer = new FeatureLayer("http://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/3",
{
mode: FeatureLayer.MODE_ONDEMAND,
infoTemplate: infoTemplate,
outFields: ['*']
});
var highwaysFeatureLayer = new FeatureLayer("http://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/1",
{
mode: FeatureLayer.MODE_ONDEMAND,
infoTemplate: infoTemplate,
outFields: ['*']
});
map.on("load", function (){
map.addLayer(countiesFeatureLayer);
map.addLayer(highwaysFeatureLayer);
var query = new Query();
query.geometry = map.extent;
query.spatialRelationship = Query.SPATIAL_REL_ENVELOPEINTERSECTS;
query.returnGeometry = true;
query.outFields = ["*"];
countiesFeatureLayer.queryFeatures(query, function (featureSet){
var polygon = featureSet.features[0].geometry;
// populate the Geometry cache by calling getExtent()
var polygonExtent = polygon.getExtent();
console.log("polygonExtent", polygonExtent);
console.log("polygon.cache._extent", polygon.cache._extent);
for (var i = 0; i < featureSet.features.length; i ) {
var feature = featureSet.features[i];
console.log("Polygon geometry cache, %o", feature.geometry.cache);
feature.geometry.clearCache();
console.log("Polygon geometry clear cache, %o", feature.geometry.cache);
// Break out of the loop after the first result
break;
}
});
highwaysFeatureLayer.queryFeatures(query, function (featureSet){
var line = featureSet.features[0].geometry;
// populate the Geometry cache by calling getExtent()
var lineExtent = line.getExtent();
console.log("lineExtent", lineExtent);
console.log("line.cache._extent", line.cache._extent);
for (var i = 0; i < featureSet.features.length; i ) {
var feature = featureSet.features[i];
console.log("Line geometry cache, %o", feature.geometry.cache);
feature.geometry.clearCache();
console.log("Line geometry clear cache, %o", feature.geometry.cache);
// Break out of the loop after the first result
break;
}
});
});
});
<Number[][]
Number[][]An array of one or more points.
Sample:
require([
"esri/geometry/Multipoint", "esri/SpatialReference", ...
], function(Multipoint, SpatialReference, ... ) {
var mp = new Multipoint(new 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:
require([
"esri/geometry/Multipoint", "esri/SpatialReference", "esri/geometry/Point", ...
], function(Multipoint, SpatialReference, Point, ... ) {
var multipoint = new Multipoint(new SpatialReference{ ... });
multipoint.addPoint(new Point(-122.63,45.51));
...
});
JSON example:
require([
"esri/geometry/Multipoint", ...
], function(Multipoint, ... ) {
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. |