GravitySensor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

The GravitySensor interface of the Sensor APIs provides on each reading the gravity applied to the device along all three axes.

To use this sensor, the user must grant permission to the 'accelerometer' device sensor through the Permissions API. In addition, this feature may be blocked by a Permissions Policy set on your server.

EventTarget Sensor Accelerometer GravitySensor

Constructor

GravitySensor()

Creates a new GravitySensor object.

Instance properties

Inherits properties from its ancestors, Accelerometer, Sensor, and EventTarget.

Instance methods

GravitySensor doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor and EventTarget.

Events

GravitySensor doesn't have own events. However, it inherits events from its parent interface, Sensor.

Example

Gravity is typically read in the reading event callback. In the example below this occurs sixty times a second.

js
let gravitySensor = new GravitySensor({ frequency: 60 });

gravitySensor.addEventListener("reading", (e) => {
  console.log(`Gravity along the X-axis ${gravitySensor.x}`);
  console.log(`Gravity along the Y-axis ${gravitySensor.y}`);
  console.log(`Gravity along the Z-axis ${gravitySensor.z}`);
});

gravitySensor.start();

Specifications

Specification
Accelerometer
# gravitysensor-interface

Browser compatibility

BCD tables only load in the browser