Magnetometer | Frontend Practical Guide

Browser support

Feature	Desktop				Mobile
Feature	Chrome	Edge	Firefox	Safari	Chrome Android	Safari iOS
`Magnetometer` Experimental	56	79			56
HTML attribute
`allow (magnetometer)` Experimental	66	79			66
DOM API
`Magnetometer` Experimental The Magnetometer() constructor creates a new Magnetometer object which returns information about the magnetic field as detected by a device's primary magnetometer sensor.	56	79			56
`x` Experimental The x read-only property of the Magnetometer interface returns a number specifying the magnetic field around the device's x-axis.	56	79			56
`y` Experimental The y read-only property of the Magnetometer interface returns a number specifying the magnetic field around the device's y-axis.	56	79			56
`z` Experimental The z read-only property of the Magnetometer interface returns a number specifying the magnetic field around the device's z-axis.	56	79			56
`permission_magnetometer` Experimental `magnetometer` permission	62	79			62
Other
`magnetometer` Experimental The HTTP Permissions-Policy header magnetometer directive controls whether the current document is allowed to gather information about the orientation of the device through the Magnetometer interface.	66	79			66

1+Supported (version) Not supported ※Has note Sub-feature descriptions sourced from MDN Web Docs (CC BY-SA 2.5)

Syntax

JAVASCRIPT

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();

Use cases

Using Magnetometer

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

Cautions

Limited browser support. Check compatibility before use.

Implementation notes

Some APIs require a secure context (HTTPS) or user activation. Check the requirements before use.

Browser support

Syntax

Use cases

Using Magnetometer

Cautions

Implementation notes

Related links