GravitySensor: GravitySensor() constructor

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() constructor creates a new GravitySensor object which provides on each reading the gravity applied to the device along all three axes.

Syntax

js
new GravitySensor()
new GravitySensor(options)

Parameters

options Optional

Options are as follows:

frequency Optional

The desired number of times per second a sample should be taken, meaning the number of times per second that the reading event will be called. A whole number or decimal may be used, the latter for frequencies less than a second. The actual reading frequency depends on device hardware and consequently may be less than requested. The default frequency is the one defined by the underlying platform.

referenceFrame Optional

The local coordinate system representing the reference frame. It can be either 'device' or 'screen'. The default is 'device'.

Exceptions

SecurityError DOMException

Use of this feature was blocked by a Permissions Policy.

Specifications

Specification
Accelerometer
# dom-gravitysensor-gravitysensor

Browser compatibility

See also