W3cubDocs

/DOM

element.setPointerCapture

Pointer capture allows events for a particular pointer event (PointerEvent) to be re-targeted to a particular element instead of the normal target (or hit test) at a pointer's location. This can be used to ensure that an element continues to receive pointer events even if the pointer device's contact moves off the element (for example by scrolling).

setPointerCapture() is the method of the Element interface used to designate a specific element as the capture target of future pointer events. Subsequent events for the pointer will be targeted at capture element until capture is released (via Element.releasePointerCapture).

When pointer capture is set, pointerover, pointerout pointerenter and pointerleave events are only generated when crossing the boundary of the element that has capture set since other elements can no longer be targeted by the pointer. This has the effect of suppressing these events on all other elements.

Syntax

targetElement.setPointerCapture(pointerId);

Arguments

pointerId: The identifier for a pointer event.

Return value

This method returns void and throws a DOMException with the name InvalidPointerId if pointerId does not match any of the active pointers.

Example

<html>
<script>
function downHandler(ev) {
 var el=document.getElementById("target");
 //Element 'target' will receive/capture further events
 el.setPointerCapture(ev.pointerId);
}
function init() {
 var el=document.getElementById("target");
 el.onpointerdown = downHandler;
}
</script>
<body onload="init();">
<div id="target"> Touch me ... </div>
</body>
</html>

Specifications

Specification	Status	Comment
Pointer Events – Level 2 The definition of 'setPointerCapture' in that specification.	Working Draft	Non-stable version.
Pointer Events The definition of 'setPointerCapture' in that specification.	Recommendation	Initial definition.

Browser compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	55	?	59 59 41 Disabled Disabled From version 41: this feature is behind the `dom.w3c_pointer_events.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	11 11 10 Prefixed Prefixed Requires the vendor prefix: ms	42	No

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	55	55	?	No No 41 Disabled Disabled From version 41: this feature is behind the `dom.w3c_pointer_events.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	42	No	?