title: Screen Orientation description: Set the screen orientation
Cordova Screen Orientation Plugin
Cordova plugin to set/lock the screen orientation in a common way for iOS, Android, and windows-uwp. This plugin is based on Screen Orientation API so the api matches the current spec.
The plugin adds the following to the screen object (
// lock the device orientationorientation// unlock the orientationorientation// current orientationorientation
cordova plugin add cordova-plugin-screen-orientation
The orientation is in the primary portrait mode.
The orientation is in the secondary portrait mode.
The orientation is in the primary landscape mode.
The orientation is in the secondary landscape mode.
The orientation is either portrait-primary or portrait-secondary (sensor).
The orientation is either landscape-primary or landscape-secondary (sensor).
orientation is unlocked - all orientations are supported.
// set to either landscapescreenorientation;// allow user rotatescreenorientation;// access current orientationconsole;
Both android and iOS will fire the orientationchange event on the window object. For this version of the plugin use the window object if you require notification.
The 'change' event listener has also been added to the screen.orientation object.
The screen.orientation property will not update when the phone is rotated 180 degrees.
Windows UWP Notes
Windows store apps (windows-uwp) will only display orientation changes if the device has some sort of accelerometer. The internal state of the "orientation" will still be kept, but the actual screen won't rotate unless the device supports it.