Compass

Obtains the direction that the device is pointing.

Methods

• compass.getCurrentHeading
• compass.watchHeading
• compass.clearWatch
• compass.watchHeadingFilter (obsolete)
• compass.clearWatchFilter (obsolete)

Arguments

• compassSuccess
• compassError
• compassOptions
• compassHeading

Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-line Interface, to add or remove this feature for a project:

    $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
    $ cordova plugin rm org.apache.cordova.core.device-orientation

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

• Android (in app/res/xml/config.xml)

    <feature name="Compass">
        <param name="android-package" value="org.apache.cordova.CompassListener" />
    </feature>
  

• iOS (in config.xml)

    <feature name="Compass">
        <param name="ios-package" value="CDVLocation" />
    </feature>
  

• Windows Phone (in Properties/WPAppManifest.xml)

    <Capabilities>
        <Capability Name="ID_CAP_SENSORS" />
    </Capabilities>
  

  Reference: Application Manifest for Windows Phone

Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.