Class GARSUtils

Global Area Reference System utilities

Hierarchy

GARSUtils

Constructors

constructor

new GARSUtils(): GARSUtils
Returns GARSUtils

Methods

`Static` bandLetter

bandLetter(bandValue: number): string
Get the latitude character equivalent from the band number (where 1 is A and 24 is Z)

Returns
single character of latitude band
Parameters
- bandValue: number
  
  number band value
Returns string
- Defined in lib/GARSUtils.ts:151

`Static` bandLetters

bandLetters(bandValue: number): string
Get the latitude band from the band number (where 1 is AA and 360 is QZ)

Returns
two character latitude band
Parameters
- bandValue: number
  
  number band value
Returns string
- Defined in lib/GARSUtils.ts:136

`Static` bandValue

bandValue(latitudeBand: string): number
Get the latitude band number equivalent to the longitude band (where AA is 1 and QZ is 360)

Returns
number band value
Parameters
- latitudeBand: string
  
  two character latitude band
Returns number
- Defined in lib/GARSUtils.ts:99

`Static` bandValueFromChar

bandValueFromChar(latitudeBand: number): number
Get the latitude character band number equivalent (where A is 1 and Z is 24)

Returns
number band value
Parameters
- latitudeBand: number
  
  single character from latitude band
Returns number
- Defined in lib/GARSUtils.ts:118

`Static` getDegreeLabel

getDegreeLabel(longitude: number, latitude: number): string
Create a degree grid label

Returns
degree label
Parameters
- longitude: number
  
  longitude
- latitude: number
  
  latitude
Returns string
- Defined in lib/GARSUtils.ts:254

`Static` getLatitude

getLatitude(band: string | number): number
Get the latitude from the latitude band letters number equivalent

Returns
latitude
Parameters
- band: string | number
  
  latitudinal band number or band letters
Returns number
- Defined in lib/GARSUtils.ts:29

`Static` getLatitudeBand

getLatitudeBand(latitude: number): string
Get the latitude band letters from the latitude

Returns
latitude band letters
Parameters
- latitude: number
  
  latitude
Returns string
- Defined in lib/GARSUtils.ts:65

`Static` getLatitudeBandValue

getLatitudeBandValue(latitude: number): number
Get the latitude band value from the latitude

Returns
latitude band value
Parameters
- latitude: number
  
  latitude
Returns number
- Defined in lib/GARSUtils.ts:76

`Static` getLatitudeDecimalBandValue

getLatitudeDecimalBandValue(latitude: number): number
Get the latitude decimal band value from the latitude

Returns
latitude decimal band value
Parameters
- latitude: number
  
  latitude
Returns number
- Defined in lib/GARSUtils.ts:87

`Static` getLongitude

getLongitude(band: number): number
Get the longitude from the longitude band

Returns
longitude
Parameters
- band: number
  
  longitudinal band number
Returns number
- Defined in lib/GARSUtils.ts:18

`Static` getLongitudeBand

getLongitudeBand(longitude: number): number
Get the longitude band from the longitude

Returns
longitude band
Parameters
- longitude: number
  
  longitude
Returns number
- Defined in lib/GARSUtils.ts:43

`Static` getLongitudeDecimalBand

getLongitudeDecimalBand(longitude: number): number
Get the longitude decimal band from the longitude

Returns
longitude decimal band
Parameters
- longitude: number
  
  longitude
Returns number
- Defined in lib/GARSUtils.ts:54

`Static` keypad

keypad(column: number, row: number): number
Get the keypad from the southwest origin 0 indexed column and row

Returns
keypad
Parameters
- column: number
  
  0 indexed column
- row: number
  
  0 indexed row
Returns number
- Defined in lib/GARSUtils.ts:241

`Static` keypadColumn

keypadColumn(keypad: number): number
Get the keypad southwest origin 0 indexed column

Returns
0 for keypads 1|4|7, 1 for keypads 2|5|8, 2 for keypads 3|6|9
Parameters
- keypad: number
  
  keypad number
Returns number
- Defined in lib/GARSUtils.ts:192

`Static` keypadRow

keypadRow(keypad: number): number
Get the keypad southwest origin 0 indexed row

Returns
0 for keypads 7|8|9, 1 for keypads 4|5|6, 2 for keypads 1|2|3
Parameters
- keypad: number
  
  keypad number
Returns number
- Defined in lib/GARSUtils.ts:209

`Static` nextPrecision

nextPrecision(value: number, precision: number): number
Get the next precision value from the precision value and precision

Returns
next precision value
Parameters
- value: number
  
  precision value
- precision: number
  
  grid precision
Returns number
- Defined in lib/GARSUtils.ts:272

`Static` quadrant

quadrant(column: number, row: number): number
Get the quadrant from the southwest origin 0 indexed column and row

Returns
quadrant
Parameters
- column: number
  
  0 indexed column
- row: number
  
  0 indexed row
Returns number
- Defined in lib/GARSUtils.ts:228

`Static` quadrantColumn

quadrantColumn(quadrant: number): number
Get the quadrant southwest origin 0 indexed column

Returns
0 for quadrants 1|3, 1 for quadrants 2|4
Parameters
- quadrant: number
  
  quadrant number
Returns number
- Defined in lib/GARSUtils.ts:170

`Static` quadrantRow

quadrantRow(quadrant: number): number
Get the quadrant southwest origin 0 indexed row

Returns
0 for quadrants 3|4, 1 for quadrants 1|2
Parameters
- quadrant: number
  
  quadrant number
Returns number
- Defined in lib/GARSUtils.ts:181

Generated using TypeDoc