qibla/.github/wiki/api/functions/qiblaGreatCircle.md

880 B

@acamarata/qibla v1.1.1


@acamarata/qibla / qiblaGreatCircle

Function: qiblaGreatCircle()

qiblaGreatCircle(lat, lng, steps?): [number, number][]

Defined in: index.ts:98

Great-circle waypoints from [lat, lng] to the Ka'bah.

Uses the Slerp (spherical linear interpolation) formula. Useful for drawing Qibla direction lines on maps.

Parameters

lat

number

Origin latitude in decimal degrees.

lng

number

Origin longitude in decimal degrees.

steps?

number = 120

Number of segments (default: 120, producing 121 points).

Returns

[number, number][]

Array of [latitude, longitude] pairs in degrees.

Throws

If latitude is outside [-90, 90] or longitude outside [-180, 180].