npmpackage.info

Gathering detailed insights and metrics for cordova-plugin-device-orientation

Other packages similar to cordova-plugin-device-orientation

cordova-plugin-screen-orientation

3.0.4

Cordova Screen Orientation plugin

@types/cordova-plugin-device-orientation

1.0.9

Stub TypeScript definitions entry for cordova-plugin-device-orientation, which provides its own types definitions

@awesome-cordova-plugins/device-orientation

8.0.0

Awesome Cordova Plugins - Native plugins for ionic apps

cordova-plugin-device-rotation

0.0.1

Gives Cordova developers information about device orientation: is it facing up or down?

Gathering detailed insights and metrics for cordova-plugin-device-orientation

cordova-plugin-device-orientation - 3.0.0 | npmpackage.info

cordova-plugin-device-orientation

Apache Cordova Device Orientation Plugin

3.0.0

Apache-2.0

JavaScript

70.68 kB

4.3

Installations

npm install cordova-plugin-device-orientation

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Node Version

18.18.2

NPM Version

9.8.1 Score

75.6

Supply Chain

99.5

Quality

83.4

Maintenance

100

Vulnerability

License

Pull Requests

Open

2

Total

70

Closed

26

Merged

42

Issues

Open

6

Total

12

Closed

6

Releases

Unable to fetch releases

Languages

JavaScript

Objective-C

Java

JavaScript (50.14%)

Objective-C (28.61%)

Java (21.25%)

Developer

apache

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

60 Stars

239 Commits

79 Forks

20 Watchers

12 Branches

67 Contributors

Updated on Jul 03, 2025

Maintainers

View All 67 Contributors

Package Meta Information

Latest Version

3.0.0

Package Id

cordova-plugin-device-orientation@3.0.0

Unpacked Size

70.68 kB

Size

17.65 kB

File Count

NPM Version

9.8.1

Node Version

18.18.2

Published on

Nov 05, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@cordova/eslint-config

title: Device Orientation description: Access compass data.

cordova-plugin-device-orientation

Usage Notice

With the W3C Device Orientation API, Android, iOS, and Windows devices may not need this plugin anymore.

However, on iOS 13+, potential issues with permissions and secure contexts can arise. Therefore it is recommended to use this plugin as it uses a native implementation.

Description

This plugin provides access to the device's compass. The compass is a sensor that detects the direction or heading that the device is pointed, typically from the top of the device. It measures the heading in degrees from 0 to 359.99, where 0 is north.

Access is via a global navigator.compass object.

Although the object is attached to the global scoped navigator, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.compass);
}

Report issues on the Apache Cordova issue tracker

Installation

cordova plugin add cordova-plugin-device-orientation

Supported Platforms

Android
Browser
iOS
Windows

Methods

navigator.compass.getCurrentHeading
navigator.compass.watchHeading
navigator.compass.clearWatch

navigator.compass.getCurrentHeading

Get the current compass heading. The compass heading is returned via a CompassHeading object using the compassSuccess callback function.

navigator.compass.getCurrentHeading(compassSuccess, compassError);

Example

function onSuccess(heading) {
    alert('Heading: ' + heading.magneticHeading);
};

function onError(error) {
    alert('CompassError: ' + error.code);
};

navigator.compass.getCurrentHeading(onSuccess, onError);

navigator.compass.watchHeading

Gets the device's current heading at a regular interval. Each time the heading is retrieved, the headingSuccess callback function is executed.

The returned watch ID references the compass watch interval. The watch ID can be used with navigator.compass.clearWatch to stop watching the navigator.compass.

var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);

compassOptions may contain the following keys:

frequency: How often to retrieve the compass heading in milliseconds. (Number) (Default: 100)
filter: The change in degrees required to initiate a watchHeading success callback. When this value is set, frequency is ignored. (Number)

Example

function onSuccess(heading) {
    var element = document.getElementById('heading');
    element.innerHTML = 'Heading: ' + heading.magneticHeading;
};

function onError(compassError) {
    alert('Compass error: ' + compassError.code);
};

var options = {
    frequency: 3000
}; // Update every 3 seconds

var watchID = navigator.compass.watchHeading(onSuccess, onError, options);

Browser Quirks

Values for current heading are randomly generated in order to simulate the compass.

iOS Quirks

Only one watchHeading can be in effect at one time in iOS. If a watchHeading uses a filter, calling getCurrentHeading or watchHeading uses the existing filter value to specify heading changes. Watching heading changes with a filter is more efficient than with time intervals.

Android Quirks

No support for filter.

navigator.compass.clearWatch

Stop watching the compass referenced by the watch ID parameter.

navigator.compass.clearWatch(watchID);

watchID: The ID returned by navigator.compass.watchHeading.

Example

var watchID = navigator.compass.watchHeading(onSuccess, onError, options);

// ... later on ...

navigator.compass.clearWatch(watchID);

CompassHeading

A CompassHeading object is returned to the compassSuccess 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 can't 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. (DOMTimeStamp)

Android Quirks

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

iOS Quirks

The trueHeading property is only returned for location services enabled via navigator.geolocation.watchLocation().

CompassError

A CompassError object is returned to the compassError callback function when an error occurs.

Properties

code: One of the predefined error codes listed below.

Constants

CompassError.COMPASS_INTERNAL_ERR
CompassError.COMPASS_NOT_SUPPORTED

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/android.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/android.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/android.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/android.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/android.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/android.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/android.yml:132: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/android.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/android.yml:146: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/android.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chrome.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/chrome.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chrome.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/chrome.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ios.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/ios.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ios.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/ios.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/apache/cordova-plugin-device-orientation/lint.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/android.yml:125
Warn: npmCommand not pinned by hash: .github/workflows/android.yml:131
Warn: npmCommand not pinned by hash: .github/workflows/chrome.yml:60
Warn: npmCommand not pinned by hash: .github/workflows/chrome.yml:66
Warn: npmCommand not pinned by hash: .github/workflows/ios.yml:84
Warn: npmCommand not pinned by hash: .github/workflows/ios.yml:90
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 1 out of 3 third-party GitHubAction dependencies pinned
Info: 4 out of 10 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.3

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More