Web/API/Magnetometer/Magnetometer

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

If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. See Feature-Policy for implementation instructions.

Syntax

var 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 sensor.onreading 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'.

Specifications

Specification	Status	Comment
Generic Sensor API	Candidate Recommendation	Defines sensors in general.
MagnetometerThe definition of 'Magnetometer' in that specification.	Candidate Recommendation

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`Magnetometer()` constructor	Chrome Full support 56	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 43	Safari No support No	WebView Android No support No	Chrome Android Full support 56	Firefox Android No support No	Opera Android Full support 43	Safari iOS No support No	Samsung Internet Android No support No

Legend

Full support: Full support
No support: No support

Magnetometer.Magnetometer() by Mozilla Contributors is licensed under CC-BY-SA 2.5.