Magnetometer
The Magnetometer
interface of the Sensor 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 the Permissions API.
If a feature policy blocks use of a feature, it's because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. The Feature-Policy
HTTP header article contains implementation instructions.
Constructor
Magnetometer()
-
Creates a new
Magnetometer
object.
Properties
Magnetometer.x
Read only-
Returns a double containing the magnetic field around the device's x axis.
Magnetometer.y
Read only-
Returns a double containing the magnetic field around the device's y axis.
Magnetometer.z
Read only-
Returns a double containing the magnetic field around the device's z axis.
Methods
Magnetometer
doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor
and EventTarget
.
Events
Magnetometer
doesn't have own events. However, it inherits events from its parent interface, Sensor
.
Example
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-interface |
Browser compatibility
BCD tables only load in the browser