Class MGRS

Military Grid Reference System Coordinate

Hierarchy

MGRS

Constructors

constructor

new MGRS(zone: number, band: string, column: string, row: string, easting: number, northing: number): MGRS
Constructor
Parameters
- zone: number
  
  zone number
- band: string
  
  band letter
- column: string
  
  column letter
- row: string
  
  row letter
- easting: number
  
  easting
- northing: number
  
  northing
Returns MGRS
- Defined in lib/MGRS.ts:114

Methods

accuracy

accuracy(): number
Get the MGRS coordinate accuracy number of digits

Returns
accuracy digits

Returns number
- Defined in lib/MGRS.ts:260

coordinate

coordinate(type?: GridType): string
Get the MGRS coordinate with specified grid precision

Returns
MGRS coordinate
Parameters
- Optional type: GridType
  
  grid type precision
Returns string
- Defined in lib/MGRS.ts:193

coordinateFromAccuracy

coordinateFromAccuracy(accuracy: number): string
Get the MGRS coordinate with the accuracy number of digits in the easting and northing values. Accuracy must be inclusively between 0 (HUNDRED_KILOMETER) and 5 (METER).

Returns
MGRS coordinate
Parameters
- accuracy: number
  
  accuracy digits between 0 (inclusive) and 5 (inclusive)
Returns string
- Defined in lib/MGRS.ts:242

getBand

getBand(): string
Get the band letter

Returns
band letter

Returns string
- Defined in lib/MGRS.ts:137

getColumn

getColumn(): string
Get the column letter

Returns
column letter

Returns string
- Defined in lib/MGRS.ts:146

getColumnRowId

getColumnRowId(): string
Get the two letter column and row 100k designator

Returns
the two letter column and row 100k designator

Returns string
- Defined in lib/MGRS.ts:278

getEasting

getEasting(): number
Get the easting

Returns
easting

Returns number
- Defined in lib/MGRS.ts:164

getEastingAndNorthing

getEastingAndNorthing(type: GridType): string
Get the easting and northing concatenated value in the grid type precision

Returns
easting and northing value
Parameters
- type: GridType
  
  grid type precision
Returns string
- Defined in lib/MGRS.ts:223

getGridZone

getGridZone(): GridZone
Get the GZD grid zone

Returns
GZD grid zone

Returns GridZone
- Defined in lib/MGRS.ts:287

getHemisphere

getHemisphere(): Hemisphere
Get the hemisphere

Returns
hemisphere

Returns Hemisphere
- Defined in lib/MGRS.ts:182

getNorthing

getNorthing(): number
Get the northing

Returns
northing

Returns number
- Defined in lib/MGRS.ts:173

getRow

getRow(): string
Get the row letter

Returns
row letter

Returns string
- Defined in lib/MGRS.ts:155

getUTMEasting

getUTMEasting(): number
Get the UTM easting

Returns
UTM easting

Returns number
- Defined in lib/MGRS.ts:318

getUTMNorthing

getUTMNorthing(): number
Get the UTM northing

Returns
UTM northing

Returns number
- Defined in lib/MGRS.ts:333

getZone

getZone(): number
Get the zone number

Returns
zone number

Returns number
- Defined in lib/MGRS.ts:128

precision

precision(): GridType
Get the MGRS coordinate grid precision

Returns
grid type precision

Returns GridType
- Defined in lib/MGRS.ts:251

toPoint

toPoint(): Point
Convert to a point

Returns
point

Returns Point
- Defined in lib/MGRS.ts:296

toString

toString(): string
{@inheritDoc}

Returns string
- Defined in lib/MGRS.ts:364

toUTM

toUTM(): UTM
Convert to UTM coordinate

Returns
UTM

Returns UTM
- Defined in lib/MGRS.ts:305

`Static` accuracy

accuracy(mgrs: string): number
Get the MGRS coordinate accuracy number of digits

Returns
accuracy digits

Throws
ParseException upon failure to parse the MGRS string
Parameters
- mgrs: string
  
  MGRS string
Returns number
- Defined in lib/MGRS.ts:623

`Static` create

create(zone: number, band: string, easting: number, northing: number, column?: string, row?: string): MGRS
Create

Returns
MGRS
Parameters
- zone: number
  
  zone number
- band: string
  
  band letter
- easting: number
  
  easting
- northing: number
  
  northing
- Optional column: string
- Optional row: string
Returns MGRS
- Defined in lib/MGRS.ts:80

`Static` from

from(point: Point): MGRS
Encodes a point as a MGRS string

Returns
MGRS
Parameters
- point: Point
  
  point
Returns MGRS
- Defined in lib/MGRS.ts:398

`Static` getColumnLetter

getColumnLetter(zoneNumber: number, easting: number): string
Get the column letter from the zone number and easting

Returns
column letter
Parameters
- zoneNumber: number
  
  zone number
- easting: number
  
  easting
Returns string
- Defined in lib/MGRS.ts:667

`Static` getColumnLetterFromUTM

getColumnLetterFromUTM(utm: UTM): string
Get the column letter from the UTM

Returns
column letter
Parameters
- utm: UTM
  
  UTM
Returns string
- Defined in lib/MGRS.ts:654

`Static` getColumnRowId

getColumnRowId(easting: number, northing: number, zoneNumber: number): string
Get the two letter column and row 100k designator for a given UTM easting, northing and zone number value

Returns
the two letter column and row 100k designator
Parameters
- easting: number
  
  easting
- northing: number
  
  northing
- zoneNumber: number
  
  zone number
Returns string
- Defined in lib/MGRS.ts:639

`Static` getRowLetter

getRowLetter(zoneNumber: number, northing: number): string
Get the row letter from the zone number and northing

Returns
row letter
Parameters
- zoneNumber: number
  
  zone number
- northing: number
  
  northing
Returns string
- Defined in lib/MGRS.ts:695

`Static` getRowLetterFromUTM

getRowLetterFromUTM(utm: UTM): string
Get the row letter from the UTM

Returns
row letter
Parameters
- utm: UTM
  
  UTM
Returns string
- Defined in lib/MGRS.ts:682

`Static` isMGRS

isMGRS(mgrs: string): boolean
Return whether the given string is valid MGRS string

Returns
true if MGRS string is valid, false otherwise
Parameters
- mgrs: string
  
  potential MGRS string
Returns boolean
- Defined in lib/MGRS.ts:375

`Static` parse

parse(mgrs: string): MGRS
Parse a MGRS string

Returns
MGRS

Throws
ParseException upon failure to parse the MGRS string
Parameters
- mgrs: string
  
  MGRS string
Returns MGRS
- Defined in lib/MGRS.ts:425

`Static` precision

precision(mgrs: string): GridType
Parse the MGRS string for the precision

Returns
grid type precision

Throws
ParseException upon failure to parse the MGRS string
Parameters
- mgrs: string
  
  MGRS string
Returns GridType
- Defined in lib/MGRS.ts:591

Generated using TypeDoc