Magnetometer

The Magnetometer interface of the Sensor APIs provides information about the magnetic field as detected by the device’s primary magnetometer sensor.

To use this sensor, the user must grant permission to the 'magnetometer' device sensor through the Permissions API.

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.

Constructor

Magnetometer.Magnetometer()
Creates a new Magnetometer object.

Properties

Magnetometer.x Read only
Returns a double containing the magnetic field around the device's x axis.
Magnetometer.y Read only
Returns a double containing the magnetic field around the device's y axis.
Magnetometer.z Read only
Returns a double containing the magnetic field around the device's z axis.

Example

The magnetometer is typically read in the Sensor.onreading event callback. In the example below this occurs sixty times a second.

let magSensor = new Magnetometer({frequency: 60});

magSensor.addEventListener('reading', e => {
  console.log("Magnetic field along the X-axis " + magSensor.x);
  console.log("Magnetic field along the Y-axis " + magSensor.y);
  console.log("Magnetic field along the Z-axis " + magSensor.z);
});
magSensor.start();

Specifications

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic supportChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Edge Mobile ? Firefox Android ? Opera Android Full support 56Safari iOS ? Samsung Internet Android ?
Magnetometer() constructorChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Edge Mobile ? Firefox Android ? Opera Android Full support 56Safari iOS ? Samsung Internet Android ?
xChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Edge Mobile ? Firefox Android ? Opera Android Full support 56Safari iOS ? Samsung Internet Android ?
yChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Edge Mobile ? Firefox Android ? Opera Android Full support 56Safari iOS ? Samsung Internet Android ?
zChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Edge Mobile ? Firefox Android ? Opera Android Full support 56Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown

Document Tags and Contributors

Contributors to this page: jpmedley
Last updated by: jpmedley,