geolocation.clearWatch

watch ID パラメーターによって参照されるデバイスの位置情報の監視を停止します。

navigator.geolocation.clearWatch(watchID);

パラメーター

  • watchID: watchPosition 関数での監視を停止したい watchID を表します (String)

概要

geolocation.clearWatch 関数は、 watchID によって参照される [geolocation.watchPosition](geolocation.watchPosition.html) 関数を停止させるによって、位置情報の監視を停止します。

サポートされているプラットフォーム

  • Android
  • BlackBerry WebWorks (OS 5.0 以上)
  • iOS
  • Windows Phone 7 (Mango)
  • Bada 1.2 & 2.x
  • webOS

使用例

// 位置の変化を監視し、取得可能なもっとも精度の高い位置を使います
// (オプション)
//
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });

// ... 後に続く ...

navigator.geolocation.clearWatch(watchID);

詳細な使用例

<!DOCTYPE html>
<html>
  <head>
    <title>デバイスプロパティーの使用例</title>

    <script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Cordova の読み込み完了まで待機
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    var watchID = null;

    // Cordova 準備完了
    //
    function onDeviceReady() {
        // デバイスで有効な最も制度の高い位置で更新
        //
        var options = { enableHighAccuracy: true };
        watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
    }

    // onSuccess Geolocation
    //
    function onSuccess(position) {
        var element = document.getElementById('geolocation');
        element.innerHTML = '緯度: ' + position.coords.latitude     + '<br />' +
                            '経度: ' + position.coords.longitude    + '<br />' +
                            '<hr />' + element.innerHTML;
    }

    // 先に開始された監視を停止する
    //
    function clearWatch() {
        if (watchID != null) {
            navigator.geolocation.clearWatch(watchID);
            watchID = null;
        }
    }

    // エラー時のコールバック関数は PositionError オブジェクトを受けとる
    //
    function onError(error) {
        alert('コード: '        + error.code    + '\n' +
              'メッセージ: '    + error.message + '\n');
    }

    </script>
  </head>
  <body>
    <p id="geolocation">位置情報を監視中...</p>
    <button onclick="clearWatch();">監視の停止</button>
  </body>
</html>