require(["esri/geometry/Point"], function(Point) { /* code goes here */ });
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.
NameTypeSummary
Object

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

more details
more details
String

The name of the class.

more details
more details
Extent

The extent of the geometry.

more details
more details
Boolean

Indicates if the geometry has M values.

more details
more details
Boolean

Indicates if the geometry has Z (elevation) values.

more details
more details
Number

The latitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326).

more details
more details
Number

The longitude of the point if the spatial reference is Web Mercator (wkid: 3857) or WGS84 (wkid: 4326).

more details
more details
Number

The m-coordinate of the point in map units.

more details
more details
SpatialReference

The spatial reference of the geometry.

more details
more details
String

For Point, the type is always point.

more details
more details
Number

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

more details
more details
Number

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

more details
more details
Number

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

more details
more details

Property Details

cacheObjectreadonly

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. The default value is null.

declaredClassStringreadonly

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

extentExtentreadonly

The extent of the geometry. For points, 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.

spatialReferenceSpatialReference autocast

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.

Method Overview

NameReturn TypeSummary
Point

Creates a deep clone of Point object.

more details
more details

Copies all values from another Point instance.

more details
more details
Number

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

more details
more details
Boolean

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

more details
more details
*

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
Point

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

more details
more details
Object

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

more details
more details

Method Details

clone(){Point}

Creates a deep clone of Point object.

Returns:
TypeDescription
PointA 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:
TypeDescription
NumberReturns 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:
TypeDescription
BooleanReturns 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 a product in the ArcGIS platform. 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:
TypeDescription
*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:
TypeDescription
PointReturns a point with a normalized x-value.

toJSON(){Object}inherited

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.