new ol.DeviceOrientation(opt_options)
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
options |
Options.
|
|||||||
- Deprecated
- This class is deprecated and will removed in the next major release.
- See:
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:alpha(ol.Object.Event) -
change:beta(ol.Object.Event) -
change:gamma(ol.Object.Event) -
change:heading(ol.Object.Event) -
change:tracking(ol.Object.Event) -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Extends
Observable Properties
| Name | Type | Settable | ol.Object.Event type | Description |
|---|---|---|---|---|
alpha |
number | undefined | no | change:alpha |
The euler angle in radians of the device from the standard Z axis. |
beta |
number | undefined | no | change:beta |
The euler angle in radians of the device from the planar X axis. |
gamma |
number | undefined | no | change:gamma |
The euler angle in radians of the device from the planar Y axis. |
heading |
number | undefined | no | change:heading |
The heading of the device relative to north, in radians, normalizing for different browser behavior. |
tracking |
boolean | yes | change:tracking |
Changes in device orientation are being tracked. |
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
getAlpha(){number|undefined}
src/ol/deviceorientation.js, line 135 -
Rotation around the device z-axis (in radians).
Returns:
The euler angle in radians of the device from the standard Z axis.
-
getBeta(){number|undefined}
src/ol/deviceorientation.js, line 148 -
Rotation around the device x-axis (in radians).
Returns:
The euler angle in radians of the device from the planar X axis.
-
getGamma(){number|undefined}
src/ol/deviceorientation.js, line 161 -
Rotation around the device y-axis (in radians).
Returns:
The euler angle in radians of the device from the planar Y axis.
-
getHeading(){number|undefined}
src/ol/deviceorientation.js, line 174 -
The heading of the device relative to north (in radians).
Returns:
The heading of the device relative to north, in radians, normalizing for different browser behavior.
-
Get a list of object property names.
Returns:
List of property names.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
getTracking(){boolean}
src/ol/deviceorientation.js, line 186 -
Determine if orientation is being tracked.
Returns:
Changes in device orientation are being tracked.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
setTracking(tracking)
src/ol/deviceorientation.js, line 216 -
Enable or disable tracking of device orientation events.
Name Type Description trackingboolean The status of tracking changes to alpha, beta and gamma. If true, changes are tracked and reported immediately.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers