Magnetometer

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.

TheMagnetometer interface of theSensor 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 thePermissions API. In addition, this feature may be blocked by aPermissions Policy set on your server.

Constructor

Magnetometer()Experimental: Creates a newMagnetometer object.

Instance properties

Magnetometer.xRead onlyExperimental: Returns a double containing the magnetic field around the device's x axis.
Magnetometer.yRead onlyExperimental: Returns a double containing the magnetic field around the device's y axis.
Magnetometer.zRead onlyExperimental: Returns a double containing the magnetic field around the device's z axis.

Instance methods

Magnetometer doesn't have own methods. However, it inherits methods from its parent interfaces,Sensor andEventTarget.

Events

Magnetometer doesn't have own events. However, it inherits events from its parent interface,Sensor.

Example

The magnetometer is typically read in thereading 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();