Class GeoPoint

Creates a new GeoPoint instance From latitude and longitude From a json object Or an tuple of latitude and longitude

Hierarchy

GeoPoint

Index

Constructors

constructor

new GeoPoint(latitude?: string | number | [number, number] | {
latitude: number;
longitude: number;
}, longitude?: number): GeoPoint
Parameters
- Optional latitude: string | number | [number, number] | {
  latitude: number;
  longitude: number;
  }
  
  A coordinate pair (latitude first), a GeoPoint like object or the GeoPoint's latitude
- Optional longitude: number
  
  The GeoPoint's longitude
Returns GeoPoint
- Defined in lib/GeoPoint.ts:61

Properties

latitude

latitude: number

Latitude of the given point

longitude

longitude: number

Longitude of the given point

`Static` `Readonly` DEG_TO_RAD

DEG_TO_RAD: number = ...

How many radians fit in one degree.

`Static` `Readonly` EARTH_RADIUS_IN_KILOMETERS

EARTH_RADIUS_IN_KILOMETERS: 6371 = 6371

The Earth radius in kilometers used by kilometersTo

`Static` `Readonly` EARTH_RADIUS_IN_MILES

EARTH_RADIUS_IN_MILES: 3956 = 3956

The Earth radius in miles used by milesTo

Methods

kilometersTo

kilometersTo(point: GeoPoint): number
Returns the distance from this GeoPoint to another in kilometers.

Returns
The distance in kilometers

See
GeoPoint#radiansTo
Parameters
- point: GeoPoint
  
  another GeoPoint
Returns number
- Defined in lib/GeoPoint.ts:98

milesTo

milesTo(point: GeoPoint): number
Returns the distance from this GeoPoint to another in miles.

Returns
The distance in miles

See
GeoPoint#radiansTo
Parameters
- point: GeoPoint
  
  another GeoPoint
Returns number
- Defined in lib/GeoPoint.ts:109

radiansTo

radiansTo(point: GeoPoint): number
Computes the arc, in radian, between two WGS-84 positions.

The haversine formula implementation is taken from: http://www.movable-type.co.uk/scripts/latlong.html

Returns the distance from this GeoPoint to another in radians.

Returns
the arc, in radian, between two WGS-84 positions

See
http://en.wikipedia.org/wiki/Haversine_formula
Parameters
- point: GeoPoint
  
  another GeoPoint
Returns number
- Defined in lib/GeoPoint.ts:125

toJSON

toJSON(): JsonMap
Returns a JSON representation of the GeoPoint

Returns
A GeoJson object of this GeoPoint

Returns JsonMap
- Defined in lib/GeoPoint.ts:147

toString

toString(): string
A String representation in latitude, longitude format

Returns
The string representation of this class

Returns string
- Defined in lib/GeoPoint.ts:139

`Static` current

current(): Promise<GeoPoint>
Creates a GeoPoint with the user's current location, if available.

Returns
A promise that will be resolved with a GeoPoint

Returns Promise<GeoPoint>
- Defined in lib/GeoPoint.ts:39

Class GeoPoint

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional latitude: string | number | [number, number] | { latitude: number; longitude: number; }

Optional longitude: number

Returns GeoPoint

Properties

latitude

longitude

Static Readonly DEG_TO_RAD

Static Readonly EARTH_RADIUS_IN_KILOMETERS

Static Readonly EARTH_RADIUS_IN_MILES

Methods

kilometersTo

Returns

See

Parameters

point: GeoPoint

Returns number

milesTo

Returns

See

Parameters

point: GeoPoint

Returns number

radiansTo

Returns

See

Parameters

point: GeoPoint

Returns number

toJSON

Returns

Returns JsonMap

toString

Returns

Returns string

Static current

Returns

Returns Promise<GeoPoint>

Settings

Member Visibility

Theme

`Optional` latitude: string | number | [number, number] | {
latitude: number;
longitude: number;
}

`Optional` longitude: number

`Static` `Readonly` DEG_TO_RAD

`Static` `Readonly` EARTH_RADIUS_IN_KILOMETERS

`Static` `Readonly` EARTH_RADIUS_IN_MILES

`Static` current