Passer à la navigation principale

@capgo/capacitor-compass

Interface du plugin Capacitor Compass pour la lecture de l'orientation du compas du dispositif.

Interface du plugin Capacitor Compass pour la lecture de l'orientation du compas du dispositif.

  • getCurrentHeading - Obtenez l'angle de direction actuel en degrés. Sur iOS, l'angle est mis à jour en arrière-plan, et la dernière valeur est retournée. Sur Android, l'angle est calculé lorsque la méthode est appelée à l'aide de capteurs d'accéléromètre et de magnétomètre. Non implémenté sur Web.
  • startListening - Commencez à écouter les changements d'angle de direction via des événements. Cela démarre les capteurs de direction et émet des événements ‘headingChange’.
  • stopListening - Arrêtez d'écouter les changements d'angle de direction. Cela arrête les capteurs de direction et arrête d'émettre des événements.
  • checkPermissions - Vérifiez l'état de permission actuel pour accéder aux données de direction. Sur iOS, cela vérifie le statut de permission de localisation. Sur Android, cela retourne toujours ‘granted’ car aucune permission n'est requise.
MéthodeDescription
getCurrentHeadingObtenez l'angle de direction actuel en degrés. Sur iOS, l'angle est mis à jour en arrière-plan, et la dernière valeur est retournée. Sur Android, l'angle est calculé lorsque la méthode est appelée à l'aide de capteurs d'accéléromètre et de magnétomètre. Non implémenté sur Web.
getPluginVersionObtenez la version native du plugin Capacitor.
startListeningCommencez à écouter les changements d'angle de direction via des événements. Cela démarre les capteurs de direction et émet des événements ‘headingChange’.
stopListeningArrêtez d'écouter les changements d'angle de direction. Cela arrête les capteurs de direction et arrête d'émettre des événements.
addListenerAjoutez un écouteur pour les événements de changement de direction du compas.
addListenerAjoutez un écouteur pour les événements de changement de précision du compas. Seul pris en charge sur Android. Sur iOS et Web, cela ne déclenchera jamais d'événements.
removeAllListenersSupprimez tous les écouteurs pour ce plugin.
checkPermissionsVérifiez l'état actuel de la permission pour accéder aux données du compas. Sur iOS, cela vérifie la permission de localisation. Sur Android, cela renvoie toujours ‘accordé’ car aucune permission n'est requise.
requestPermissionsDemandez la permission d'accéder aux données du compas. Sur iOS, cela demande la permission de localisation (requise pour les données de direction). Sur Android, cela se résout immédiatement car aucune permission n'est requise.
watchAccuracyDémarrer la surveillance de la précision du compas. Sur Android, cela surveille l'exactitude du capteur magnétométrique et déclenche des événements accuracyChange. Les développeurs peuvent écouter ces événements et mettre en place leur propre interface utilisateur pour les invitations de calibration. Sur iOS et Web, cette méthode ne fait rien car la surveillance de la précision du compas n'est pas disponible.
unwatchAccuracyArrêtez la surveillance de la précision du compas. Cela arrête la surveillance de la précision.
getAccuracyObtenez le niveau d'exactitude actuel du compas. Sur Android, renvoie l'exactitude actuelle du capteur magnétométrique. Sur iOS et Web, renvoie toujours CompassAccuracy.UNKNOWN car la surveillance de la précision du compas n'est pas disponible.

Cette référence est synchronisée à partir de src/definitions.ts in capacitor-compass.

Si vous utilisez @capgo/capacitor-compass pour planifier le travail de plugin natif, connectez-le à En utilisant @capgo/capacitor-compass pour la capacité native dans En utilisant @capgo/capacitor-compass, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo Ajout ou Mise à Jour de Plugins pour le détail d'implémentation dans Ajout ou Mise à Jour de Plugins, et Alternatives d'Extension Entreprise Ionic pour le flux de travail du produit dans Alternatives d'Extension Entreprise Ionic.