Class BandLettersRange

Latitude Band Letters Range

Hierarchy

BandLettersRange

Implements

IterableIterator<string>

Index

Constructors

Methods

[iterator] getNorth getNorthLatitude getNorthValue getSouth getSouthLatitude getSouthValue next reset setNorth setSouth

Constructors

constructor

new BandLettersRange(south?: string, north?: string): BandLettersRange
Constructor (full range if no parameters provided)
Parameters
- south: string = GARSConstants.MIN_BAND_LETTERS
  
  southern band letters
- north: string = GARSConstants.MAX_BAND_LETTERS
  
  northern band letters
Returns BandLettersRange
- Defined in lib/grid/BandLettersRange.ts:38

Methods

[iterator]

[iterator](): IterableIterator<string>
Returns IterableIterator<string>
Implementation of IterableIterator.__@iterator@56
- Defined in lib/grid/BandLettersRange.ts:137

getNorth

getNorth(): string
Get the northern band letters

Returns
northern band letters

Returns string
- Defined in lib/grid/BandLettersRange.ts:69

getNorthLatitude

getNorthLatitude(): number
Get the northern latitude

Returns
latitude

Returns number
- Defined in lib/grid/BandLettersRange.ts:115

getNorthValue

getNorthValue(): number
Get the norther band letters equivalent number value

Returns
norther band letters value

Returns number
- Defined in lib/grid/BandLettersRange.ts:97

getSouth

getSouth(): string
Get the southern band letters

Returns
southern band letters

Returns string
- Defined in lib/grid/BandLettersRange.ts:50

getSouthLatitude

getSouthLatitude(): number
Get the southern latitude

Returns
latitude

Returns number
- Defined in lib/grid/BandLettersRange.ts:106

getSouthValue

getSouthValue(): number
Get the southern band letters equivalent number value

Returns
southern band letters value

Returns number
- Defined in lib/grid/BandLettersRange.ts:88

next

next(): IteratorResult<string, any>
Returns IteratorResult<string, any>
Implementation of IterableIterator.next
- Defined in lib/grid/BandLettersRange.ts:119

reset

reset(): void
Returns void
- Defined in lib/grid/BandLettersRange.ts:133

setNorth

setNorth(north: string): void
Set the northern band letters
Parameters
- north: string
  
  northern band letters
Returns void
- Defined in lib/grid/BandLettersRange.ts:79

setSouth

setSouth(south: string): void
Set the southern band letters
Parameters
- south: string
  
  southern band letters
Returns void
- Defined in lib/grid/BandLettersRange.ts:60

Generated using TypeDoc