input string nullable
The value parameter exactly as received; null when the components were supplied instead.
example: 18SUJ23480647
inputForm string
How the input was read: mgrs, utm-coordinate, ups-coordinate or components.
example: mgrs
system string
Grid system used: utm between 80°S and 84°N, ups beyond it.
example: utm
zone integer nullable
UTM zone 1–60; null for UPS, which has no zone number (NGA.STND.0037 §3-2c).
example: 18
band string nullable
Latitude band letter C–X for UTM (I and O are not used), or the polar zone letter A/B in the south and Y/Z in the north. For an MGRS reference this is the letter the reference carries; for a numeric coordinate it is the band the decoded latitude falls in — NGA.STND.0037 §A-5 makes the latitude the authority, so a mismatched or hemisphere-style letter is warned about rather than echoed. null only when a numeric coordinate decodes outside the 80°S–84°N band range.
example: S
gridZoneDesignator string nullable
Zone number plus band letter, or the bare band letter for UPS. When extendedZone is true this names the projection the coordinate was computed in, NOT an area containing the point — see naturalZone. For an MGRS reference this is the letter the reference carries; for a numeric coordinate it is the band the decoded latitude falls in — NGA.STND.0037 §A-5 makes the latitude the authority, so a mismatched or hemisphere-style letter is warned about rather than echoed. null only when a numeric coordinate decodes outside the 80°S–84°N band range.
example: 18S
hemisphere string
north or south. Southern-hemisphere UTM northings carry the 10,000,000 m false northing.
example: north
easting float
Grid easting in metres, rounded to millimetres for display; the 100,000-metre square letters and the truncated MGRS digits are decided from the value snapped to the nearest micrometre, so a coordinate given with sub-millimetre digits can display as a round number while its letters still say which side of the grid line it lies on. Inside a natural UTM zone the easting always falls between 100,000 and 900,000; UPS eastings are measured from a 2,000,000 m false easting. For MGRS input this is the south-west corner of the square (NGA.STND.0037 §3-4d).
example: 323480
northing float
Grid northing in metres, rounded to millimetres on the same rule as the easting. Southern-hemisphere UTM carries the 10,000,000 m false northing, so the equator is 10,000,000 there and 0 in the north. For MGRS input this is the south-west corner of the square (NGA.STND.0037 §3-4d).
example: 4306470
convergenceDegrees float nullable
Grid convergence: the azimuth of grid north reckoned clockwise from true north (Karney 2011 Eq. 24). Exactly 0 on a UTM central meridian, positive east of it in the north and negative east of it in the south. null at a pole in UPS, where the meridian is degenerate.
example: -1.2781132
scaleFactor float
Point scale factor of the projection (Karney 2011 Eq. 25). Exactly 0.9996 on a UTM central meridian and 0.994 at a pole in UPS; it reaches about 1.0013 at the western edge of the widened zone 32V.
example: 0.999983701
epsg integer
EPSG code of the (E,N)-ordered CRS: 32600+zone in the north, 32700+zone in the south, 5041 for UPS North and 5042 for UPS South. EPSG 32661/32761 are the same UPS CRSs with N,E axis order.
example: 32618
letterRole string nullable
How the letter after the zone was read: latitude-band (the standard reading, §A-5), hemisphere-designator (only when a band reading is geometrically impossible, and a warning says so), or polar-zone for the UPS letters A/B/Y/Z. null when no letter was supplied.
example: latitude-band
latitude float
WGS 84 latitude of what the reference denotes: the exact point for a numeric coordinate, or the south-west corner of the square for an MGRS reference (NGA.STND.0037 §3-4d).
example: 38.889381136
longitude float
WGS 84 longitude of the same position.
example: -77.035274279
center object nullable
latitude/longitude of the square's centre, which is usually what a map should show. null for numeric input, which is already a point.
example: {"latitude":38.889427169,"longitude":-77.035217949}
square object nullable
eastingMin, northingMin and sizeMeters — the square exactly, in grid metres. No degree bounds are returned: a UTM/UPS square's outline is not a latitude/longitude rectangle. null for numeric input.
example: {"eastingMin":323480,"northingMin":4306470,"sizeMeters":10}
mgrsPrecisionMeters integer nullable
Side length of the square the input denoted, for MGRS input; null for numeric input.
example: 10
mgrs string nullable
Canonical re-encoding of the returned position at full 1 m precision — a round-trip check the caller can see. It uses the zone the coordinate was supplied in, so for an extended-grid coordinate it names a square in that zone's grid even though the point falls outside the zone's own extent, and a warning says so. null in two cases, each warned about: when the coordinate falls outside the 100,000-metre letter grid so no square identification exists (an easting beyond the range the eight column letters cover in UTM, or a position off the lettered cap in UPS), and when a numeric coordinate decodes outside 80°S–84°N, where no latitude band and therefore no grid zone designator exists to write in front of the square — squareId is still returned in that case.
example: 18SUJ2348006470
squareId string nullable
The two-letter 100,000-metre square identification of the returned position.
example: UJ
exception string nullable
norway or svalbard when the decoded position sits in a grid zone whose extent comes from NGA.STND.0037 Table 7 or 8, else null.
example: null
exceptionNote string nullable
Prose naming that exception rule, or null.
example: null