This version of the documentation is outdated! Click here for the latest released version.

compassHeading

A CompassHeading object is returned to the [compassSuccess](compassSuccess.html) callback function.

Properties

magneticHeading: The heading in degrees from 0 - 359.99 at a single moment in time. (Number)
trueHeading: The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. (Number)
headingAccuracy: The deviation in degrees between the reported heading and the true heading. (Number)
timestamp: The time at which this heading was determined. (milliseconds)

The CompassHeading object is returned to the [compassSuccess](compassSuccess.html) callback function.

trueHeading is not supported, but reports the same value as magneticHeading
headingAccuracy is always 0 because there is no difference between the magneticHeading and trueHeading.

trueHeading is only returned when location services are enabled via navigator.geolocation.watchLocation()
For iOS 4 devices and above, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.