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: Point
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.geometry.Point")
Description
(Added at v1.0)
A location defined by an X- and Y- coordinate. It can be map units or screen units.Samples
Search for samples that use this class.Class hierarchy
esri/geometry.Geometry |_esri/geometry.Point
Constructors
| Name | Summary |
|---|---|
| new esri.geometry.Point(x, y, spatialReference) | Creates a new Point object using x, y, and a spatial reference. |
| new esri.geometry.Point(coords, spatialReference) | Creates a new Point object using an array containing an x,y coordinate value and a spatial reference. |
| new esri.geometry.Point(json) | Creates a new Point object using a JSON object. |
| new esri.geometry.Point(long, lat) | Create a point object and initialize it with specified longitude and latitude. |
| new esri.geometry.Point(point) | Create a point object and initialize it with an array containing longitude and latitude values. |
| new esri.geometry.Point(point) | Create a point object and initialize it with an object that has latitude and longitude properties. |
Properties
| Name | Type | Summary |
|---|---|---|
| cache | Object | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. |
| spatialReference | SpatialReference | The spatial reference of the geometry. |
| type | String | The type of geometry. |
| x | Number | X-coordinate of a point in map units. |
| y | Number | Y-coordinate of a point in map units. |
Methods
| Name | Return type | Summary |
|---|---|---|
| clearCache() | None | Sets the cache property to undefined. |
| getCacheValue(name) | Object | Returns the value for a named property stored in the cache. |
| getLatitude() | Number | Returns the latitude coordinate for this point if the spatial reference of the point is Web Mercator or Geographic (4326). |
| getLongitude() | Number | Returns the longitude coordinate for this point if the spatial reference of the point is Web Mercator or Geographic (4326). |
| normalize() | Point | Shifts the x coordinate to within +/- 180 span. |
| offset(dx, dy) | Point | Returns a new Point with x and y offsets. |
| setCacheValue(name, value) | None | Sets the value for a named property stored in the cache. |
| setLatitude(lat) | Point | Sets the latitude coordinate for this point to the specified value if the point's spatial reference is Web Mercator or Geographic (4326). |
| setLongitude(lon) | Point | Sets the longitude coordinate for this point to the specified value if the point's spatial reference is Web Mercator or Geographic (4326). |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. |
| setX(x) | Point | Sets x-coordinate of point. |
| setY(y) | Point | Sets y-coordinate of point. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
| update(x, y) | Point | Updates a point. |
Constructor Details
Creates a new Point object using x, y, and a spatial reference. At version 3.3 if a spatial reference is not provided a default spatial reference of 4326 will be assigned.
Parameters:
< |
Required | X-coordinate of a point in map units. |
< |
Required | Y-coordinate of a point in map units. |
< |
Required | Spatial reference of the geometry. |
Sample:
new esri.geometry.Point(-118.15, 33.80, new esri.SpatialReference({ wkid: 4326 }));Creates a new Point object using an array containing an x,y coordinate value and a spatial reference. At version 3.3 if a spatial reference is not provided a default spatial reference of 4326 will be assigned.
Parameters:
< |
Required | An array that includes an x,y coordinate. For example: [-117,34]. |
< |
Required | Spatial reference of the geometry. |
Sample:
var point = new esri.geometry.Point([-122.65,45.53],new esri.SpatialReference({ wkid:4326 }));
Creates a new Point object using a JSON object.
Parameters:
< |
Required | A JSON object that contains an x,y coordinate. |
Sample:
var point = new esri.geometry.Point( {"x": -122.65, "y": 45.53, "spatialReference": {" wkid": 4326 } });
Create a point object and initialize it with specified longitude and latitude. (Added at v3.3)
Sample:
var point = new esri.geometry.Point(-98, 38);
Create a point object and initialize it with an array containing longitude and latitude values.
Parameters:
< |
Required | An input array containing the longitude and latitude values for the point. |
Sample:
var point = new esri.geometry.Point([-98, 38]);
Create a point object and initialize it with an object that has latitude and longitude properties. (Added at v3.3)
Parameters:
< |
Required | An object with latitude and longitude properties. |
Sample:
var point = new esri.geometry.Point({
latitude: 38,
longitude: -98
});
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<SpatialReference
SpatialReferenceThe spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
<Number
NumberX-coordinate of a point in map units.
<Number
NumberY-coordinate of a point in map units.
Method Details
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. |
Returns the latitude coordinate for this point if the spatial reference of the point is Web Mercator or Geographic (4326). (Added at v3.3)
Return type:
NumberReturns the longitude coordinate for this point if the spatial reference of the point is Web Mercator or Geographic (4326). (Added at v3.3)
Return type:
NumberReturns a new Point with x and y offsets. Units are map units.
Return type:
PointSets the value for a named property stored in the cache. (Added at v3.13)
Sets the latitude coordinate for this point to the specified value if the point's spatial reference is Web Mercator or Geographic (4326). (Added at v3.3)
Return type:
PointParameters:
< |
Required | A valid latitude value. |
Sets the longitude coordinate for this point to the specified value if the point's spatial reference is Web Mercator or Geographic (4326). (Added at v3.3)
Return type:
PointParameters:
< |
Required | A valid longitude value. |
Sets the spatial reference.
Return type:
GeometryParameters:
< |
Required | Spatial reference of the geometry. |
Sets x-coordinate of point.
Return type:
PointParameters:
< |
Required | Value for x-coordinate of point. |