Point | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

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

Type	Summary	Class
Object	The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.	Geometry
String	The name of the class.	Accessor
Extent	The extent of the geometry.	Geometry
Boolean	Indicates if the geometry has M values.	Point
Boolean	Indicates if the geometry has z-values (elevation).	Point
Number	The latitude of the point.	Point
Number	The longitude of the point.	Point
Number	The m-coordinate of the point in map units.	Point
SpatialReference	The spatial reference of the geometry.	Geometry
String	The string value representing the type of geometry.	Point
Number	The x-coordinate (easting) of the point in map units.	Point
Number	The y-coordinate (northing) of the point in map units.	Point
Number	The z-coordinate (or elevation) of the point in map units.	Point

Property Details

cache Inherited Property cache Objectreadonly Inherited from Geometry

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 Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

extent Inherited Property extent Extentreadonly Inherited from Geometry

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

hasM Property 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 Property hasZ Booleanreadonly

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

latitude Property 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 Property 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 Property m Number

The m-coordinate of the point in map units.

Default Value:undefined

spatialReference Inherited Property spatialReference SpatialReferenceautocast Inherited from Geometry

The spatial reference of the geometry.

Default Value:SpatialReference.WGS84 // wkid: 4326

type Property type Stringreadonly

The string value representing the type of geometry.

For Point the type is always "point".

x Property x Number

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

Default Value:0

y Property y Number

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

Default Value:0

z Property z Number

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

Default Value:undefined

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Point	Creates a deep clone of Point object.	Point
this	Copies all values from another Point instance.	Point
Number	Computes the Euclidean distance between this Point and a given Point.	Point
Boolean	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
Boolean	Returns true if a named group of handles exist.	Accessor
Point	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
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Geometry

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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 Method 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 Method copy(other){this}

Copies all values from another Point instance.

Parameter

other Point

The point to copy from.

Returns

Type	Description
this	Returns this instance.

distance Method 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 Method 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 Inherited Method 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Method 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Inherited Method toJSON(){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.

Returns

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