Class GridZone

Grid Zone

Hierarchy

GridZone

Index

Constructors

Methods

getBand getBounds getDrawBounds getHemisphere getLetter getLines getLinesFromGridType getName getNumber getStrip getStripExpand isWithin

Constructors

constructor

new GridZone(strip: LongitudinalStrip, band: LatitudeBand): GridZone
Constructor
Parameters
- strip: LongitudinalStrip
  
  longitudinal strip
- band: LatitudeBand
  
  latitude band
Returns GridZone
- Defined in lib/gzd/GridZone.ts:37

Methods

getBand

getBand(): LatitudeBand
Get the latitude band

Returns
latitude band

Returns LatitudeBand
- Defined in lib/gzd/GridZone.ts:57

getBounds

getBounds(): Bounds
Get the bounds

Returns
bounds

Returns Bounds
- Defined in lib/gzd/GridZone.ts:93

getDrawBounds

getDrawBounds(tileBounds: Bounds, gridType: GridType): undefined | Bounds
Get the draw bounds of easting and northing in meters

Returns
draw bounds or null
Parameters
- tileBounds: Bounds
  
  tile bounds
- gridType: GridType
  
  grid type
Returns undefined | Bounds
- Defined in lib/gzd/GridZone.ts:309

getHemisphere

getHemisphere(): Hemisphere
Get the hemisphere

Returns
hemisphere

Returns Hemisphere
- Defined in lib/gzd/GridZone.ts:84

getLetter

getLetter(): string
Get the band letter

Returns
band letter

Returns string
- Defined in lib/gzd/GridZone.ts:75

getLines

getLines(tileBounds: Bounds, gridType: GridType): undefined | GridLine[]
Get the grid zone lines

Returns
lines
Parameters
- tileBounds: Bounds
  
  tile bounds
- gridType: GridType
  
  grid type
Returns undefined | GridLine[]
- Defined in lib/gzd/GridZone.ts:155

getLinesFromGridType

getLinesFromGridType(gridType: GridType): undefined | GridLine[]
Get the grid zone lines

Returns
lines
Parameters
- gridType: GridType
  
  grid type
Returns undefined | GridLine[]
- Defined in lib/gzd/GridZone.ts:142

getName

getName(): string
Get the label name

Returns
name

Returns string
- Defined in lib/gzd/GridZone.ts:102

getNumber

getNumber(): number
Get the zone number

Returns
zone number

Returns number
- Defined in lib/gzd/GridZone.ts:66

getStrip

getStrip(): LongitudinalStrip
Get the longitudinal strip

Returns
longitudinal strip

Returns LongitudinalStrip
- Defined in lib/gzd/GridZone.ts:48

getStripExpand

getStripExpand(): number
Get the longitudinal strip expansion, number of additional neighbors to iterate over in combination with this strip

Returns
longitudinal strip neighbor iteration expansion

Returns number
- Defined in lib/gzd/GridZone.ts:131

isWithin

isWithin(bounds: Bounds): boolean
Is the provided bounds within the zone bounds

Returns
true if within bounds
Parameters
- bounds: Bounds
  
  bounds
Returns boolean
- Defined in lib/gzd/GridZone.ts:113

Generated using TypeDoc