The x
read-only property of the Magnetometer
interface returns a double precision integer containing the magnetic field around the device's x axis.
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 magnetometerx = magnetometer.x
Value
A Number
.
Example
The magnetometer is typically read in the Sensor.onreading
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 | Status | Comment |
Generic Sensor API | Candidate Recommendation | Defines sensors in general. |
MagnetometerThe definition of 'x' in that specification. | Candidate Recommendation |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
x
|
Chrome
Full support 56 |
Edge
Full support 79 |
Firefox
No support No |
IE
No support No |
Opera
Full support 43 |
Safari
No support No |
WebView Android
No support No |
Chrome Android
Full support 56 |
Firefox Android
No support No |
Opera Android
Full support 43 |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
Magnetometer.x by Mozilla Contributors is licensed under CC-BY-SA 2.5.