• 디바이스의 방향(방위각)을 구하는 기능을 제공한다.

• Compass API의 플랫폼별 제약사항은 다음과 같다.

• filter 를 지원하지 않는다.

• trueHeading 을 지원하지 않는다. magneticHeading과 동일.
• magneticHeading과 magneticHeading 이 동일하기 때문에headingAccuracy 는 항상 0 이다.

• trueHeading은 navigator.geolocation.watchLocation()이 동작하고 있을 때만 감지된다.
• iOS4 이상의 단말기에서는 단말기가 회전했을 때 trueHeading 값을 감지한다.

• app/res/xml/config.xml

<plugin name="Compass" value="org.apache.cordova.CompassListener" />

• App/Supporting Files/config.xml

    <feature name="Compass">
        <param name="ios-package" value="CDVLocation"/>
    </feature>>

• 디바이스의 방위 센서가 감지한 현재 방향을 가져온다. ( 0 ~ 359.9)

navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);

• Quick Example

function onSuccess(heading) {
    alert('Heading: ' + heading.magneticHeading);
};

function onError(error) {
    alert('CompassError: ' + error.code);
};

navigator.compass.getCurrentHeading(onSuccess, onError);

• 특정 시간 간격으로 방위 센서가 감지한 빙향 정보를 가져온다.

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

• Quick Example

function onSuccess(heading) {
    var element = document.getElementById('heading');
    element.innerHTML = 'Heading: ' + heading.magneticHeading;
};

function onError(compassError) {
        alert('Compass error: ' + compassError.code);
};

var options = { frequency: 3000 };  // Update every 3 seconds

var watchID = navigator.compass.watchHeading(onSuccess, onError, options);

• watchHeading()을 통해 작동 중인 방위 센서(watchID)를 중지한다.

navigator.compass.clearWatch(watchID);

• Quick Example

var watchID = navigator.compass.watchHeading(onSuccess, onError, options);

... 

navigator.compass.clearWatch(watchID);

• 방위 센서의 메소드가 성공했을 때 실행하는 함수.
• heading: 방위 센서가 감지한 방위 정보. (compassHeading)

function(heading) {
    // Do something
}

• 방위 센서의 메소드가 실패했을 때의 파라미터.

function(CompassError) { 
    // Handle the error 
}

• 방위 센서의 옵션을 정의한다.
• iOS만 지원한다.

• 방위 센서에서 전달받은 방향 정보를 나타낸다.

• Cordova : https://cordova.apache.org/docs/en/7.x/reference/cordova-plugin-device-orientation/index.html