Magnetometer: z property

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 in secure contexts (HTTPS), in some or all supporting browsers.

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

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

Specification
Magnetometer # magnetometer-z

Browser compatibility

BCD tables only load in the browser