Magnetometer.Magnetometer()

The Magnetometer constructor creates a new Magnetometer object which returns information about the magnetic field as detected by a device’s primary magnetometer sensor.

If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. See Feature-Policy for implementation instructions.

Syntax

var magnetometer = new Magnetometer([options])

Parameters

options Optional
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 sensor.onreading 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'.

Specifications

Specification Status Comment
Generic Sensor API Candidate Recommendation Defines sensors in general.
Magnetometer
The definition of 'Magnetometer' in that specification.
Candidate Recommendation  

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Magnetometer() constructorChrome Full support 69Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 69Chrome Android Full support 69Firefox Android ? Opera Android Full support 48Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown