@capgo/capacitor-compass

Aperçu

Lire le cap du compas de l'appareil en degrés avec des mises à jour continues et la gestion des permissions

Commencez par getCurrentHeading() et les autres méthodes principales listées ci-dessous.

Support des plateformes

Plateforme	Support	Notes
iOS	Oui	Natif
Android	Oui	Natif
Le Web	Non	Protéger avec Capacitor.getPlatform()

Fonctionnalités clés

• getCurrentHeading - Récupère l'orientation actuelle du compas 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 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émarre l'écoute des changements d'orientation du compas via des événements. Cela active les capteurs du compas et émet des événements « headingChange ».
• stopListening - Arrête l'écoute des changements d'orientation du compas. Cela désactive les capteurs du compas et cesse d'émettre des événements.
• checkPermissions - Vérifie l'état actuel de l'autorisation pour accéder aux données du compas. Sur iOS, cela vérifie l'état de l'autorisation de localisation. Sur Android, cela renvoie toujours « granted » car aucune autorisation n'est requise.

API public

Méthode	Description
getCurrentHeading	Récupérez le cap actuel de la boussole en degrés. Sur iOS, le cap est mis à jour en arrière-plan et la dernière valeur est renvoyée. Sur Android, le cap est calculé lors de l'appel de la méthode via les capteurs accéléromètre et magnétomètre. Non implémenté sur le Web.
getPluginVersion	Récupère la version du plugin natif Capacitor.
startListening	Démarrer l’écoute des changements de cap du compas via des événements. Cela active les capteurs du compas et émet des événements « headingChange ».
stopListening	Arrêtez l'écoute des changements de cap du compas. Cela désactive les capteurs du compas et l'émission d'événements.
addListener	Ajouter un écouteur pour les événements de changement de cap du compas.
addListener	Ajoute un écouteur pour les événements de changement de précision du compas. Prise en charge uniquement sur Android. Sur iOS et Web, aucun événement n’est émis.
removeAllListeners	Supprimez tous les écouteurs de ce plugin.
checkPermissions	Vérifier l’état actuel de l’autorisation d’accès aux données du compas. Sur iOS, cela vérifie l’état de l’autorisation de localisation. Sur Android, cela renvoie toujours « granted », car aucune autorisation n’est requise.
requestPermissions	Demandez la permission d'accéder aux données de la boussole. Sur iOS, cela demande la permission de localisation (requise pour les données de cap). Sur Android, cela se résout immédiatement car aucune permission n'est requise.
watchAccuracy	Commencez à surveiller la précision de la boussole. 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 implémenter leur propre interface pour les prompts de calibration. Sur iOS et le Web, cette méthode ne fait rien car la surveillance de la précision de la boussole n'est pas disponible.
unwatchAccuracy	Arrêter le suivi de la précision de la boussole. Cela interrompt la surveillance de la précision.
getAccuracy	Obtenir le niveau de précision actuel de la boussole. Sur Android, retourne la précision actuelle du capteur magnétomètre. Sur iOS et Web, retourne toujours CompassAccuracy.UNKNOWN car le suivi de la précision n'est pas disponible.

Source de vérité

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-compass.

Continuer depuis @capgo/capacitor-compass

Si vous utilisez @capgo/capacitor-compass pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-compass pour la capacité native dans « Utiliser @capgo/capacitor-compass », Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.