Class UTM

Universal Transverse Mercator Projection

Hierarchy

UTM

Index

Constructors

Methods

format getEasting getHemisphere getNorthing getZone toMGRS toPoint toString create from isUTM parse point

Constructors

constructor

new UTM(zone: number, hemisphere: Hemisphere, easting: number, northing: number): UTM
Constructor
Parameters
- zone: number
  
  zone number
- hemisphere: Hemisphere
  
  hemisphere
- easting: number
  
  easting
- northing: number
  
  northing
Returns UTM
- Defined in lib/utm/UTM.ts:82

Methods

format

format(): string
Format to a UTM string

Returns
UTM string

Returns string
- Defined in lib/utm/UTM.ts:475

getEasting

getEasting(): number
Get the easting

Returns
easting

Returns number
- Defined in lib/utm/UTM.ts:112

getHemisphere

getHemisphere(): Hemisphere
Get the hemisphere

Returns
hemisphere

Returns Hemisphere
- Defined in lib/utm/UTM.ts:103

getNorthing

getNorthing(): number
Get the northing

Returns
northing

Returns number
- Defined in lib/utm/UTM.ts:121

getZone

getZone(): number
Get the zone number

Returns
zone number

Returns number
- Defined in lib/utm/UTM.ts:94

toMGRS

toMGRS(): MGRS
Convert to a MGRS coordinate

Returns
MGRS

Returns MGRS
- Defined in lib/utm/UTM.ts:466

toPoint

toPoint(): Point
Convert to a point

Returns
point

Returns Point
- Defined in lib/utm/UTM.ts:130

toString

toString(): string
{@inheritDoc}

Returns string
- Defined in lib/utm/UTM.ts:494

`Static` create

create(zone: number, hemisphere: Hemisphere, easting: number, northing: number): UTM
Create

Returns
UTM
Parameters
- zone: number
  
  zone number
- hemisphere: Hemisphere
  
  hemisphere
- easting: number
  
  easting
- northing: number
  
  northing
Returns UTM
- Defined in lib/utm/UTM.ts:49

`Static` from

from(point: Point, zone?: number, hemisphere?: Hemisphere): UTM
Create from a coordinate, zone number, and hemisphere

Returns
UTM
Parameters
- point: Point
  
  coordinate
- Optional zone: number
  
  zone number
- Optional hemisphere: Hemisphere
  
  hemisphere
Returns UTM
- Defined in lib/utm/UTM.ts:547

`Static` isUTM

isUTM(utm: string): boolean
Return whether the given string is valid UTM string

Returns
true if UTM string is valid, false otherwise
Parameters
- utm: string
  
  potential UTM string
Returns boolean
- Defined in lib/utm/UTM.ts:505

`Static` parse

parse(utm: string): UTM
Parse a UTM value (Zone N|S Easting Northing)

Returns
UTM

Throws
ParseException upon failure to parse UTM value
Parameters
- utm: string
  
  UTM value
Returns UTM
- Defined in lib/utm/UTM.ts:518

`Static` point

point(zone: number, hemisphere: Hemisphere, easting: number, northing: number): Point
Create a point from the UTM attributes

Returns
point
Parameters
- zone: number
  
  zone number
- hemisphere: Hemisphere
  
  hemisphere
- easting: number
  
  easting
- northing: number
  
  northing
Returns Point
- Defined in lib/utm/UTM.ts:66

Generated using TypeDoc