Point
require(["esri/geometry/Point"], function(Point) { /* code goes here */ });esri/geometry/PointA location defined by X, Y, and Z coordinates.
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.
Constructors
- new Point(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 | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. more details | more details | Geometry | |
| String | The name of the class. more details | more details | Accessor | |
| Extent | The extent of the geometry. more details | more details | Geometry | |
| Boolean | Indicates if the geometry has M values. more details | more details | Point | |
| Boolean | Indicates if the geometry has Z (elevation) values. more details | more details | Point | |
| Number | The latitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). more details | more details | Point | |
| Number | The longitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326). more details | more details | Point | |
| Number | The m-coordinate of the point in map units. more details | more details | Point | |
| SpatialReference | The spatial reference of the geometry. more details | more details | Geometry | |
| String | For Point, the type is always | more details | Point | |
| Number | The x-coordinate (easting) of the point in map units. more details | more details | Point | |
| Number | The y-coordinate (northing) of the point in map units. more details | more details | Point | |
| Number | The z-coordinate (or elevation) of the point in map units. more details | more details | Point |
Property Details
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.
- 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.
- hasMBooleanreadonly
Indicates if the geometry has M values.
- hasZBooleanreadonly
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.
- latitudeNumber
The latitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326).
- longitudeNumber
The longitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326).
The m-coordinate of the point in map units.
- Default Value:undefined
The spatial reference of the geometry.
- Default Value:WGS84 (wkid: 4326)
- typeStringreadonly
For Point, the type is always
point.
The x-coordinate (easting) of the point in map units.
- Default Value:0
The y-coordinate (northing) of the point in map units.
- Default Value:0
The z-coordinate (or elevation) of the point in map units.
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.
- Default Value:undefined
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Point | Creates a deep clone of Point object. more details | more details | Point | |
Copies all values from another Point instance. more details | more details | Point | ||
| Number | Computes the Euclidean distance between this Point and a given Point. more details | more details | Point | |
| Boolean | Determines if the input point is equal to the point calling the function. more details | more details | Point | |
| * | 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 details | Geometry | |
| Point | Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units. more details | more details | Point | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Geometry |
Method Details
- clone(){Point}
Creates a deep clone of Point object.
Returns:Type Description Point A new instance of a Point object equal to the object used to call .clone().
- copy(other)
Copies all values from another Point instance.
Parameter:other PointThe point to copy from.
- distance(other){Number}
Computes the Euclidean distance between this Point and a given Point. Points must have the same spatial reference.
Parameter:other PointThe point to compute the distance to.
Returns:Type Description Number Returns the Euclidean distance between this Point and the other Point.
- equals(point){Boolean}
Determines if the input point is equal to the point calling the function.
Parameter:point PointThe input point to test.
Returns:Type Description Boolean Returns trueif the X, Y, Z coordinates of the input point along with its spatial reference and M value are exactly equal to those of the point callingequals().
- 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
jsonparameter 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.
- normalize(){Point}
Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units. You should clone the point object before calling this method where appropriate.
Returns:Type Description Point Returns a point with a normalized x-value.
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.