Class GridRange

Grid Range

Hierarchy

GridRange

Implements

IterableIterator<GARS>

Index

Constructors

Methods

[iterator] getBandLettersRange getBandNumberRange getBounds next setBandLettersRange setBandNumberRange

Constructors

constructor

new GridRange(bandNumberRange?: BandNumberRange, bandLettersRange?: BandLettersRange): GridRange
Constructor (full range if no parameters)
Parameters
- bandNumberRange: BandNumberRange = ...
  
  band number range
- bandLettersRange: BandLettersRange = ...
  
  band letters range
Returns GridRange
- Defined in lib/grid/GridRange.ts:45

Methods

[iterator]

[iterator](): IterableIterator<GARS>
Returns IterableIterator<GARS>
Implementation of IterableIterator.__@iterator@56
- Defined in lib/grid/GridRange.ts:138

getBandLettersRange

getBandLettersRange(): BandLettersRange
Get the band letters range

Returns
band letters range

Returns BandLettersRange
- Defined in lib/grid/GridRange.ts:81

getBandNumberRange

getBandNumberRange(): BandNumberRange
Get the band number range

Returns
band number range

Returns BandNumberRange
- Defined in lib/grid/GridRange.ts:62

getBounds

getBounds(): Bounds
Get the grid range bounds

Returns
bounds

Returns Bounds
- Defined in lib/grid/GridRange.ts:100

next

next(): IteratorResult<GARS, any>
Returns IteratorResult<GARS, any>
Implementation of IterableIterator.next
- Defined in lib/grid/GridRange.ts:109

setBandLettersRange

setBandLettersRange(bandLettersRange: BandLettersRange): void
Set the band letters range
Parameters
- bandLettersRange: BandLettersRange
  
  band letters range
Returns void
- Defined in lib/grid/GridRange.ts:91

setBandNumberRange

setBandNumberRange(bandNumberRange: BandNumberRange): void
Set the band number range
Parameters
- bandNumberRange: BandNumberRange
  
  band number range
Returns void
- Defined in lib/grid/GridRange.ts:72

Generated using TypeDoc