Lompat ke konten

@capgo/capacitor-compass

Capacitor Plugin Kompas untuk Membaca Arah Kompas Perangkat.

Capacitor Interface Compass Plugin untuk membaca arah kompas perangkat.

  • getCurrentHeading - Dapatkan arah kompas saat ini dalam derajat. Pada iOS, arah kompas diperbarui di latar belakang, dan nilai terbaru dikembalikan. Pada Android, arah kompas dihitung ketika metode dipanggil menggunakan sensor accelerometer dan magnetometer. Belum diimplementasikan pada Web.
  • startListening - Mulai mendengarkan perubahan arah kompas melalui event. Ini memulai sensor kompas dan mengeluarkan event ‘headingChange’.
  • stopListening - Berhenti mendengarkan perubahan arah kompas. Ini menghentikan sensor kompas dan menghentikan pengiriman event.
  • checkPermissions - Periksa status izin saat ini untuk mengakses data kompas. Pada iOS, ini memeriksa status izin lokasi. Pada Android, ini selalu mengembalikan ‘granted’ karena tidak ada izin yang diperlukan.
MetodeDeskripsi
getCurrentHeadingPilih arah kompas saat ini dalam derajat. Pada iOS, arah kompas diperbarui di latar belakang, dan nilai terbaru dikembalikan. Pada Android, arah kompas dihitung ketika metode ini dipanggil menggunakan sensor accelerometer dan magnetometer. Belum diimplementasikan pada Web.
getPluginVersionPilih versi plugin native Capacitor.
startListeningMulai mendengarkan perubahan arah kompas melalui event. Ini memulai sensor kompas dan mengirimkan event 'headingChange'.
stopListeningHentikan mendengarkan perubahan arah kompas. Ini menghentikan sensor kompas dan menghentikan pengiriman event.
addListenerTambahkan pendengar untuk event perubahan arah kompas.
addListenerTambahkan pendengar untuk event perubahan akurasi kompas. Hanya didukung pada Android. Pada iOS dan Web, ini tidak akan mengirimkan event.
removeAllListenersHapus semua pendengar untuk plugin ini.
checkPermissionsPeriksa status izin saat ini untuk mengakses data kompas. Pada iOS, ini memeriksa izin lokasi. Pada Android, ini selalu mengembalikan 'granted' karena tidak ada izin yang diperlukan.
requestPermissionsMinta izin untuk mengakses data kompas. Pada iOS, ini meminta izin lokasi (diperlukan untuk data heading). Pada Android, ini segera diselesaikan karena tidak ada izin yang diperlukan.
watchAccuracyMulai memantau akurasi kompas. Pada Android, ini memantau akurasi magnetometer dan mengirimkan event accuracyChange. Pengembang dapat mendengarkan event ini dan mengimplementasikan UI mereka sendiri untuk permintaan kalibrasi. Pada iOS dan Web, metode ini tidak melakukan apa-apa karena pemantauan akurasi kompas tidak tersedia.
unwatchAccuracyBerhenti memantau akurasi kompas. Ini menghentikan pemantauan akurasi.
getAccuracyMendapatkan tingkat akurasi kompas saat ini. Pada Android, mengembalikan akurasi sensor magnetometer saat ini. Pada iOS dan Web, selalu mengembalikan CompassAccuracy.UNKNOWN karena pemantauan akurasi tidak tersedia.

Referensi ini disinkronkan dari src/definitions.ts di capacitor-kompas.

Jika Anda menggunakan @capgo/capacitor-kompas untuk merencanakan pekerjaan plugin native, hubungkannya dengan Gunakan @capgo/capacitor-compass untuk kemampuan asli di Gunakan @capgo/capacitor-compass, Daftar Plugin Capgo untuk alur kerja produk di Daftar Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.