W3cubDocs

/Web APIs

Magnetometer: x property

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

The x read-only property of the Magnetometer interface returns a number specifying the magnetic field around the device's x-axis.

Value

A Number.

Examples

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

js

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
Magnetometer
# magnetometer-x

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
x 56 79 No No 43 No No 56 No No No No

© 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/x