ol. ol.DeviceOrientation

new DeviceOrientation

Parameters:
Name Type Argument Description
options ol.DeviceOrientationOptions <optional>
(Optional)

Options.

Source:
  • deviceorientation.js, line 28

Extends

Members

<static, constant> SUPPORTED :boolean

Is supported.

Source:
  • deviceorientation.js, line 64

Methods

bindTo

Binds a View to a Model.

Parameters:
Name Type Argument Description
key string

Key.

target ol.Object

Target.

targetKey string <optional>
(Optional)

Target key.

noNotify boolean <optional>
(Optional)

No notify.

Inherited From:
Source:
  • object.js, line 147

get

Gets a value.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 170
Returns:

Value.

Type
*

getAlpha

Source:
  • deviceorientation.js, line 96
Returns:

alpha.

Type
number | undefined

getBeta

Source:
  • deviceorientation.js, line 109
Returns:

beta.

Type
number | undefined

getGamma

Source:
  • deviceorientation.js, line 122
Returns:

gamma.

Type
number | undefined

getHeading

Source:
  • deviceorientation.js, line 135
Returns:

heading.

Type
number | undefined

getTracking

Are we tracking the device's orientation?

Source:
  • deviceorientation.js, line 149
Returns:

tracking.

Type
boolean

notify

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.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 208

on

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 240
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 253
Returns:

Unique key for the listener.

Type
goog.events.Key

set

Sets a value.

Parameters:
Name Type Description
key string

Key.

value *

Value.

Inherited From:
Source:
  • object.js, line 263

setTracking

Parameters:
Name Type Description
tracking boolean

Enable or disable tracking.

Source:
  • deviceorientation.js, line 179

setValues

Sets a collection of key-value pairs.

Parameters:
Name Type Description
values Object.<string, *>

Values.

Inherited From:
Source:
  • object.js, line 286

un

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 326

unbind

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.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 305

unbindAll

Removes all bindings.

Inherited From:
Source:
  • object.js, line 344

unByKey

Removes an event listener which was added with listen() by the key returned by on().

Parameters:
Name Type Argument Description
key number <nullable>

Key.

Inherited From:
Source:
  • object.js, line 336