github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-01-20 01:22:52 +08:00
Code Issues Projects Releases Wiki Activity

docs(screenOrientation): update docs

Browse Source
This commit is contained in:
Mike Hartington 2016-08-23 14:13:57 -04:00 committed by GitHub
parent ea58a78f62
commit dfdaa157a4
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/plugins/screen-orientation.ts
View File

@ -22,6 +22,17 @@ declare var window;
* ScreenOrientation.unlockOrientation();
* ```
*
* @advanced
* Accepted orientation values:
* | Value | Description |
* |-------------------------------|------------------------------------------------------------------------------|
* | portrait-primary | The orientation is in the primary portrait mode. |
* | portrait-secondary | The orientation is in the secondary portrait mode. |
* | landscape-primary | The orientation is in the primary landscape mode. |
* | landscape-secondary | The orientation is in the secondary landscape mode. |
* | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). |
* | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). |
*
*/
@Plugin({
plugin: 'cordova-plugin-screen-orientation',
@ -33,17 +44,7 @@ export class ScreenOrientation {
/**
* Lock the orientation to the passed value.
*
* Accepted orientation values:
* | Value | Description |
* |-------------------------------|------------------------------------------------------------------------------|
* | portrait-primary | The orientation is in the primary portrait mode. |
* | portrait-secondary | The orientation is in the secondary portrait mode. |
* | landscape-primary | The orientation is in the primary landscape mode. |
* | landscape-secondary | The orientation is in the secondary landscape mode. |
* | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). |
* | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). |
*
* See below for accepted values
* @param {orientation} The orientation which should be locked. Accepted values see table above.
*/
@Cordova({ sync: true })