Lompat ke konten

@capgo/capacitor-compass

Capacitor Plugin Kompas untuk membaca arah kompas perangkat.

Capacitor Antarmuka Plugin Compass 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 memancarkan event ‘headingChange’.
  • stopListening - Berhenti mendengarkan perubahan arah kompas. Ini menghentikan sensor kompas dan menghentikan pancaran 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
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 dipanggil menggunakan sensor accelerometer dan magnetometer. Belum diimplementasikan pada Web.
getPluginVersionPeroleh 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 listener untuk event perubahan arah kompas.
addListenerTambahkan listener untuk event perubahan akurasi kompas. Hanya didukung pada Android. Pada iOS dan Web, ini tidak akan pernah mengirimkan event.
removeAllListenersHapus semua listener untuk plugin ini.
checkPermissionsPeriksa 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.
requestPermissionsMinta izin untuk mengakses data kompas. Pada iOS, ini meminta izin lokasi (diperlukan untuk data heading). Pada Android, ini menyelesaikan segera karena tidak ada izin yang diperlukan.
watchAccuracyMulai memantau akurasi kompas. Pada Android, ini memantau akurasi sensor magnetometer dan mengirimkan event accuracyChange. Pengembang dapat mendengarkan event 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.
getAccuracyPeroleh tingkat akurasi kompas saat ini. Pada Android, mengembalikan akurasi sensor magnetometer saat ini. Pada iOS dan Web, selalu mengembalikan CompassAccuracy.UNKNOWN karena pemantauan akurasi kompas tidak tersedia.

Sumber Kebenaran

Sumber Kebenaran

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