MDN self-hosted library · e01.org

Magnetometer: z property

Sensor API

Open notebook · 1 cells web-api-instance-property upstream source

Sensor API

The z read-only property of the Magnetometer interface returns a number specifying the magnetic field around the device's z-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.

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

Browser compatibility