@capgo/capacitor-compass

Panoramica

Capacitor Interfaccia plugin Compass per la lettura dell'indirizzo del dispositivo.

Capacità di base

• getCurrentHeading - Ottieni l'indirizzo attuale del compasso in gradi. Su iOS, l'indirizzo viene aggiornato in background e il valore più recente viene restituito. Su Android, l'indirizzo viene calcolato quando viene chiamato il metodo utilizzando i sensori accelerometro e magnetometro. Non implementato su Web.
• startListening - Avvia l'ascolto dei cambiamenti dell'indirizzo del compasso tramite eventi. Ciò avvia i sensori del compasso e emette eventi ‘headingChange’.
• stopListening - Fermati l'ascolto dei cambiamenti dell'indirizzo del compasso. Ciò ferma i sensori del compasso e ferma l'emissione di eventi.
• checkPermissions - Controlla lo stato di autorizzazione corrente per l'accesso ai dati del compasso. Su iOS, ciò controlla lo stato di autorizzazione per la localizzazione. Su Android, questo sempre restituisce ‘granted’ poiché non sono richieste autorizzazioni.

Pubblico API

Metodo	Descrizione
getCurrentHeading	Ottenere l'attuale orientamento del compasso in gradi. Su iOS, l'orientamento viene aggiornato in background e viene restituito il valore più recente. Su Android, l'orientamento viene calcolato quando viene chiamato il metodo utilizzando i sensori accelerometro e magnetometro. Non implementato su Web.
getPluginVersion	Ottenere la versione nativa del plugin Capacitor.
startListening	Iniziare a ricevere notifiche di cambiamento dell'orientamento del compasso tramite eventi. Ciò avvia i sensori del compasso e emette eventi 'headingChange'.
stopListening	Smettere di ricevere notifiche di cambiamento dell'orientamento del compasso. Ciò ferma i sensori del compasso e ferma l'emissione di eventi.
addListener	Aggiungere un ascoltatore per eventi di cambiamento dell'orientamento del compasso.
addListener	Aggiungere un ascoltatore per eventi di cambiamento dell'accuratezza del compasso. Supportato solo su Android. Su iOS e Web, questo non emette mai eventi.
removeAllListeners	Rimuovere tutti gli ascoltatori per questo plugin.
checkPermissions	Verificare lo stato di autorizzazione corrente per l'accesso ai dati del compasso. Su iOS, ciò verifica lo stato di autorizzazione per la localizzazione. Su Android, questo sempre restituisce 'granted' poiché non sono richieste autorizzazioni.
requestPermissions	Richiedere l'autorizzazione per l'accesso ai dati del compasso. Su iOS, ciò richiede l'autorizzazione per la localizzazione (richiesta per i dati di orientamento). Su Android, questo risolve immediatamente poiché non sono richieste autorizzazioni.
watchAccuracy	Iniziare a monitorare l'accuratezza del compasso. Su Android, ciò monitora l'accuratezza del magnetometro e emette eventi accuracyChange. I sviluppatori possono ascoltare questi eventi e implementare la propria UI per le richieste di calibrazione. Su iOS e Web, questo metodo non fa nulla poiché la monitorizzazione dell'accuratezza del compasso non è disponibile.
unwatchAccuracy	Smetti di monitorare l'accuratezza del compasso. Ciò ferma la monitorazione dell'accuratezza.
getAccuracy	Ottieni il livello di accuratezza attuale del compasso. Su Android, restituisce l'attuale accuratezza del sensore magnetometro. Su iOS e Web, restituisce sempre CompassAccuracy.UNKNOWN poiché la monitorazione dell'accuratezza non è disponibile.

Fonte di Verità

Questa referenza è sincronizzata da src/definitions.ts in capacitor-compasso.