ArcGISSpatialReference

Creates a spatial reference based on WKID.

Since 1.0.0

Arguments

Creates a spatial reference based on WKID for the horizontal coordinate system and vertical coordinate system.

Since 1.0.0

Arguments

Creates a spatial reference based on well-known text.

Since 1.0.0

Arguments

BaseGeographic

If the given spatial reference is a projected coordinate system, then this returns the geographic coordinate system of that system.

If the spatial reference is a projected coordinate system, then a spatial reference object representing the underlying geographic coordinate system is returned. Every projected coordinate system has an underlying geographic coordinate system. If the spatial reference is a geographic coordinate system, then a reference to itself is returned. If the spatial reference is a local spatial reference, a null is returned with an error.

FullWorldExtent

The full world extent for the spatial reference.

The envelope defines the valid range of coordinates for the spatial reference.

HasVertical

True if spatial reference has a vertical coordinate system set; false otherwise.

A spatial reference can optionally include a definition for a vertical coordinate system (VCS), which can be used to interpret the z-values of a geometry. A VCS defines linear units of measure, the origin of z-values, and whether z-values are 'positive up' (representing heights above a surface) or 'positive down' (indicating that values are depths below a surface).

An ArcGISSpatialReference may have a VCS set, for example by calling the ArcGISSpatialReference::SpatialReference constructor. ArcGISSpatialReference::VerticalWKID, ArcGISSpatialReference::WKText, and ArcGISSpatialReference::VerticalUnit provide more information about the specific VCS set on this instance.

VCSs are used when projecting geometries using an ArcGISHorizontalVerticalTransformation.

IsGeographic

True if spatial reference is a Geographic Coordinate System.

IsPannable

True if coordinate system is horizontally pannable.

IsProjected

True if spatial reference is a Projected Coordinate System.

Resolution

The minimum distance that separates unique x,y coordinate values when stored in an ArcGISFeatureTable.

The resolution represents the detail in which a feature class records the location and shape of features, defining the number of decimal places stored. It is the minimum distance that separates x,y coordinate values in the ArcGISGeometry of an ArcGISFeature. Any coordinates that differ by less than the resolution will be stored as the same coordinate value. The units of ArcGISSpatialReference::Resolution are the units of the horizontal coordinate system (ArcGISSpatialReference::Unit) defined when this spatial reference was created.

A separate resolution, ArcGISSpatialReference::VerticalResolution, is defined for the distance between z-values.

Spatial references have default precision properties, and Esri strongly recommends using the default values in most cases. However some high-accuracy workflows customize the default values to preserve their data with higher precision. To store coordinates using a non-default resolution, create a new dataset that uses a custom resolution spatial reference - for example by setting TableDescription.spatialReference when creating a new geodatabase table. See SpatialReferenceBuilder for more information about creating spatial references with custom precision values.

SpheroidData

The spheroid data for the spatial reference.

Tolerance

The minimum distance that determines if two x,y coordinates are considered to be at the same location for relational and topological ArcGISGeometryEngine operations.

This value is used in relational and topological ArcGISGeometryEngine operations when determining whether two points are close enough, in the horizontal plane, to be considered as the same coordinate value when calculating the result. The units of ArcGISSpatialReference::Tolerance are the units of the horizontal coordinate system (ArcGISSpatialReference::Unit) defined when this spatial reference was created.

A separate tolerance, ArcGISSpatialReference::VerticalTolerance, is defined for the difference between z-values.

Spatial references have default precision properties, and Esri strongly recommends using the default values in most cases. However some high-accuracy workflows customize the default values to work with a higher precision. To perform operations using a non-default tolerance, create a ArcGISGeometry with your custom tolerance spatial reference, and pass that geometry to the relational or topological operation. See SpatialReferenceBuilder for more information about creating spatial references with custom precision values.

Unit

The unit of measure for the horizontal coordinate system of this spatial reference.

Also the unit of measure for ArcGISSpatialReference::Tolerance and ArcGISSpatialReference::Resolution.

VerticalResolution

The minimum distance that separates unique z-values when stored in an ArcGISFeatureTable.

The vertical resolution represents the detail in which a feature class records the location and shape of features, defining the number of decimal places or significant digits stored. It is the minimum distance that separates z-values in the ArcGISGeometry of an ArcGISFeature. Any z-values that differ by less than the vertical resolution will be stored as the same z-value. The units of ArcGISSpatialReference::VerticalResolution are the units of the vertical coordinate system (ArcGISSpatialReference::VerticalUnit) defined when this spatial reference was created, if one was set.

A separate resolution, ArcGISSpatialReference::Resolution, is defined for the distance between x,y coordinates.

Spatial references have default precision properties, and Esri strongly recommends using the default values in most cases. However some high-accuracy workflows customize the default values to preserve their data with higher precision. To store coordinates using a non-default resolution, create a new dataset that uses a custom resolution spatial reference - for example by setting TableDescription.spatialReference when creating a new geodatabase table. See SpatialReferenceBuilder for more information about creating spatial references with custom precision values.

VerticalTolerance

The minimum distance that determines if two z-values are considered to be at the same location for ArcGISGeometryEngine operations that compare z-values.

This value is used in relational and topological ArcGISGeometryEngine operations when determining whether two z-values are close enough to be considered as the same value when calculating the result. The units of ArcGISSpatialReference::VerticalTolerance are the units of the vertical coordinate system (ArcGISSpatialReference::VerticalUnit) defined when this spatial reference was created, if one was set.

Note that ArcGISSpatialReference::VerticalTolerance is currently only used by ArcGISGeometryEngine::Simplify and when the input is a z-aware ArcGISPolyline; it is not used in other methods.

A separate tolerance, ArcGISSpatialReference::Tolerance, is defined for the difference between x,y coordinates.

Spatial references have default precision properties, and Esri strongly recommends using the default values in most cases. However some high-accuracy workflows customize the default values to work with a higher precision. To perform operations using a non-default tolerance, create a ArcGISGeometry with your custom tolerance spatial reference, and pass that geometry to the operation. See SpatialReferenceBuilder for more information about creating spatial references with custom precision values.

VerticalUnit

The unit of measure for the vertical coordinate system of this spatial reference.

Is null if ArcGISSpatialReference::HasVertical is false.

Also the unit of measure for ArcGISSpatialReference::VerticalTolerance and ArcGISSpatialReference::VerticalResolution.

VerticalWKID

The well-known ID for the vertical coordinate system (VCS), or 0 if the spatial reference has no VCS or has a custom VCS.

WKID

The well-known ID for the horizontal coordinate system, or 0 if the spatial reference has a custom horizontal coordinate system.

WKText

The well-known text for the horizontal and vertical coordinate systems.

If this coordinate system can only be represented in WKT2 format this property returns an empty string.

Equals

Tests if this object is equal to a second ArcGISSpatialReference object.

Since 1.0.0

Arguments

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.

GetConvergenceAngle

Calculate the grid convergence for a spatial reference at a given point.

Since 1.0.0

Arguments

Returns double

The grid convergence in degrees.

WebMercator

Creates a spatial reference based on web Mercator.

Since 1.0.0

Returns ArcGISSpatialReference

A spatial reference. This is passed to spatial reference functions. null if an error occurs.

WGS84

Creates a spatial reference based on WGS84.

Since 1.0.0

Returns ArcGISSpatialReference

A spatial reference. This is passed to spatial reference functions. null if an error occurs.