Brújula

org.apache.cordova.device-orientation

Este plugin obtiene acceso a la brújula del dispositivo. La brújula es un sensor que detecta la dirección en la que apunta el dispositivo, normalmente desde la parte superior. Expresa los grados desde el 0 al 359,99, donde el 0 es el norte.

Instalación

cordova plugin add org.apache.cordova.device-orientation

Plataformas soportadas

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Tizen
  • Windows Phone 7 and 8 (if available in hardware)
  • Windows 8
  • navigator.compass.getCurrentHeading
  • navigator.compass.watchHeading
  • navigator.compass.clearWatch

Métodos

  • navigator.compass.getCurrentHeading
  • navigator.compass.watchHeading
  • navigator.compass.clearWatch

navigator.compass.getCurrentHeading

Obtiene la dirección actual de la brújula. La dirección de la brújula es devuelta a través del objeto CompassHeading usando la función compassSuccess.

navigator.compass.getCurrentHeading(compassSuccess, compassError);

navigator.compass.watchHeading

Obtiene la dirección actual de la brújula en un intervalo constante de tiempo. Cada vez que la orientación es recibida, la función headingSuccess se ejecuta.

El ID devuelto referencia al intervalo de la brújula. El ID puede ser usado con navigator.compass.clearWatch para detener la captura.

var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);

compassOptions puede contener las siguientes claves:

  • frequency: Con que frecuencia se recibe la orientación de la brújula en milisegundos. (Number) (Por defecto: 100)
  • filter: El cambio en grados requiere iniciar una llamada a watchHeading. Cuando se establece este valor, se ignora frequency. (Number)

Objetos

CompassHeading

Un objeto CompassHeading se devuelve a la función de llamada compassSuccess.

Propiedades

  • magneticHeading: La orientación en grados desde 0-359,99 en un momento determinado. (Number)
  • trueHeading: La orientación relativa al Polo Norte geográfico en 0-359,99 en un único momento. Un valor negativo indica que la verdadera orientación no puede ser determinada. (Number)
  • headingAccuracy: La desviación en grados entre la orientación dada y la verdadera. (Number)
  • timestamp: El instante en el que se determinó la orientación. (milliseconds)

CompassError

Un objeto CompassError es devuelto a la función de llamada compassError cuando ocurre un error.

Propiedades

  • code: Uno de los errores predefinidos listados a continuación.
  • CompassError.COMPASS_INTERNAL_ERR
  • CompassError.COMPASS_NOT_SUPPORTED

Constantes

  • CompassError.COMPASS_INTERNAL_ERR
  • CompassError.COMPASS_NOT_SUPPORTED