Limited availability
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 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. In addition, this feature may be blocked by a Permissions Policy set on your server.
Magnetometer()
Experimental
Creates a new Magnetometer
object.
Magnetometer.x
Read only Experimental
Returns a double containing the magnetic field around the device's x axis.
Magnetometer.y
Read only Experimental
Returns a double containing the magnetic field around the device's y axis.
Magnetometer.z
Read only Experimental
Returns a double containing the magnetic field around the device's z axis.
Magnetometer
doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor
and EventTarget
.
Magnetometer
doesn't have own events. However, it inherits events from its parent interface, Sensor
.
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
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4