aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/screen/lockorientation/index.html
blob: 19fbbaf2918e4c062f3a0a84546e8a1c1200a01c (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
---
title: Screen.lockOrientation()
slug: Web/API/Screen/lockOrientation
tags:
  - API
  - CSSOM View
  - Method
  - NeedsUpdate
  - Screen Orientation
  - screen
  - メソッド
translation_of: Web/API/Screen/lockOrientation
---
<p>{{APIRef("Screen Orientation API")}}{{Deprecated_Header}}</p>

<p><strong><code>lockOrientation()</code></strong>{{DOMxRef("Screen")}} インターフェイスのメソッドで、画面を特定の方向にロックします。代わりに {{DOMxRef("ScreenOrientation.lock()")}} メソッドを使用してください。</p>

<div class="note">
<p><strong>注:</strong> このメソッドはインストールされたウェブアプリまたは<a href="/ja/docs/Web/Guide/DOM/Using_full_screen_mode">全画面モード</a>のウェブページでのみ動作します。</p>
</div>

<h2 id="Syntax" name="Syntax">構文</h2>

<pre class="syntaxbox notranslate"><var>lockAllowed</var> = window.screen.lockOrientation(<var>orientation</var>);</pre>

<h3 id="Parameters" name="Parameters">引数</h3>

<dl>
 <dt><code><var>orientation</var></code></dt>
 <dd>画面をロックする向きです。文字列または文字列の配列で指定します。複数の文字列を渡したときは、選択した向きでのみ回転できるようになります。</dd>
</dl>

<p>以下の文字列表現が向きとして指定できます。</p>

<dl>
 <dt><code>portrait-primary</code></dt>
 <dd>メインのポートレートモードであるスクリーンの向きを表します。メインのポートレートモードとは、デバイスを通常の向きが縦向きの場合と、デバイスの通常の位置が横向きの場合に時計回りに 90° 回転させた向きの場合です。どの向きが通常の向きであるかは、デバイスによって異なります。</dd>
 <dt><code>portrait-secondary</code></dt>
 <dd>2番目のポートレートモードであるスクリーンの向きを表します。2番目のポートレートモードとは、デバイスを通常の向きが縦向きでそこから 180° 回転させた場合と、デバイスの通常の位置が横向きの場合に反時計回りに 90° 回転させた向きの場合です。どの向きが通常の向きであるかは、デバイスによって異なります。</dd>
 <dt><code>landscape-primary</code></dt>
 <dd>メインのランドスケープモードであるスクリーンの向きを表します。メインのランドスケープモードとは、デバイスを通常の向きが横向きの場合と、デバイスの通常の位置が縦向きの場合に時計回りに 90° 回転させた向きの場合です。どの向きが通常の向きであるかは、デバイスによって異なります。</dd>
 <dt><code>landscape-secondary</code></dt>
 <dd>2番目のランドスケープモードであるスクリーンの向きを表します。2番目のランドスケープモードとは、デバイスを通常の向きが横向きでそこから 180° 回転させた場合と、デバイスの通常の位置が縦向きの場合に反時計回りに 90° 回転させた向きの場合です。どの向きが通常の向きであるかは、デバイスによって異なります。</dd>
 <dt><code>portrait</code></dt>
 <dd><code>portrait-primary</code> と <code>portrait-secondary</code> の両方を表します。</dd>
 <dt><code>landscape</code></dt>
 <dd><code>landscape-primary</code><code>landscape-secondary</code> の両方を表します。</dd>
 <dt><code>default</code></dt>
 <dd>デバイスに自然な向きによって <code>portrait-primary</code> または <code>landscape-primary</code> が選ばれます。たとえば、ディスプレイの解像度が 1280*800 なら、 <code>default</code><code>landscape</code> になるでしょうし、800*1280 なら、 <code>default</code><code>portrait</code> になるでしょう。</dd>
</dl>

<div class="note">
<p><strong>注:</strong> 複数のロックが同時に指定されることがあります。そのため、1つの向きにのみロックがセットされた場合には、スクリーンの向きはロックが解除されるまで決して変更されません。もしそうでなければ、デバイスがロックされた向きを含む複数の向きの間で、スクリーンの向きが1つの向きから別の向きへと移り変わってしまうことになります。</p>
</div>

<h3 id="Return_value" name="Return_value">返値</h3>

<p>向きの固定が許可された場合には <code>true</code> が返り、向きのロックが拒否された場合には <code>false</code> が返ります。返値は、必ずしもスクリーンの向きが実際にロックされていることを示すわけではないことに注意してください。遅延がある可能性があるからです。</p>

<h2 id="Examples" name="Examples"></h2>

<h3 id="Usage_with_a_DOMString_argument" name="Usage_with_a_DOMString_argument"><code>DOMString</code> 引数での使用方法</h3>

<pre class="brush: js; notranslate">screen.lockOrientationUniversal = screen.lockOrientation || screen.mozLockOrientation || screen.msLockOrientation;

if (screen.lockOrientationUniversal("landscape-primary")) {
  // 向きがロックされた
} else {
  // 向きのロックに失敗した
}
</pre>

<h3 id="Usage_with_an_Array_argument" name="Usage_with_an_Array_argument"><code>Array</code> 引数での使用方法</h3>

<pre class="brush: js; notranslate">screen.lockOrientationUniversal = screen.lockOrientation || screen.mozLockOrientation || screen.msLockOrientation;

if (screen.lockOrientationUniversal(["landscape-primary", "landscape-secondary"])) {
  // 向きがロックされた
} else {
  // 向きのロックに失敗した
}</pre>

<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('Screen Orientation', 'published/20140220.html#extensions-to-the-screen-interface', 'lockOrientation()')}}</td>
   <td>{{Spec2('Screen Orientation')}}</td>
   <td>初回定義 (もう草稿には存在しません)</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>

<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div>

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

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

<ul>
 <li>{{DOMxRef("Screen.orientation")}}</li>
 <li>{{DOMxRef("Screen.unlockOrientation()")}}</li>
 <li>{{DOMxRef("Screen.onorientationchange")}}</li>
 <li><a href="/ja/docs/Managing_screen_orientation">画面の向きの管理</a></li>
</ul>