Sauter au contenu

@capgo/capacitor-compass

Capacitor Interface de plugin Compass pour la lecture de la direction de cap du dispositif.

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

  • getCurrentHeading - Récupérer l'orientation actuelle du capteur en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est renvoyée. Sur Android, l'orientation est calculée lors de l'appel de la méthode à l'aide des capteurs accéléromètre et magnétomètre. Non implémenté sur Web.
  • startListening - Démarrer la lecture des changements d'orientation du capteur via des événements. Cela démarre les capteurs de l'orientation et émet des événements ‘headingChange’.
  • stopListening - Arrêter la lecture des changements d'orientation du capteur. Cela arrête les capteurs de l'orientation et arrête l'émission d'événements.
  • checkPermissions - Vérifier l'état actuel de la permission pour accéder aux données de l'orientation. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela renvoie toujours ‘granted’ car aucune permission n'est requise.
MéthodeDescription
getCurrentHeadingRécupérer 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 lors de l'appel de la méthode à l'aide des capteurs accéléromètre et magnétomètre. Non implémenté sur Web.
getPluginVersionRécupérer la version native du plugin Capacitor.
startListeningDémarrer la réception de changements d'orientation du compas via des événements. Cela démarre les capteurs du compas et émet des événements ‘headingChange’.
stopListeningArrêter la réception de changements d'orientation du compas. Cela arrête les capteurs du compas et arrête l'émission d'événements.
addListenerAdd a listener for compass heading change events.
addListenerAjoutez un écouteur pour les événements de changement de précision du compas. Supporté uniquement sur Android. Sur iOS et Web, aucun événement ne sera jamais émis.
removeAllListenersSupprimer tous les écouteurs pour ce plugin.
checkPermissionsVérifier le statut 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 retourne toujours ‘granted’ 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 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 magnétomètre 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 l'exactitude du compas. Cela arrête la surveillance de l'exactitude.
getAccuracyObtenez le niveau actuel d'exactitude du compas. Sur Android, retourne l'exactitude actuelle du capteur magnétométrique. Sur iOS et Web, retourne toujours CompassAccuracy.UNKNOWN car la surveillance de l'exactitude 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 Utilisez @capgo/capacitor-compass pour la capacité native dans Utilisez @capgo/capacitor-compass, Répertoire du plugin Capgo pour le flux de travail du produit dans Répertoire du plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour le détail d'implémentation dans Ajouter ou mettre à jour des plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans Alternatives de plugins d'entreprise Ionic.