Magnetometer: z property

{{securecontext_header}}{{APIRef("Sensor API")}}{{SeeCompatTable}}

The z read-only property of the {{domxref("Magnetometer")}} interface returns a number specifying the magnetic field around the device's z-axis.

Value

A {{jsxref('Number')}}.

Examples

The magnetometer is typically read in the {{domxref('Sensor.reading_event', '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

{{Specifications}}

Browser compatibility

{{Compat}}