Passer au contenu

@capgo/capacitor-compass

Capacitor Interface du plugin Compass pour la lecture de la direction du cap de l'appareil.

L'interface du plugin Compass Capacitor pour la lecture de la direction du cap de l'appareil.

  • getCurrentHeading - Obtenez l'orientation actuelle du compas en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est retourné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 l'écoute des changements d'orientation du compas via des événements. Cela démarre les capteurs du compas et émet des événements ‘headingChange’.
  • stopListening - Arrêter l'écoute des changements d'orientation du compas. Cela arrête les capteurs du compas et arrête l'émission d'événements.
  • checkPermissions - Vérifiez l'état actuel des autorisations pour accéder aux données du compas. Sur iOS, cela vérifie l'état des autorisations de localisation. Sur Android, cela retourne toujours ‘granted’ car aucune autorisation n'est requise.
MéthodeDescription
getCurrentHeadingObtenez l'orientation actuelle du compas en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est retourné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.
getPluginVersionObtenez la version native du plugin Capacitor.
startListeningDémarrer l'écoute des changements d'orientation du compas via des événements. Cela démarre les capteurs du compas et émet des événements ‘headingChange’.
stopListeningArrêter l'écoute des changements d'orientation du compas. Cela arrête les capteurs du compas et arrête l'émission d'é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, ce ne sera jamais émis.
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 le statut de 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 la précision du capteur magnétométrique et émet 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 de précision actuel du compas. Sur Android, renvoie la précision 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 en capacitor-compas.

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