Point

AMD: require(["esri/geometry/Point"], (Point) => { /* code goes here */ });
ESM: import Point from "@arcgis/core/geometry/Point";
Class: esri/geometry/Point
Inheritance: Point Geometry Accessor
Since: ArcGIS API for JavaScript 4.0

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.

See also

Constructors

new Point(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Object

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.

more details
Geometry
String

The name of the class.

more details
Accessor
Extent

The extent of the geometry.

more details
Geometry
Boolean

Indicates if the geometry has M values.

more details
Point
Boolean

Indicates if the geometry has z-values (elevation).

more details
Point
Number

The latitude of the point.

more details
Point
Number

The longitude of the point.

more details
Point
Number

The m-coordinate of the point in map units.

more details
Point
SpatialReference

The spatial reference of the geometry.

more details
Geometry
String

The string value representing the type of geometry.

more details
Point
Number

The x-coordinate (easting) of the point in map units.

more details
Point
Number

The y-coordinate (northing) of the point in map units.

more details
Point
Number

The z-coordinate (or elevation) of the point in map units.

more details
Point

Property Details

cache Objectreadonly inherited

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extent Extentreadonly inherited

The extent of the geometry. For a point, the extent is null.

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 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.

latitude Number

The latitude of the point. If the spatial reference is Web Mercator, the latitude will be given in WGS84. In any geographic spatial reference, the latitude will equal the y coordinate. In all other cases the latitude will be null.

longitude Number

The longitude of the point. If the spatial reference is Web Mercator, the longitude will be given in WGS84. In any geographic spatial reference, the longitude will equal the x coordinate. In all other cases the longitude will be null.

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

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)
type Stringreadonly

The string value representing the type of geometry.

For Point the type is always "point".

x Number

The x-coordinate (easting) of the point in map units.

Default Value:0
y Number

The y-coordinate (northing) of the point in map units.

Default Value:0
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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Point

Creates a deep clone of Point object.

more details
Point

Copies all values from another Point instance.

more details
Point
Number

Computes the Euclidean distance between this Point and a given Point.

more details
Point
Boolean

Determines if the input point is equal to the point calling the function.

more details
Point
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
Geometry
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Point

Modifies the point geometry in-place by shifting the X-coordinate to within +/- 180 span in map units.

more details
Point

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
Geometry

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

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 Point

The 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 Point

The 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 Point

The input point to test.

Returns
Type 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 calling equals().
fromJSON(json){*}static

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.

Parameter
json Object

A 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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
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.
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.