Aller directement au contenu

@capgo/capacitor-compass

Interface du plugin Capacitor Compass pour lire l'orientation du compas du dispositif.

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

  • getCurrentHeading - Récupérez l'orientation actuelle de la boussole en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la dernière valeur est renvoyée. Sur Android, l'orientation est calculée 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 - Démarrer la lecture des changements d'orientation de la boussole via des événements. Cela démarre les capteurs de la boussole et émet des événements ‘headingChange’.
  • stopListening - Arrêtez de recevoir des mises à jour de cap de direction.
  • checkPermissions - Vérifiez l'état actuel des autorisations pour accéder aux données de cap. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela retourne toujours ‘accordé’ car aucune autorisation n'est requise.
MéthodeDescription
getCurrentHeadingObtenez l'angle actuel du cap en degrés. Sur iOS, l'angle est mis à jour en arrière-plan et la valeur la plus récente est retournée. Sur Android, l'angle est calculé lorsque la méthode est appelée à l'aide des capteurs accéléromètre et magnétomètre. Non implémenté sur Web.
getPluginVersionObtenez la version native du plugin Capacitor.
startListeningDémarrer la réception de mises à jour de cap de direction via des événements. Cela démarre les capteurs de cap et émet des événements ‘headingChange’.
stopListeningArrêtez de recevoir des mises à jour de cap de direction. Cela arrête les capteurs de cap et arrête l'émission d'événements.
addListenerAjoutez un écouteur pour les événements de changement de cap de direction.
addListenerAjoutez un écouteur pour les événements de changement d'exactitude de cap. Seulement pris en charge sur Android. Sur iOS et Web, cela ne jamais émet d'événements.
removeAllListenersSupprimer 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 l'état de la permission de localisation. Sur Android, cela renvoie toujours ‘accordé’ car aucune permission n'est requise.
requestPermissionsDemander la permission d'accéder aux données du compas. Sur iOS, cela demande la permission de localisation (requise pour les données de capteur). Sur Android, cela se résout immédiatement car aucune permission n'est requise.
watchAccuracyDémarrer la surveillance de l'exactitude du compas. Sur Android, cela surveille l'exactitude du capteur magnétique et émet des événements de changement d'exactitude. 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 l'exactitude du compas n'est pas disponible.
unwatchAccuracyArrêter la surveillance de l'exactitude du compas. Cela arrête la surveillance de l'exactitude.
getAccuracyObtenir le niveau actuel d'exactitude du compas. Sur Android, renvoie l'exactitude actuelle du capteur magnétique. Sur iOS et Web, renvoie toujours CompassAccuracy.UNKNOWN car la surveillance de l'exactitude du compas n'est pas disponible.

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

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 plugins Capgo pour le flux de travail du produit dans Répertoire de plugins Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou Mettre à jour les plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans les alternatives de plugins d'entreprise Ionic.