Class MGRSUtils

Military Grid Reference System utilities

Hierarchy

MGRSUtils

Index

Constructors

Methods

getHemisphere getLabelName nextBandLetter previousBandLetter validateBandLetter validateZoneNumber

Constructors

constructor

new MGRSUtils(): MGRSUtils
Returns MGRSUtils

Methods

`Static` getHemisphere

getHemisphere(bandLetter: string): Hemisphere
Get the hemisphere from the band letter

Returns
hemisphere
Parameters
- bandLetter: string
  
  band letter
Returns Hemisphere
- Defined in lib/MGRSUtils.ts:102

`Static` getLabelName

getLabelName(zoneNumber: number, bandLetter: string): string
Get the label name

Returns
name
Parameters
- zoneNumber: number
  
  zone number
- bandLetter: string
  
  band letter
Returns string
- Defined in lib/MGRSUtils.ts:91

`Static` nextBandLetter

nextBandLetter(letter: string): string
Get the next band letter

Returns
next band letter, 'Y' (MGRSConstants#MAX_BAND_LETTER + 1) if no next bands
Parameters
- letter: string
  
  band letter
Returns string
- Defined in lib/MGRSUtils.ts:51

`Static` previousBandLetter

previousBandLetter(letter: string): string
Get the previous band letter

Returns
previous band letter, 'B' (MGRSConstants#MIN_BAND_LETTER - 1) if no previous bands
Parameters
- letter: string
  
  band letter
Returns string
- Defined in lib/MGRSUtils.ts:71

`Static` validateBandLetter

validateBandLetter(letter: string): void
Validate the band letter
Parameters
- letter: string
  
  band letter
Returns void
- Defined in lib/MGRSUtils.ts:33

`Static` validateZoneNumber

validateZoneNumber(zoneNumber: number): void
Validate the zone number
Parameters
- zoneNumber: number
  
  zone number
Returns void
- Defined in lib/MGRSUtils.ts:14

Generated using TypeDoc