Magnetometer: Magnetometer() constructor
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Magnetometer() constructor
creates a new Magnetometer object which returns information about the
magnetic field as detected by a device's primary magnetometer sensor.
Syntax
js
new Magnetometer()
new Magnetometer(options)
Parameters
optionsOptional-
Options are as follows:
frequency-
The desired number of times per second a sample should be taken, meaning the number of times per second that the
readingevent will be called. A whole number or decimal may be used, the latter for frequencies less than a second. The actual reading frequency depends on device hardware and consequently may be less than requested. referenceFrame-
Either
'device'or'screen'. The default is'device'.
Exceptions
SecurityErrorDOMException-
Use of this feature was blocked by a Permissions Policy.
Specifications
| Specification |
|---|
| Magnetometer # dom-magnetometer-magnetometer |
Browser compatibility
BCD tables only load in the browser
See also
readingevent