メニューに進む

@capgo/capacitor-compass

Capacitor Compass Plugin interface for reading device compass heading.

Capacitor Compass Plugin interface for reading device compass heading.

  • getCurrentHeading - iOSではバックグラウンドで、最新の値が返されます。Androidでは、加速度計と磁気センサを使用して、メソッドが呼び出されたときにヘッディングが計算されます。Webでは実装されていません。
  • startListening - コンパスヘッディングの変更をイベントを介してリスニングすることができます。この機能でコンパスセンサを開始し、’headingChange’イベントを発行します。
  • stopListening - コンパスヘッディングの変更をリスニングすることを停止します。この機能でコンパスセンサを停止し、イベントの発行を停止します。
  • checkPermissions - コンパスデータへのアクセスをチェックするための現在の許可状態を確認します。iOSでは、位置許可状態をチェックします。Androidでは、許可が必要ないため常に’granted’を返します。
Method説明
getCurrentHeadingiOSではバックグラウンドでヘッディングが更新され、最新の値が返されます。Androidでは、加速度計と磁気センサを使用してヘッディングが計算されます。Webでは実装されていません。
getPluginVersionnative Capacitor プラグインのバージョンを取得します。
startListeningコンパスヘッディングの変更をイベントで受信するように始めます。このメソッドはコンパスセンサを開始し、‘headingChange’ イベントを発行します。
stopListeningコンパスヘッディングの変更をイベントで受信するように停止します。このメソッドはコンパスセンサを停止し、イベントの発行を停止します。
addListenerコンパスヘッディングの変更イベントにリスナーを追加します。
addListenerコンパス精度の変更イベントにリスナーを追加します。Androidのみでサポートされています。iOSとWebではイベントが発行されることはありません。
removeAllListenersこのプラグインのすべてのリスナーを削除します。
checkPermissionsコンパスデータへのアクセス権限の現在の状態を確認します。iOSでは位置情報の許可状態を確認します。Androidでは、常に ‘granted’ が返されます。許可が必要ありません。
requestPermissionsコンパスデータへのアクセスを許可する。
watchAccuracyiOSでは位置情報の許可を要求し、ヘッディングデータのために必要です。Androidでは、許可が必要ないためすぐに解決されます。
unwatchAccuracyコンパス精度の監視を開始します。
getAccuracyAndroidでは磁気センサの精度を監視し、精度の変更イベントを発行します。開発者はこれらのイベントにリスナーを設定し、カリブレーションの促すUIを実装できます。

iOSとWebでは、このメソッドは何も実行しません。コンパス精度の監視は利用できません。

コンパス精度の監視を停止します。

コンパス精度の現在のレベルを取得します。 src/definitions.ts Androidでは、現在の磁気センサの精度を返します。 capacitor-compass.

このリファレンスは、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compassからsyncedされています。 @capgo/capacitor-compass ネイティブ プラグインの作業計画に接続する Using @capgo/capacitor-compass Using @capgo/capacitor-compass Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリ Capacitor プラグイン ( Capgo ) Capacitor プラグイン ( Capgo ) プラグインの追加または更新 プラグインの追加または更新 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替