axes

Constants

AXES

Enum-like object of supported coordinate axis identifiers.

AXES = {
  LATITUDE: 'LAT',
  LONGITUDE: 'LON',
  ALTITUDE: 'ALT'
}

isAxis

Signature

isAxis(axis)

Description

Returns true if axis is a recognized axis value from AXES.

Parameters

Name	Type	Required	Description
axis	string	yes	Value to check

Returns

Type	Description
boolean	true if the value is a valid axis

Throws

Throws if axis is not a string.

Examples

isAxis('LAT')     // true
isAxis('LON')     // true
isAxis('ALT')     // true
isAxis('X')       // false

isLatitude

Signature

isLatitude(axis)

Description

Returns true if axis is the latitude axis ('LAT').

Parameters

Name	Type	Required	Description
axis	string	yes	Value to check

Returns

Type	Description
boolean	true if the axis is latitude

Throws

Throws if axis is not a string.

Examples

isLatitude('LAT')   // true
isLatitude('LON')   // false

isLongitude

Signature

isLongitude(axis)

Description

Returns true if axis is the longitude axis ('LON').

Parameters

Name	Type	Required	Description
axis	string	yes	Value to check

Returns

Type	Description
boolean	true if the axis is longitude

Throws

Throws if axis is not a string.

Examples

isLongitude('LON')   // true
isLongitude('LAT')   // false

isAltitude

Signature

isAltitude(axis)

Description

Returns true if axis is the altitude axis ('ALT').

Parameters

Name	Type	Required	Description
axis	string	yes	Value to check

Returns

Type	Description
boolean	true if the axis is altitude

Throws

Throws if axis is not a string.

Examples

isAltitude('ALT')   // true
isAltitude('LAT')   // false