Compass

Obtains the direction that the device is pointing.

Methods

Arguments

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 org.apache.cordova.device-orientation
    $ cordova plugin ls
    [ 'org.apache.cordova.device-orientation' ]
    $ cordova plugin rm org.apache.cordova.device-orientation

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

  • Amazon Fire OS

      (in `app/res/xml/config.xml`)

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

  (in app/AndroidManifest)

  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

  • Android

      (in `app/res/xml/config.xml`)

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

  (in app/AndroidManifest)

  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

  • BlackBerry 10

      (in `www/config.xml`)

  <feature name="Compass" value="Comapss" />

  • iOS (in the named application directory's 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.