Device Orientation

Improve this doc

Requires Cordova plugin: cordova-plugin-device-orientation. For more info, please see the Device Orientation docs.

Repo: https://github.com/apache/cordova-plugin-device-orientation

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-device-orientation
   $ npm install --save @ionic-native/device-orientation@4
   

2. Add this plugin to your app's module

Supported platforms

• Amazon Fire OS
• Android
• BlackBerry 10
• Browser
• Firefox OS
• iOS
• Tizen
• Ubuntu
• Windows
• Windows Phone

Usage

// DeviceOrientationCompassHeading is an interface for compass
import { DeviceOrientation, DeviceOrientationCompassHeading } from '@ionic-native/device-orientation';

constructor(private deviceOrientation: DeviceOrientation) { }

...

// Get the device current compass heading
this.deviceOrientation.getCurrentHeading().then(
  (data: DeviceOrientationCompassHeading) => console.log(data),
  (error: any) => console.log(error)
);

// Watch the device compass heading change
var subscription = this.deviceOrientation.watchHeading().subscribe(
  (data: DeviceOrientationCompassHeading) => console.log(data)
);

// Stop watching heading change
subscription.unsubscribe();

Instance Members

getCurrentHeading()

Get the current compass heading.

watchHeading(options)

Get the device current heading at a regular interval

Stop the watch by unsubscribing from the observable

DeviceOrientationCompassOptions

DeviceOrientationCompassHeading