new ol.DeviceOrientation(opt_options) experimental
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change
experimental - Triggered when the device orientation changes. -
change:alpha
(ol.ObjectEvent) experimental -
change:beta
(ol.ObjectEvent) experimental -
change:gamma
(ol.ObjectEvent) experimental -
change:heading
(ol.ObjectEvent) experimental -
change:tracking
(ol.ObjectEvent) experimental -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
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 |
Changes in device orientation are being tracked. |
Methods
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getAlpha(){number|undefined} experimental
src/ol/deviceorientation.js, line 146 -
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} experimental
src/ol/deviceorientation.js, line 159 -
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} experimental
src/ol/deviceorientation.js, line 172 -
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} experimental
src/ol/deviceorientation.js, line 185 -
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.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
getTracking(){boolean} experimental
src/ol/deviceorientation.js, line 197 -
Determine if orientation is being tracked.
Returns:
Changes in device orientation are being tracked.
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 75 -
Listen for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 88 -
Listen once for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
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 values
Object.<string, *> Values.
-
setTracking(tracking) experimental
src/ol/deviceorientation.js, line 227 -
Enable or disable tracking of device orientation events.
Name Type Description tracking
boolean The status of tracking changes to alpha, beta and gamma. If true, changes are tracked and reported immediately.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 101 -
Unlisten for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object which was used as
this
by thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.