Geolocation: watchPosition() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨2015年7月⁩.

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

watchPosition() は Geolocation インターフェイスのメソッドで、端末の位置が変化するたびに自動的に呼び出されるハンドラー関数を登録するために用いられます。また必要に応じてエラー処理コールバック関数を指定することができます。

保護されたコンテキストが必要であることに加え、この機能は geolocation Permissions-Policy によってブロックされる可能性があり、またユーザーからの明示的な許可も必要となります。このメソッドが呼び出されたとき、ユーザーは必要に応じて確認されます。権限の状態は、権限 API の geolocation ユーザー権限を使用して問い合わせることができます。

構文

watchPosition(success)
watchPosition(success, error)
watchPosition(success, error, options)

引数

success: コールバック関数で、 GeolocationPosition オブジェクトを入力引数として受け取るものです。
error 省略可: 任意のコールバック関数で、 GeolocationPositionError オブジェクトを入力引数として受け取るものです。
options 省略可: 任意のオブジェクトで、位置を監視する構成オプションを提供します。利用可能なオプションについての詳細は Geolocation.getCurrentPosition() を参照してください。

返値

登録されたハンドラーを識別する ID を返します。この ID を Geolocation.clearWatch() メソッドに渡してハンドラーの登録を解除することができます。

例

let id;
let target;
let options;

function success(pos) {
  const crd = pos.coords;

  if (target.latitude === crd.latitude && target.longitude === crd.longitude) {
    console.log("おめでとうございます。目的地に到着しました。");
    navigator.geolocation.clearWatch(id);
  }
}

function error(err) {
  console.error(`ERROR(${err.code}): ${err.message}`);
}

target = {
  latitude: 0,
  longitude: 0,
};

options = {
  enableHighAccuracy: false,
  timeout: 5000,
  maximumAge: 0,
};

id = navigator.geolocation.watchPosition(success, error, options);