DeviceMotionEvent: accelerationIncludingGravity property

{{APIRef("Device Orientation Events")}}{{securecontext_header}}

The accelerationIncludingGravity read-only property of the {{domxref("DeviceMotionEvent")}} interface returns the amount of acceleration recorded by the device, in meters per second squared (m/s²). Unlike {{DOMxRef("DeviceMotionEvent.acceleration")}} which compensates for the influence of gravity, its value is the sum of the acceleration of the device as induced by the user and an acceleration equal and opposite to that caused by gravity. In other words, it measures the g-force. In practice, this value represents the raw data measured by an accelerometer.

This value is not typically as useful as {{DOMxRef("DeviceMotionEvent.acceleration")}}, but may be the only value available on devices that aren't able to remove gravity from the acceleration data, such as on devices that don't have a gyroscope.

[!NOTE] accelerationIncludingGravity's name can be misleading. This property represents acceleration including the effects of gravity. For example, if a device is lying flat on a horizontal surface with the screen pointing up, gravity would be -9.8 along the Z axis, while acceleration.z would be 0 and accelerationIncludingGravity.z would be 9.8. Similarly, if a device is in free fall with its screen horizontal and pointing up, gravity would be -9.8 along the Z axis, while acceleration.z would be -9.8 and accelerationIncludingGravity.z would be 0.

Value

The accelerationIncludingGravity property is an object providing information about acceleration on three axis. Each axis is represented with its own property:

• x
  • : Represents the acceleration upon the x axis which is the west to east axis
• y
  • : Represents the acceleration upon the y axis which is the south to north axis
• z
  • : Represents the acceleration upon the z axis which is the down to up axis

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("Device orientation events/Detecting device orientation", "Detecting device orientation", "", "nocode")}}
• {{domxref("Device orientation events/Orientation and motion data explained", "Orientation and motion data explained", "", "nocode")}}
• {{DOMxRef("Window/devicemotion_event", "devicemotion")}} event