The screenX
read-only property of the
MouseEvent
interface provides the horizontal coordinate (offset) of the
mouse pointer in global (screen) coordinates.
Syntax
var x = instanceOfMouseEvent.screenX
Return value
A double
floating point value. Early versions of the spec defined this as
an integer referring to the number of pixels. See the "Browser compatibility" section
for details.
Example
This example displays your mouse's coordinates whenever you trigger the
mousemove
event.
HTML
<p>Move your mouse to see its position.</p>
<p id="screen-log"></p>
JavaScript
let screenLog = document.querySelector('#screen-log');
document.addEventListener('mousemove', logKey);
function logKey(e) {
screenLog.innerText = `
Screen X/Y: ${e.screenX}, ${e.screenY}
Client X/Y: ${e.clientX}, ${e.clientY}`;
}
Result
Routing an event
When you trap events on the window, document, or other roomy elements, you can get the coordinates of that event (e.g., a click) and route it properly, as the following example demonstrates:
function checkClickMap(e) {
if (e.screenX < 50) doRedButton();
if (50 <= e.screenX && e.screenX < 100) doYellowButton();
if (e.screenX >= 100) doRedButton();
}
Specifications
Specification | Status | Comment |
---|---|---|
CSS Object Model (CSSOM) View Module The definition of 'screenX' in that specification. |
Working Draft | Redefines MouseEvent from long to double. |
Document Object Model (DOM) Level 3 Events Specification The definition of 'MouseEvent.screenX' in that specification. |
Obsolete | No change from Document Object Model (DOM) Level 2 Events Specification. |
Document Object Model (DOM) Level 2 Events Specification The definition of 'MouseEvent.sceenX' in that specification. |
Obsolete | Initial definition |
Browser compatibility
BCD tables only load in the browser