PositionOptions

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

PositionOptions インターフェイスは Geolocation.getCurrentPosition()Geolocation.watchPosition() に渡すオプションプロパティを含んだオブジェクトを表します。

プロパティ

PositionOptions インターフェイスが継承するプロパティはありません。

PositionOptions.enableHighAccuracy (en-US) 安全なコンテキスト用
アプリケーションが可能な限り高精度の結果を求めることを表す Boolean 型の値です。このプロパティに true を指定すると、デバイスが高精度な位置情報を提供できる場合に、それを利用することができます。これによって測位結果の取得に時間がかかったり、 (GPS チップを搭載したモバイル端末などで) 電力消費が増える可能性があります。逆に false を指定することで、短時間で結果を返したり消費電力を節約したりといった選択をデバイスに任せることができます。デフォルトは false です。
PositionOptions.timeout (en-US) 安全なコンテキスト用
位置情報の取得にかかる時間の上限 (ミリ秒) を表す、 long 型の正の値です。デフォルトは Infinity で、位置情報が得られるまで getCurrentPosition() が待ち続けることを意味します。
PositionOptions.maximumAge (en-US) 安全なコンテキスト用
キャッシュ済みの位置情報の有効期限 (ミリ秒) を表す、 long 型の正の値です。これに 0 を指定すると、デバイスはキャッシュ済みの位置情報を返すことができず、常に最新の位置情報を取得しようとします。Infinity を指定した場合、デバイスは常にキャッシュから位置情報を返します。デフォルトは 0 です。

メソッド

PositionOptions インターフェイスが実装・継承するメソッドはありません。

仕様

仕様書 策定状況 コメント
Geolocation API
PositionOptions の定義
勧告 最初の定義

ブラウザ実装状況

No compatibility data found for api.PositionOptions.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

関連情報