# orientation

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

## 方法：

- getCurrentOrientation: 获取当前设备的方向信息，包括alpha、beta、gamma三个方向信息
- watchOrientation: 监听设备方向信息的变化
- clearWatch: 关闭监听设备方向信息

## 对象：

- OrientationOption: JSON对象，监听设备方向感应器参数
- Rotation: JSON对象，设备方向信息数据

## 回调方法：

- OrientationSuccessCallback: 获取设备方向信息成功的回调函数
- OrientationErrorCallback: 获取设备方向信息失败的回调函数

## 权限：

5+功能模块（permissions）

    {
    // ...
    "permissions":{
    	// ...
    	"Orientation": {
    		"description": "方向传感器"
    	}
    }
    }

# OrientationOption

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

## 属性：

- frequency: (Number 类型 )更新方向信息的时间间隔

  数值类型，单位为ms，默认值为500ms。

# Rotation

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

    interface Rotation {
    	readonly attribute float alpha;
    	readonly attribute float beta;
    	readonly attribute float gamma;
    	readonly attribute float magneticHeading;
    	readonly attribute float trueHeading;
    	readonly attribute float headingAccuracy;
    }

## 属性：

- alpha: (float 类型 )以z方向为轴心的旋转角度

  浮点数类型，只读属性，取值范围为0到360（不等于360）。

- beta: (float 类型 )以x方向为轴心的旋转角度

  浮点数类型，只读属性，取值范围为-180到180（不等于180）。

- gamma: (float 类型 )以y方向为轴心的旋转角度

  浮点数类型，只读属性，取值范围为-180到180（不等于180）。

- magneticHeading: (float 类型 )设备方向与地球磁场北极方向的角度

  浮点数类型，只读属性，取值范围为0到360（不等于360）。

- trueHeading: (float 类型 )设备方向与地球真实北极方向的角度

  浮点数类型，只读属性，取值范围为0到360（不等于360）。

- headingAccuracy: (float 类型 )设备方向值的误差值

  浮点数类型，只读属性，取值范围为0到360（不等于360）。

# OrientationSuccessCallback

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

    void onSuccess( rotation ){
    	// Get orientation success code.
    }

## 参数：

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

## 返回值：

void : 无

# OrientationErrorCallback

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

    void onError( error ) {
    	// Get orientation error code.
    }

## 参数：

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

## 返回值：

void : 无