DeviceMotionEvent: DeviceMotionEvent() constructor

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The DeviceMotionEvent() constructor creates a new DeviceMotionEvent object.

Syntax

js
new DeviceMotionEvent(type)
new DeviceMotionEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers always set it to devicemotion.

options Optional

An object that, in addition of the properties defined in Event(), can have the following properties:

acceleration Optional

A DeviceMotionEventAcceleration object giving the acceleration of the device on the three axis X, Y and Z. Acceleration is expressed in m/s². If not specified, every properties in the object will be null.

accelerationIncludingGravity Optional

A DeviceMotionEventAcceleration object giving the acceleration of the device on the three axis X, Y and Z with the effect of gravity. Acceleration is expressed in m/s². If not specified, every properties in the object will be null.

rotationRate Optional

A DeviceMotionEventRotationRate object giving the rate of change of the device's orientation on the three orientation axis alpha, beta and gamma. Rotation rate is express in degrees per seconds. If not specified, every properties in the object will be null.

interval Optional

A number representing the interval of time, in milliseconds, at which data is obtained from the device. It defaults to 0.

Return value

A new DeviceMotionEvent object.

Specifications

Specification
DeviceOrientation Event Specification
# dom-devicemotionevent-devicemotionevent

Browser compatibility

BCD tables only load in the browser