Lompat ke konten

@capgo/capacitor-compass

Interface Plugin Capacitor untuk membaca arah kompas perangkat.

Interface Plugin Compass Capacitor 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 di Web.
  • startListening - Mulai mendengarkan perubahan arah kompas melalui event. Ini memulai sensor kompas dan mengirimkan 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 ‘diberikan’ karena tidak ada izin yang diperlukan.
MethodeDeskripsi
getCurrentHeadingDapatkan 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.
getPluginVersionDapatkan 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 pernah mengirimkan event.
removeAllListenersHapus semua pendengar untuk plugin ini.
checkPermissionsPeriksa status izin saat ini untuk mengakses data kompas. Pada iOS, ini memeriksa status izin lokasi. Pada Android, ini selalu mengembalikan ‘diberikan’ karena tidak ada izin yang diperlukan.
requestPermissionsMinta izin untuk mengakses data kompas. Pada iOS, ini meminta izin lokasi (diperlukan untuk data arah). Pada Android, ini segera diselesaikan karena tidak ada izin yang diperlukan.
watchAccuracyMulai memantau akurasi kompas. Pada Android, ini memantau akurasi magnetometer dan mengeluarkan peristiwa perubahan akurasi. Pengembang dapat mendengarkan peristiwa ini dan menerapkan UI mereka sendiri untuk permintaan kalibrasi. Pada iOS dan Web, metode ini tidak melakukan apa-apa karena pemantauan akurasi kompas tidak tersedia.
unwatchAccuracyHentikan memantau akurasi kompas. Ini menghentikan pemantauan akurasi.
getAccuracyDapatkan 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-compass untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-compass untuk kemampuan native di Menggunakan @capgo/capacitor-compass, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin-Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin-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 pada Alternatif Plugin Enterprise Ionic.