orientation

Orientation模块管理设备的方向信息，包括alpha、beta、gamma三个方向信息，通过plus.orientation可获取设备方向管理对象。

方法：

对象：

回调方法：

权限：

5+功能模块（permissions）

  2. {
  3. // ...
  4. "permissions":{
  5.     // ...
  6.     "Orientation": {
  7.         "description": "方向传感器"
  8.     }
  9. }
  10. }
  11.

getCurrentOrientation

获取当前设备的方向信息，包括alpha、beta、gamma三个方向信息

  2. void plus.orientation.getCurrentOrientation( successCB, errorCB );
  3.

说明：

方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。 方向信息可通过successCB回调函数返回。方向信息获取失败则调用回调函数errorCB

参数：

返回值：

void: 无

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

示例：

  2. <!DOCTYPE html>
  3. <html>
  4.     <head>
  5.     <meta charset="utf-8">
  6.     <title>Orientation Example</title>
  7.     <script type="text/javascript">
  8. // 扩展API加载完毕后调用onPlusReady回调函数 
  9. document.addEventListener( "plusready", onPlusReady, false );
  10. // 扩展API加载完毕，现在可以正常调用扩展API
  11. function onPlusReady() {
  12.     plus.orientation.getCurrentOrientation( function ( o ) {
  13.         alert( "Orientation\nAlpha:" + o.alpha + "\nBeta:" + o.beta + "\nGamma:" + o.gamma );
  14.     } ); 
  15. }
  16.     </script>
  17.     </head>
  18.     <body>
  19.         Orientation
  20.     </body>
  21. </html>
  22.

uni-app使用plus注意事项

watchOrientation

监听设备方向信息的变化

  2. Number plus.orientation.watchOrientation( successCB, errorCB, option );
  3.

说明：

方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。watchOrientation每隔固定时间就获取一次设备的方向信息，通过successCB回调函数返回。可通过option的frequency参数设定获取设备方向信息的时间间隔。方向信息获取失败则调用回调函数errorCB。

参数：

返回值：

Number: 用于标识方向信息监听器，可通过clearWatch方法取消监听。

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

示例：

  2. <!DOCTYPE html>
  3. <html>
  4.     <head>
  5.     <meta charset="utf-8">
  6.     <title>Orientation Example</title>
  7.     <script type="text/javascript">
  8. // 扩展API加载完毕后调用onPlusReady回调函数 
  9. document.addEventListener( "plusready", onPlusReady, false );
  10. // 扩展API加载完毕，现在可以正常调用扩展API
  11. function onPlusReady() {
  12.     plus.orientation.watchOrientation( function ( o ) {
  13.         alert( "Orientation\nAlpha:" + o.alpha + "\nBeta:" + o.beta + "\nGamma:" + o.gamma );
  14.     }, function ( e ) {
  15.         alert( "Orientation error: " + e.message ); 
  16.     } ); 
  17. }
  18.     </script>
  19.     </head>
  20.     <body>
  21.         Orientation watch
  22.     </body>
  23. </html>
  24.

uni-app使用plus注意事项

clearWatch

关闭监听设备方向信息

  2. void plus.orientation.clearWatch( watchId );
  3.

参数：

  • watchId: (Number)必选 需要取消的方向监听器标识，调用watchOrientation方法的返回值。

返回值：

void: 无

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

OrientationOption

JSON对象，监听设备方向感应器参数

属性：

  • frequency: (Number类型)更新方向信息的时间间隔数值类型，单位为ms，默认值为500ms。

Rotation

JSON对象，设备方向信息数据

  2. interface Rotation {
  3.     readonly attribute float alpha;
  4.     readonly attribute float beta;
  5.     readonly attribute float gamma;
  6.     readonly attribute float magneticHeading;
  7.     readonly attribute float trueHeading;
  8.     readonly attribute float headingAccuracy;
  9. }
  10.

属性：

  • alpha: (float类型)以z方向为轴心的旋转角度浮点数类型，只读属性，取值范围为0到360（不等于360）。

  • beta: (float类型)以x方向为轴心的旋转角度浮点数类型，只读属性，取值范围为-180到180（不等于180）。

  • gamma: (float类型)以y方向为轴心的旋转角度浮点数类型，只读属性，取值范围为-180到180（不等于180）。

  • magneticHeading: (float类型)设备方向与地球磁场北极方向的角度浮点数类型，只读属性，取值范围为0到360（不等于360）。

平台支持

  • Android - 2.2+ (支持)
  • iOS - 4.3+ (支持): iTouch、iPad设备不支持
    • trueHeading: (float类型)设备方向与地球真实北极方向的角度浮点数类型，只读属性，取值范围为0到360（不等于360）。

平台支持

  • Android - 2.2+ (支持)
  • iOS - 4.3+ (支持): iTouch、iPad设备不支持
    • headingAccuracy: (float类型)设备方向值的误差值浮点数类型，只读属性，取值范围为0到360（不等于360）。

平台支持

  • Android - 2.2+ (支持)
  • iOS - 4.3+ (支持): iTouch、iPad设备不支持

OrientationSuccessCallback

获取设备方向信息成功的回调函数

  2. void onSuccess( rotation ){
  3.     // Get orientation success code.
  4. }
  5.

参数：

  • rotation: (DOMString)必选 设备的方向信息Rotation

返回值：

void: 无

OrientationErrorCallback

获取设备方向信息失败的回调函数

  2. void onError( error ) {
  3.     // Get orientation error code. 
  4. }
  5.

参数：

  • error: (DOMException)必选 失败信息

返回值：

void: 无