ArcGIS Runtime SDK for iOS
100.11

A location defined by x and y (and optionally z) coordinates.
AGSPoint
geometries represent discrete locations or entities, such as a geocoded house address, the location of a water meter in a water utility network, or a moving vehicle. Larger geographic entities (such as cities) are often represented as points on smallscale maps. Points can be used as the geometry of features and graphics and are often used to construct more complex geometries. They are also used in an AGSViewpoint
to define the center of the display.
Points store a single set of x,y coordinates that define a location (longitude and latitude, for example), and an AGSSpatialReference
. Points can optionally have a zvalue (commonly used to describe elevation or altitude) and an mvalue (commonly used for measurement relative to the geometry).
For points defined with a geographic spatial reference, the x coordinate is the longitude (east or west), and the y coordinate is the latitude (north or south). When geographic coordinates are represented in strings, points are generally written using the form "(latitude, longitude)", where the y coordinate comes before the x coordinate. Latitude values south of the equator and longitude values west of the prime meridian are expressed as negative numbers.
Use AGSCoordinateFormatter
to convert a latitude and longitude formatted string directly to an AGSPoint
. The coordinate formatter can also return a latitude and longitude formatted string from an existing AGSPoint
. Other coordinate notations, such as Military Grid Reference System (MGRS) and United States National Grid (USNG) are also supported.
Points are based upon the parent AGSGeometry
class. The AGSGeometry
class is immutable which means that you can not change its shape once it is created. If you need to modify a point once it has been created, use the AGSPointBuilder
class instead. The toGeometry (AGSGeometryBuilder)
method will provide you with the AGSPoint
object.
toBuilder (AGSPoint):
to get a point builder. AGSPointBuilder
to construct or modify points programmatically. AGSSketchEditor
to construct or modify geometries interactively by sketching on a map. AGSGeometryEngine
to perform operations on geometries. Instance Methods  
(instancetype)   initWithCLLocationCoordinate2D: 
(instancetype)   initWithX:y:m:spatialReference: 
(instancetype)   initWithX:y:spatialReference: 
(instancetype)   initWithX:y:z:m:spatialReference: 
(instancetype)   initWithX:y:z:spatialReference: 
(BOOL)   isEqualToGeometry: 
(BOOL)   isEqualToGeometry: 
(BOOL)   isEqualToGeometry:tolerance: 
(AGSPointBuilder *)   toBuilder 
(CLLocationCoordinate2D)   toCLLocationCoordinate2D 
(nullable id)   toJSON: 
Class Methods  
(nullable id< AGSJSONSerializable >)  + fromJSON:error: 
(instancetype)  + pointWithCLLocationCoordinate2D: 
(instancetype)  + pointWithX:y:m:spatialReference: 
(instancetype)  + pointWithX:y:spatialReference: 
(instancetype)  + pointWithX:y:z:m:spatialReference: 
(instancetype)  + pointWithX:y:z:spatialReference: 
Properties  
AGSGeometryDimension  dimension 
BOOL  empty 
AGSEnvelope *  extent 
AGSGeometryType  geometryType 
BOOL  hasCurves 
BOOL  hasM 
BOOL  hasZ 
double  m 
AGSSpatialReference *  spatialReference 
NSDictionary< NSString *, id > *  unknownJSON 
NSDictionary< NSString *, id > *  unsupportedJSON 
double  x 
double  y 
double  z 

staticrequiredinherited 
Initializes and returns an object from its JSON representation.
JSONObject  NSDictionary or NSArray containing the JSON. 
error  encountered during the operation, if any. 
 (instancetype) initWithCLLocationCoordinate2D:  (CLLocationCoordinate2D)  locationCoordinate 
Initializes a point geometry with the provided location information.
locationCoordinate  of the device 
toBuilder:
to get a builder to further modify the geometry.  (instancetype) initWithX:  (double)  x  
y:  (double)  y  
m:  (double)  m  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values.
x  The position along xaxis 
y  The position along yaxis 
m  The measure value 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry.  (instancetype) initWithX:  (double)  x  
y:  (double)  y  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values.
x  The position along xaxis 
y  The position along yaxis 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry.  (instancetype) initWithX:  (double)  x  
y:  (double)  y  
z:  (double)  z  
m:  (double)  m  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values. The minimum zvalue is 6,356,752 meters, which is the approximate radius of the earth (the WGS 84 datum semiminor axis). The maximum zvalue is 55,000,000 meters.
x  The position along xaxis 
y  The position along yaxis 
z  The position along zaxis 
m  The measure value 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry.  (instancetype) initWithX:  (double)  x  
y:  (double)  y  
z:  (double)  z  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values. The minimum zvalue is 6,356,752 meters, which is the approximate radius of the earth (the WGS 84 datum semiminor axis). The maximum zvalue is 55,000,000 meters.
x  The position along xaxis 
y  The position along yaxis 
z  The position along zaxis 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry.  (BOOL) isEqualToGeometry:  (AGSGeometry *)  other 
Compares whether two geometries are equal.
other  The other geometry object to compare this geometry object to. 
YES
if the geometries are equal.  (BOOL) isEqualToGeometry:  (AGSPoint *)  other 
Compares whether two point geometries are equal.
other  point to compare this point to 
 (BOOL) isEqualToGeometry:  (AGSGeometry *)  other  
tolerance:  (double)  tolerance  
Compares two geometry objects for equality to within some tolerance.
other  The other geometry object to compare this geometry object to. 
tolerance  The tolerance. 
YES
if the geometries are equal within the given tolerance, otherwise NO
. + (instancetype) pointWithCLLocationCoordinate2D:  (CLLocationCoordinate2D)  locationCoordinate 
Initializes a point geometry with the provided location information.
locationCoordinate  of the device 
toBuilder:
to get a builder to further modify the geometry. + (instancetype) pointWithX:  (double)  x  
y:  (double)  y  
m:  (double)  m  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values.
x  The position along xaxis 
y  The position along yaxis 
m  The measure value 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry. + (instancetype) pointWithX:  (double)  x  
y:  (double)  y  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values.
x  The position along xaxis 
y  The position along yaxis 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry. + (instancetype) pointWithX:  (double)  x  
y:  (double)  y  
z:  (double)  z  
m:  (double)  m  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values. The minimum zvalue is 6,356,752 meters, which is the approximate radius of the earth (the WGS 84 datum semiminor axis). The maximum zvalue is 55,000,000 meters.
x  The position along xaxis 
y  The position along yaxis 
z  The position along zaxis 
m  The measure value 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry. + (instancetype) pointWithX:  (double)  x  
y:  (double)  y  
z:  (double)  z  
spatialReference:  (nullable AGSSpatialReference *)  spatialReference  
Initializes a point geometry with the provided coordinate values. The minimum zvalue is 6,356,752 meters, which is the approximate radius of the earth (the WGS 84 datum semiminor axis). The maximum zvalue is 55,000,000 meters.
x  The position along xaxis 
y  The position along yaxis 
z  The position along zaxis 
spatialReference  The coordinate system that the coordinate values use. 
toBuilder:
to get a builder to further modify the geometry.  (AGSPointBuilder*) toBuilder 
Returns a builder using a copy of this geometry as a starting off point. The builder can be used to make modifications to the geometry.
Implements AGSGeometry.
 (CLLocationCoordinate2D) toCLLocationCoordinate2D 
Converts current point into CLLocationCoordinate2D.

requiredinherited 
Returns JSON representation for this object.
error  encountered during the operation, if any. 
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.

readnonatomicassigninherited 
The dimension of this geometry object.
AGSGeometryDimension::AGSGeometryDimensionUnknown
if an error occurs.

readnonatomicassigninherited 
Indicates whether this geometry has any vertices.

readnonatomicstronginherited 
Smallest, rectangular boundingbox that covers the geometry.

readnonatomicassigninherited 
The type of this geometry.

readnonatomicassigninherited 
Indicates whether this geometry has curves.

readnonatomicassigninherited 
Indicates whether this geometry contains m (measure) values.

readnonatomicassigninherited 
Indicates whether this geometry contains z coordinate values. Only 3D geometries contain z values.

readnonatomicassign 
An optional coordinate to define a measure value for the point.
Mvalues are used in linear referencing scenarios and may represent things like mile markers along a highway. Like zvalues, every geometry can optionally store mvalues with the point coordinates that comprise it. The default mvalue is NaN. If an mvalue is specified when a geometry is created, the new geometry will have mvalues (AGSGeometry::hasM
will be YES
). Note that when you get mvalues back from a geometry, the default value of NAN
is returned for vertices that do not have mvalues. A geometry with mvalues is sometimes known as an maware geometry.
AGSGeometry::hasM
to check if the geometry has measure values.

readnonatomicstronginherited 
The spatial reference associated with the gometry. It specifies the coordinate system for the geometry's x, y, and z coordinate values.

readrequirednonatomiccopyinherited 
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.

readnonatomiccopyinherited 
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.

readnonatomicassign 
The position along xaxis.

readnonatomicassign 
The position along yaxis.

readnonatomicassign 
The z coordinate for the point.
Geometries can have zvalues, indicating values along the zaxis, which is perpendicular to both the xaxis and yaxis. Zvalues indicate height above or depth below a surface, or an absolute elevation. For example, zvalues are used to draw the locations of geometries in an AGSSceneView
. Note that geometries are not considered true 3D shapes and are draped onto surfaces in the view, or in some cases, drawn in a single plane by using zvalues. Zvalues are stored on AGSPoint
and AGSEnvelope
. Since AGSMultipoint
, AGSPolyline
, and AGSPolygon
are created from a collection of AGSPoint
, all types of geometry can have zvalues.
Whether or not a geometry has zvalues is determined when the geometry is created; if you use a method that has a zvalue parameter, the new geometry will have zvalues (AGSGeometry::hasZ
will be YES
). If you create geometries using constructors that take zvalue parameters, or if you pass into the constructor points or segments that have zvalues, the new geometry will have zvalues. An AGSGeometry
with zvalues is sometimes known as a zaware geometry.
It may be that not all vertices in your geometry have a zvalue defined. NAN
is a valid zvalue used to indicate an unknown zvalue. However, the default zvalue is 0
. When you get zvalues from a geometry that does not have zvalues, the default is 0
. Check the AGSGeometry::hasZ
to determine whether a zvalue of 0
means that there are no zvalues in the geometry or that the zvalue in the geometry's coordinates really is 0
.
AGSGeometry::hasZ
to check if the geometry has z values.