license: > Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

title: Compass

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 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.