Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note limited implementation experience #71

Merged
merged 1 commit into from
Apr 1, 2019
Merged

Note limited implementation experience #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ Implementations that are unable to provide all three angles must set the values

<h3 id="deviceorientationabsolute">deviceorientationabsolute Event</h3>

<div class="issue">
The [=deviceorientationabsolute=] event and its {{Window/ondeviceorientationabsolute}} event handler IDL attribute have <a href="https://wpt.fyi/results/orientation-event/ondeviceorientationabsolute.https.html">limited implementation experience</a>.
</div>

User agents implementing this specification must provide a new DOM event, named <dfn id="def-deviceorientationabsolute"><code>deviceorientationabsolute</code></dfn>. The corresponding event must be of type {{DeviceOrientationEvent}} and must fire on the {{window!!attribute}} object. Registration for, and firing of the [=deviceorientationabsolute=] event must follow the usual behavior of DOM4 Events, [[!DOM4]].

User agents must also provide an event handler IDL attribute [[!HTML]] named {{Window/ondeviceorientationabsolute}} on the {{window!!attribute}} object. The type of the corresponding [=event handler event type=] must be [=deviceorientationabsolute=].
Expand All @@ -292,6 +296,10 @@ The [=deviceorientationabsolute=] event is completely analogous to the [=deviceo

<h3 id="compassneedscalibration">compassneedscalibration Event</h3>

<div class="issue">
The [=compassneedscalibration=] event and its {{Window/oncompassneedscalibration}} event handler IDL attribute have <a href="https://github.com/w3c/deviceorientation/issues/38">limited implementation experience</a>.
</div>

User agents implementing this specification must provide a new DOM event, named <dfn id="def-compassneedscalibration"><code>compassneedscalibration</code></dfn> that uses the Event interface defined in the DOM4 Events specification [[!DOM4]]. This event must fire on the {{window!!attribute}} object. Registration for, and firing of the [=compassneedscalibration=] event must follow the usual behavior of DOM4 Events [[!DOM4]].

User agents must also provide an event handler IDL attribute [[!HTML]] named {{Window/oncompassneedscalibration}} on the {{window!!attribute}} object. The type of the corresponding event must be [=compassneedscalibration=].
Expand Down
24 changes: 13 additions & 11 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1221,7 +1221,7 @@
</style>
<meta content="Bikeshed version df1bf04b71c9fb8a3d724e46fc13f9cf7065df60" name="generator">
<link href="http://www.w3.org/TR/orientation-event/" rel="canonical">
<meta content="59a92992ce7662def7e34706a3926c960a8afe38" name="document-revision">
<meta content="1682063ea79b4dcbc864cc3e42ca871e9a85ea1c" name="document-revision">
<style>/* style-md-lists */

/* This is a weird hack for me not yet following the commonmark spec
Expand Down Expand Up @@ -1468,7 +1468,7 @@
<div class="head">
<p data-fill-with="logo"><a class="logo" href="https://www.w3.org/"> <img alt="W3C" height="48" src="https://www.w3.org/StyleSheets/TR/2016/logos/W3C" width="72"> </a> </p>
<h1 class="p-name no-ref" id="title">DeviceOrientation Event Specification</h1>
<h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Editor’s Draft, <time class="dt-updated" datetime="2019-03-19">19 March 2019</time></span></h2>
<h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Editor’s Draft, <time class="dt-updated" datetime="2019-03-29">29 March 2019</time></span></h2>
<div data-fill-with="spec-metadata">
<dl>
<dt>This version:
Expand Down Expand Up @@ -1748,16 +1748,18 @@ <h3 class="heading settled" data-level="4.1" id="deviceorientation"><span class=
<p>The <a data-link-type="dfn" href="#def-deviceorientation" id="ref-for-def-deviceorientation④">deviceorientation</a> event tries to provide relative values for the three angles (relative to some arbitrary orientation), based on just the accelerometer and the gyroscope. The implementation can still decide to provide absolute orientation if relative is not available or the resulting data is more accurate. In either case, the <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-absolute" id="ref-for-dom-deviceorientationevent-absolute①">absolute</a></code> property must be set accordingly to reflect the choice.</p>
<p>Implementations that are unable to provide all three angles must set the values of the unknown angles to null. If any angles are provided, the <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-absolute" id="ref-for-dom-deviceorientationevent-absolute②">absolute</a></code> property must be set appropriately. If an implementation can never provide orientation information, the event should be fired with the <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-alpha" id="ref-for-dom-deviceorientationevent-alpha⑦">alpha</a></code>, <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-beta" id="ref-for-dom-deviceorientationevent-beta⑥">beta</a></code> and <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-gamma" id="ref-for-dom-deviceorientationevent-gamma⑥">gamma</a></code> attributes set to null.</p>
<h3 class="heading settled" data-level="4.2" id="deviceorientationabsolute"><span class="secno">4.2. </span><span class="content">deviceorientationabsolute Event</span><a class="self-link" href="#deviceorientationabsolute"></a></h3>
<p>User agents implementing this specification must provide a new DOM event, named <dfn class="dfn-paneled" data-dfn-type="dfn" data-noexport id="def-deviceorientationabsolute"><code>deviceorientationabsolute</code></dfn>. The corresponding event must be of type <code class="idl"><a data-link-type="idl" href="#deviceorientationevent" id="ref-for-deviceorientationevent①">DeviceOrientationEvent</a></code> and must fire on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window②">window</a></code> object. Registration for, and firing of the <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute">deviceorientationabsolute</a> event must follow the usual behavior of DOM4 Events, <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>.</p>
<p>User agents must also provide an event handler IDL attribute <a data-link-type="biblio" href="#biblio-html">[HTML]</a> named <code class="idl"><a data-link-type="idl" href="#dom-window-ondeviceorientationabsolute" id="ref-for-dom-window-ondeviceorientationabsolute">ondeviceorientationabsolute</a></code> on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window③">window</a></code> object. The type of the corresponding <a data-link-type="dfn" href="https://html.spec.whatwg.org/multipage/webappapis.html#event-handler-event-type" id="ref-for-event-handler-event-type①">event handler event type</a> must be <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute①">deviceorientationabsolute</a>.</p>
<div class="issue" id="issue-58b60688"><a class="self-link" href="#issue-58b60688"></a> The <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute">deviceorientationabsolute</a> event and its <code class="idl"><a data-link-type="idl" href="#dom-window-ondeviceorientationabsolute" id="ref-for-dom-window-ondeviceorientationabsolute">ondeviceorientationabsolute</a></code> event handler IDL attribute have <a href="https://wpt.fyi/results/orientation-event/ondeviceorientationabsolute.https.html">limited implementation experience</a>. </div>
<p>User agents implementing this specification must provide a new DOM event, named <dfn class="dfn-paneled" data-dfn-type="dfn" data-noexport id="def-deviceorientationabsolute"><code>deviceorientationabsolute</code></dfn>. The corresponding event must be of type <code class="idl"><a data-link-type="idl" href="#deviceorientationevent" id="ref-for-deviceorientationevent①">DeviceOrientationEvent</a></code> and must fire on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window②">window</a></code> object. Registration for, and firing of the <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute①">deviceorientationabsolute</a> event must follow the usual behavior of DOM4 Events, <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>.</p>
<p>User agents must also provide an event handler IDL attribute <a data-link-type="biblio" href="#biblio-html">[HTML]</a> named <code class="idl"><a data-link-type="idl" href="#dom-window-ondeviceorientationabsolute" id="ref-for-dom-window-ondeviceorientationabsolute①">ondeviceorientationabsolute</a></code> on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window③">window</a></code> object. The type of the corresponding <a data-link-type="dfn" href="https://html.spec.whatwg.org/multipage/webappapis.html#event-handler-event-type" id="ref-for-event-handler-event-type①">event handler event type</a> must be <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute②">deviceorientationabsolute</a>.</p>
<pre class="idl highlight def"><c- b>partial</c-> <c- b>interface</c-> <a class="idl-code" data-link-type="interface" href="https://html.spec.whatwg.org/multipage/window-object.html#window" id="ref-for-window①"><c- g>Window</c-></a> {
[<a class="idl-code" data-link-type="extended-attribute" href="https://heycam.github.io/webidl/#SecureContext" id="ref-for-SecureContext②"><c- g>SecureContext</c-></a>] <c- b>attribute</c-> <a class="n" data-link-type="idl-name" href="https://html.spec.whatwg.org/multipage/webappapis.html#eventhandler" id="ref-for-eventhandler①"><c- n>EventHandler</c-></a> <dfn class="dfn-paneled idl-code" data-dfn-for="Window" data-dfn-type="attribute" data-export data-type="EventHandler" id="dom-window-ondeviceorientationabsolute"><code><c- g>ondeviceorientationabsolute</c-></code></dfn>;
};
</pre>
<p>The <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute②">deviceorientationabsolute</a> event is completely analogous to the <a data-link-type="dfn" href="#def-deviceorientation" id="ref-for-def-deviceorientation⑤">deviceorientation</a> event, except additional sensors like the magnetometer can be used to provide an absolute orientation. The <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-absolute" id="ref-for-dom-deviceorientationevent-absolute③">absolute</a></code> property must be set to true. If an implementation can never provide absolute orientation information, the event should be fired with the <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-alpha" id="ref-for-dom-deviceorientationevent-alpha⑧">alpha</a></code>, <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-beta" id="ref-for-dom-deviceorientationevent-beta⑦">beta</a></code> and <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-gamma" id="ref-for-dom-deviceorientationevent-gamma⑦">gamma</a></code> attributes set to null.</p>
<p>The <a data-link-type="dfn" href="#def-deviceorientationabsolute" id="ref-for-def-deviceorientationabsolute③">deviceorientationabsolute</a> event is completely analogous to the <a data-link-type="dfn" href="#def-deviceorientation" id="ref-for-def-deviceorientation⑤">deviceorientation</a> event, except additional sensors like the magnetometer can be used to provide an absolute orientation. The <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-absolute" id="ref-for-dom-deviceorientationevent-absolute③">absolute</a></code> property must be set to true. If an implementation can never provide absolute orientation information, the event should be fired with the <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-alpha" id="ref-for-dom-deviceorientationevent-alpha⑧">alpha</a></code>, <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-beta" id="ref-for-dom-deviceorientationevent-beta⑦">beta</a></code> and <code class="idl"><a data-link-type="idl" href="#dom-deviceorientationevent-gamma" id="ref-for-dom-deviceorientationevent-gamma⑦">gamma</a></code> attributes set to null.</p>
<h3 class="heading settled" data-level="4.3" id="compassneedscalibration"><span class="secno">4.3. </span><span class="content">compassneedscalibration Event</span><a class="self-link" href="#compassneedscalibration"></a></h3>
<p>User agents implementing this specification must provide a new DOM event, named <dfn class="dfn-paneled" data-dfn-type="dfn" data-noexport id="def-compassneedscalibration"><code>compassneedscalibration</code></dfn> that uses the Event interface defined in the DOM4 Events specification <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>. This event must fire on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window④">window</a></code> object. Registration for, and firing of the <a data-link-type="dfn" href="#def-compassneedscalibration" id="ref-for-def-compassneedscalibration①">compassneedscalibration</a> event must follow the usual behavior of DOM4 Events <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>.</p>
<p>User agents must also provide an event handler IDL attribute <a data-link-type="biblio" href="#biblio-html">[HTML]</a> named <code class="idl"><a data-link-type="idl" href="#dom-window-oncompassneedscalibration" id="ref-for-dom-window-oncompassneedscalibration">oncompassneedscalibration</a></code> on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window⑤">window</a></code> object. The type of the corresponding event must be <a data-link-type="dfn" href="#def-compassneedscalibration" id="ref-for-def-compassneedscalibration②">compassneedscalibration</a>.</p>
<div class="issue" id="issue-d45eac76"><a class="self-link" href="#issue-d45eac76"></a> The <a data-link-type="dfn" href="#def-compassneedscalibration" id="ref-for-def-compassneedscalibration①">compassneedscalibration</a> event and its <code class="idl"><a data-link-type="idl" href="#dom-window-oncompassneedscalibration" id="ref-for-dom-window-oncompassneedscalibration">oncompassneedscalibration</a></code> event handler IDL attribute have <a href="https://github.com/w3c/deviceorientation/issues/38">limited implementation experience</a>. </div>
<p>User agents implementing this specification must provide a new DOM event, named <dfn class="dfn-paneled" data-dfn-type="dfn" data-noexport id="def-compassneedscalibration"><code>compassneedscalibration</code></dfn> that uses the Event interface defined in the DOM4 Events specification <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>. This event must fire on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window④">window</a></code> object. Registration for, and firing of the <a data-link-type="dfn" href="#def-compassneedscalibration" id="ref-for-def-compassneedscalibration②">compassneedscalibration</a> event must follow the usual behavior of DOM4 Events <a data-link-type="biblio" href="#biblio-dom4">[DOM4]</a>.</p>
<p>User agents must also provide an event handler IDL attribute <a data-link-type="biblio" href="#biblio-html">[HTML]</a> named <code class="idl"><a data-link-type="idl" href="#dom-window-oncompassneedscalibration" id="ref-for-dom-window-oncompassneedscalibration①">oncompassneedscalibration</a></code> on the <code class="idl"><a class="idl-code" data-link-type="attribute" href="https://html.spec.whatwg.org/multipage/window-object.html#dom-window" id="ref-for-dom-window⑤">window</a></code> object. The type of the corresponding event must be <a data-link-type="dfn" href="#def-compassneedscalibration" id="ref-for-def-compassneedscalibration③">compassneedscalibration</a>.</p>
<pre class="idl highlight def"><c- b>partial</c-> <c- b>interface</c-> <a class="idl-code" data-link-type="interface" href="https://html.spec.whatwg.org/multipage/window-object.html#window" id="ref-for-window②"><c- g>Window</c-></a> {
<c- b>attribute</c-> <a class="n" data-link-type="idl-name" href="https://html.spec.whatwg.org/multipage/webappapis.html#eventhandler" id="ref-for-eventhandler②"><c- n>EventHandler</c-></a> <dfn class="dfn-paneled idl-code" data-dfn-for="Window" data-dfn-type="attribute" data-export data-type="EventHandler" id="dom-window-oncompassneedscalibration"><code><c- g>oncompassneedscalibration</c-></code></dfn>;
};
Expand Down Expand Up @@ -2549,26 +2551,26 @@ <h2 class="no-num no-ref heading settled" id="idl-index"><span class="content">I
<aside class="dfn-panel" data-for="def-deviceorientationabsolute">
<b><a href="#def-deviceorientationabsolute">#def-deviceorientationabsolute</a></b><b>Referenced in:</b>
<ul>
<li><a href="#ref-for-def-deviceorientationabsolute">4.2. deviceorientationabsolute Event</a> <a href="#ref-for-def-deviceorientationabsolute①">(2)</a> <a href="#ref-for-def-deviceorientationabsolute②">(3)</a>
<li><a href="#ref-for-def-deviceorientationabsolute">4.2. deviceorientationabsolute Event</a> <a href="#ref-for-def-deviceorientationabsolute①">(2)</a> <a href="#ref-for-def-deviceorientationabsolute②">(3)</a> <a href="#ref-for-def-deviceorientationabsolute③">(4)</a>
</ul>
</aside>
<aside class="dfn-panel" data-for="dom-window-ondeviceorientationabsolute">
<b><a href="#dom-window-ondeviceorientationabsolute">#dom-window-ondeviceorientationabsolute</a></b><b>Referenced in:</b>
<ul>
<li><a href="#ref-for-dom-window-ondeviceorientationabsolute">4.2. deviceorientationabsolute Event</a>
<li><a href="#ref-for-dom-window-ondeviceorientationabsolute">4.2. deviceorientationabsolute Event</a> <a href="#ref-for-dom-window-ondeviceorientationabsolute①">(2)</a>
</ul>
</aside>
<aside class="dfn-panel" data-for="def-compassneedscalibration">
<b><a href="#def-compassneedscalibration">#def-compassneedscalibration</a></b><b>Referenced in:</b>
<ul>
<li><a href="#ref-for-def-compassneedscalibration">2. Introduction</a>
<li><a href="#ref-for-def-compassneedscalibration①">4.3. compassneedscalibration Event</a> <a href="#ref-for-def-compassneedscalibration②">(2)</a>
<li><a href="#ref-for-def-compassneedscalibration①">4.3. compassneedscalibration Event</a> <a href="#ref-for-def-compassneedscalibration②">(2)</a> <a href="#ref-for-def-compassneedscalibration③">(3)</a>
</ul>
</aside>
<aside class="dfn-panel" data-for="dom-window-oncompassneedscalibration">
<b><a href="#dom-window-oncompassneedscalibration">#dom-window-oncompassneedscalibration</a></b><b>Referenced in:</b>
<ul>
<li><a href="#ref-for-dom-window-oncompassneedscalibration">4.3. compassneedscalibration Event</a>
<li><a href="#ref-for-dom-window-oncompassneedscalibration">4.3. compassneedscalibration Event</a> <a href="#ref-for-dom-window-oncompassneedscalibration①">(2)</a>
</ul>
</aside>
<aside class="dfn-panel" data-for="def-devicemotion">
Expand Down