W3cubDocs

/DOM

Magnetometer.constructor

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 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 compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 69 ? ? ? 56 ?
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support 69 69 ? ? 56 ? ?

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Magnetometer/Magnetometer