require(["esri/geometry/Point"], (Point) => { /* code goes here */ });
import Point from "@arcgis/core/geometry/Point.js";
esri/geometry/Point
A 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. | Geometry | ||
The name of the class. | Accessor | ||
The extent of the geometry. | Geometry | ||
Indicates if the geometry has M values. | Point | ||
Indicates if the geometry has z-values (elevation). | Point | ||
The latitude of the point. | Point | ||
The longitude of the point. | Point | ||
The m-coordinate of the point in map units. | Point | ||
The spatial reference of the geometry. | Geometry | ||
The string value representing the type of geometry. | Point | ||
The x-coordinate (easting) of the point in map units. | Point | ||
The y-coordinate (northing) of the point in map units. | Point | ||
The z-coordinate (or elevation) of the point in map units. | Point |
Property Details
-
hasM
hasM Booleanreadonly
-
Indicates if the geometry has M values.
M-values (measure) allow attribute values to be stored at the vertex of a point. A common usage for storing a measurement in the vertices along a linear feature are linear referencing applications.
-
hasZ
hasZ Booleanreadonly
-
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.
-
m
m Number
-
The m-coordinate of the point in map units.
M-values (measure) allow attribute values to be stored at the vertex of a point. A common usage for storing a measurement in the vertices along a linear feature are linear referencing applications.
- Default Value:undefined
-
spatialReference
InheritedPropertyspatialReference SpatialReferenceautocast
Inherited from Geometry -
The spatial reference of the geometry.
- Default Value:WGS84 (wkid: 4326)
-
x
x Number
-
The x-coordinate (easting) of the point in map units.
- Default Value:0
-
y
y Number
-
The y-coordinate (northing) of the point in map units.
- Default Value:0
-
z
z Number
-
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of Point object. | Point | ||
this | Copies all values from another Point instance. | Point | |
Computes the Euclidean distance between this Point and a given Point. | Point | ||
Determines if the input point is equal to the point calling the function. | Point | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Geometry | |
Returns true if a named group of handles exist. | Accessor | ||
Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units. | Point | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | Geometry |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Copies all values from another Point instance.
Parameterother PointThe point to copy from.
ReturnsType Description this Returns this instance.
-
distance
distance(other){Number}
-
Computes the Euclidean distance between this Point and a given Point. Points must have the same spatial reference.
Parameterother PointThe point to compute the distance to.
ReturnsType Description Number Returns the Euclidean distance between this Point and the other Point.
-
equals
equals(point){Boolean}
-
Determines if the input point is equal to the point calling the function.
Parameterpoint PointThe input point to test.
ReturnsType Description Boolean Returns true
if 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()
.
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
InheritedMethodtoJSON(){Object}
Inherited from Geometry -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.