Cordova Version:

ドキュメントTOP » API の解説 » 基本 Cordova プラグイン ( Cordova のコア プラグイン ) » 端末のオリエンテーション検知 プラグイン

端末のオリエンテーション検知 プラグイン

テスト環境 ( バージョン番号 ) : 1.0.7

注釈

このプラグインの詳細は、こちらの原文 ( GitHub ) をご確認ください。

このプラグインを使用して、端末のコンパスにアクセスします。コンパスは、端末が指し示す方向・方位を検知するセンサーの 1 種です。通常、端末の上部最先端を起点として、0 から 359.99 度の角度で方位を示します。0 は、北を意味します。

このプラグインは、グローバルな navigator.compass オブジェクトを定義します。 グローバルスコープでは、deviceready イベントの発火後まで使用できません。

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.compass);
}

プラグイン ID

cordova-plugin-device-orientation

プラグインの追加方法 ( Monaca 上での処理 )

このプラグインを使用する場合には、Monaca クラウド IDE の [ Cordova プラグインの管理 ] 上で、Device Orientation プラグインを 有効 にします。

メソッド

  • navigator.compass.getCurrentHeading
  • navigator.compass.watchHeading
  • navigator.compass.clearWatch

CompassHeading

CompassHeading オブジェクトは、compassSuccess コールバック関数に渡されます。

プロパティー

  • magneticHeading: ある瞬間の磁方位 ( 磁北を基準 )。0 から 359.99 度の方位角で表します。 (Number)

  • trueHeading: ある瞬間の真方位 ( 真北を基準 )。0 から 359.99 度の方位角で表します。負の値は、真方位の値が定まっていないことを示します。 (Number)

  • headingAccuracy: 取得した磁方位と真方位との角度の差 ( 偏角 ) (Number)

  • timestamp: 方位を取得した時間 (DOMTimeStamp)

Android 特有の動作

  • trueHeading は使用できません。magneticHeading と同じ値が返ってきます。

  • trueHeadingmagneticHeading が同じ値になるため、headingAccuracy は、常に 0 となります。

iOS 特有の動作

  • 位置情報サービスを有効にした場合のみ、navigator.geolocation.watchLocation() 経由で、trueHeading プロパティーを取得できます。

CompassError

エラーが発生した場合、CompassError オブジェクトが compassError コールバック関数に渡されます。

プロパティー

  • code: 次のエラーコードのいずれか

定数

  • CompassError.COMPASS_INTERNAL_ERR
  • CompassError.COMPASS_NOT_SUPPORTED