aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/positionoptions/index.html
blob: b411a84640f9364863aeffd5b14c6ef71d774c65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
title: PositionOptions
slug: Web/API/PositionOptions
tags:
  - API
  - Geolocation API
  - Interface
  - PositionOptions
  - Reference
  - Secure context
translation_of: Web/API/PositionOptions
---
<div>
<div>{{securecontext_header}}{{APIRef("Geolocation API")}}</div>
</div>

<p><strong><code>PositionOptions</code></strong> インターフェイスは {{domxref("Geolocation.getCurrentPosition()")}}{{domxref("Geolocation.watchPosition()")}} に渡すオプションプロパティを含んだオブジェクトを表します。</p>

<h2 id="Properties" name="Properties">プロパティ</h2>

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

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

<h2 id="Methods" name="Methods">メソッド</h2>

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

<h2 id="Specifications" name="Specifications">仕様</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">仕様書</th>
   <th scope="col">策定状況</th>
   <th scope="col">コメント</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('Geolocation', '#positionoptions', 'PositionOptions')}}</td>
   <td>{{Spec2('Geolocation')}}</td>
   <td>最初の定義</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザ実装状況</h2>

<p>{{Compat("api.PositionOptions")}}</p>

<h2 id="See_also" name="See_also">関連情報</h2>

<ul>
 <li><a href="/ja/docs/WebAPI/Using_geolocation">Geolocation の利用</a></li>
 <li>{{domxref("Geolocation")}} インターフェイス</li>
</ul>