Class: DeviceOrientation

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent 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	The status of tracking changes to alpha, beta and gamma. If true, changes are tracked and reported immediately.

Methods

experimental inherited bindTo(key, target, opt_targetKey){ol.ObjectAccessor}

src/ol/object.js, line 247

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Argument	Description
key	string		Key name.
target	ol.Object		Target.
targetKey	string	<optional>	optional Target key.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:

• change

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental getAlpha(){number|undefined}

src/ol/deviceorientation.js, line 143

Returns:

euler angle in radians of the device from the standard Z axis.

experimental getBeta(){number|undefined}

src/ol/deviceorientation.js, line 159

Returns:

euler angle in radians of the device from the planar X axis.

experimental getGamma(){number|undefined}

src/ol/deviceorientation.js, line 175

Returns:

euler angle in radians of the device from the planar Y axis.

experimental getHeading(){number|undefined}

src/ol/deviceorientation.js, line 191

Returns:

heading of the device relative to north, in radians, normalizing for different browser behavior.

experimental inherited getKeys(){Array.<string>}

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental inherited getProperties(){Object.<string, *>}

src/ol/object.js, line 364

Get an object of all property names and values.

experimental getTracking(){boolean}

src/ol/deviceorientation.js, line 208

Are we tracking the device's orientation?

Returns:

status of tracking changes to alpha, beta and gamma. If true, changes are tracked and reported immediately.

experimental inherited notify(key)

src/ol/object.js, line 384

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Name	Type	Description
key	string	Key name.

experimental inherited on(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 61

Listen for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental setTracking(tracking)

src/ol/deviceorientation.js, line 242

Enable or disable tracking of DeviceOrientation events.

Name	Type	Description
tracking	boolean	The status of tracking changes to alpha, beta and gamma. If true, changes are tracked and reported immediately.

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

experimental inherited unbind(key)

src/ol/object.js, line 458

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

Removes an event listener using the key returned by on() or once().

Name	Type	Description
key	goog.events.Key	Key.