W3cubDocs

/Web APIs

Magnetometer: Magnetometer() constructor

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Magnetometer() constructor creates a new Magnetometer object which returns information about the magnetic field as detected by a device's primary magnetometer sensor.

Syntax

js

new Magnetometer()
new Magnetometer(options)

Parameters

options Optional

Options are as follows:

frequency

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.

referenceFrame

Either 'device' or 'screen'. The default is 'device'.

Exceptions

SecurityError DOMException

Use of this feature was blocked by a Permissions Policy.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Magnetometer 56 79 No No 43 No No 56 No No No No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Magnetometer/Magnetometer