概要
概要セクションCapacitor Compass プラグインは、デバイスのコンパス向きを読み取るためのコンパス プラグイン インターフェイスです。
基本機能
基本機能セクションgetCurrentHeading- 度数で現在のコンパス向きを取得します。iOSでは、背景で更新され、最新の値が返されます。Androidでは、メソッドを呼び出すときに加速度計と磁気センサを使用して向きを計算します。Webでは実装されていません。startListening- Compass の向きの変更イベントを待ち始める。 Compass センサーを開始し、 ‘headingChange’ イベントを発行します。stopListening- Compass の向きの変更イベントを待ち止める。 Compass センサーを停止し、イベントの発行を停止します。checkPermissions- Compass データへのアクセス許可の現在のステータスを確認します。 iOS の場合、位置許可のステータスを確認します。 Android の場合、このメソッドは常に ‘granted’ を返します。許可は必要ありません。
Public API
Section titled “Public API”| Method | Description |
|---|---|
getCurrentHeading | 現在の Compass の向きを取得します。 iOS の場合、背景で向きが更新され、最新の値が返されます。 Android の場合、向きは加速度計と磁気センサを使用して計算されます。 Web では実装されていません。 |
getPluginVersion | Native Capacitor プラグインのバージョンを取得します。 |
startListening | Compass の向きの変更イベントを待ち始める。 Compass センサーを開始し、 ‘headingChange’ イベントを発行します。 |
stopListening | Compass の向きの変更イベントを待ち止める。 Compass センサーを停止し、イベントの発行を停止します。 |
addListener | Compass の向きの変更イベントにリスナーを追加します。 |
addListener | コンパス精度の変更イベントにリスナーを追加します。Androidのみでサポートされています。iOSとWebでは、イベントは発生しません。 |
removeAllListeners | このプラグインのすべてのリスナーを削除します。 |
checkPermissions | コンパスデータへのアクセス許可の現在の状態を確認します。iOSでは、位置許可の状態を確認します。Androidでは、このメソッドは常に許可が付与されていると返します。 |
requestPermissions | コンパスデータへのアクセス許可を要求します。iOSでは、ヘッディングデータのために位置許可を要求します。Androidでは、このメソッドは即座に許可が付与されていると返します。 |
watchAccuracy | コンパス精度の監視を開始します。Androidでは、このメソッドは磁気センサの精度を監視し、精度の変更イベントを発生させます。開発者は、これらのイベントにリスナーを追加し、カリブレーション提示のための独自のUIを実装できます。iOSとWebでは、このメソッドは何も実行しません。 |
unwatchAccuracy | コンパス精度の監視を停止します。このメソッドは精度の監視を停止します。 |
getAccuracy | 現在のコンパス精度のレベルを取得します。Androidでは、現在の磁気センサの精度を返します。iOSとWebでは、常にCompassAccuracy.UNKNOWNを返します。 |
真実の源
「真実の源」というセクションこのリファレンスは src/definitions.ts in capacitor-compass.
Capgoから続けて@capgo/capacitor-compass
Capgoから続けて@capgo/capacitor-compassCapgoを使用している場合 @capgo/capacitor-compass ネイティブ プラグインの作業を計画するには、 Using @capgo/capacitor-compass Capgoを使用してネイティブ機能を使用する@capgo/capacitor-compass Capgo プラグインディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor Capgo Capgoの実装詳細については、Capacitor プラグインによって Capgo で管理されます。 Capgoプラグインの実装詳細 Capgoの実装詳細については、Adding or Updating Pluginsのページを参照してください。 Enterprise Ionic プラグインの代替 Ionic Enterprise Plugin Alternativesの製品ワークフローについては、こちらのページを参照してください。