Class: UserFacilityUtils

Defined in: src/sdk/navigation/FacilityUtils.ts:325

Utility functions for working with user facilities.

Constructors

Constructor

new UserFacilityUtils(): UserFacilityUtils

Returns

UserFacilityUtils

Methods

createFromLatLon()

Call Signature

static createFromLatLon(icao, lat, lon, isTemporary?, name?): UserFacility

Defined in: src/sdk/navigation/FacilityUtils.ts:338

Creates a user facility from latitude/longitude coordinates.

Parameters

Parameter	Type	Description
icao	string	The ICAO string of the new facility.
lat	number	The latitude of the new facility.
lon	number	The longitude of the new facility.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility

A new user facility.

Deprecated

Use the IcaoValue overload instead.

Call Signature

static createFromLatLon(icao, lat, lon, isTemporary?, name?): UserFacility

Defined in: src/sdk/navigation/FacilityUtils.ts:348

Creates a user facility from latitude/longitude coordinates.

Parameters

Parameter	Type	Description
icao	IcaoValue	The ICAO value of the new facility.
lat	number	The latitude of the new facility.
lon	number	The longitude of the new facility.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility

A new user facility.

---

createFromRadialDistance()

Call Signature

static createFromRadialDistance(icao, reference, radial, distance, isTemporary?, name?): UserFacility

Defined in: src/sdk/navigation/FacilityUtils.ts:377

Creates a user facility from a radial and distance relative to a reference facility.

Parameters

Parameter	Type	Description
icao	string	The ICAO string of the new facility.
reference	Facility	The reference facility.
radial	number	The magnetic radial, in degrees, of the reference facility on which the new facility lies.
distance	number	The distance, in nautical miles, from the reference facility.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility

A new user facility.

Deprecated

Use the IcaoValue overload instead.

Call Signature

static createFromRadialDistance(icao, reference, radial, distance, isTemporary?, name?): UserFacility

Defined in: src/sdk/navigation/FacilityUtils.ts:388

Creates a user facility from a radial and distance relative to a reference facility.

Parameters

Parameter	Type	Description
icao	IcaoValue	The ICAO value of the new facility.
reference	Facility	The reference facility.
radial	number	The magnetic radial, in degrees, of the reference facility on which the new facility lies.
distance	number	The distance, in nautical miles, from the reference facility.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility

A new user facility.

---

createFromRadialRadial()

Call Signature

static createFromRadialRadial(icao, reference1, radial1, reference2, radial2, isTemporary?, name?): UserFacility | undefined

Defined in: src/sdk/navigation/FacilityUtils.ts:424

Creates a user facility from a radial and distance relative to a reference facility.

Parameters

Parameter	Type	Description
icao	string	The ICAO string of the new facility.
reference1	Facility	The first reference facility.
radial1	number	The magnetic radial, in degrees, of the first reference facility on which the new facility lies.
reference2	Facility	The second reference facility.
radial2	number	The magnetic radial, in degrees, of the second reference facility on which the new facility lies.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility | undefined

A new user facility, or undefined if the specified radials do not intersect at a unique point.

Deprecated

Use the IcaoValue overload instead.

Call Signature

static createFromRadialRadial(icao, reference1, radial1, reference2, radial2, isTemporary?, name?): UserFacility | undefined

Defined in: src/sdk/navigation/FacilityUtils.ts:444

Creates a user facility from a radial and distance relative to a reference facility.

Parameters

Parameter	Type	Description
icao	IcaoValue	The ICAO value of the new facility.
reference1	Facility	The first reference facility.
radial1	number	The magnetic radial, in degrees, of the first reference facility on which the new facility lies.
reference2	Facility	The second reference facility.
radial2	number	The magnetic radial, in degrees, of the second reference facility on which the new facility lies.
isTemporary?	boolean	Whether the new facility is temporary. Defaults to false.
name?	string	The name of the new facility. Defaults to empty string.

Returns

UserFacility | undefined

A new user facility, or undefined if the specified radials do not intersect at a unique point.