Element.releasePointerCapture()

Releases (stops) pointer capture that was previously set for a specific (PointerEvent) pointer.

See the Element.setPointerCapture() method for a description of pointer capture and how to set it for a particular element.

Syntax

JavaScript
targetElement.releasePointerCapture(pointerId);

Arguments

pointerId
The identifier for a pointer event.

Return value

If pointerId does not match any the active pointers, this method returns void and throws a DOMException with the name InvalidPointerId.

Example

JavaScript
<html>
<script>
function downHandler(ev) {
 var el=document.getElementById("target");
 // Element "target" will receive/capture further events
 el.setPointerCapture(ev.pointerId);
}
function cancelHandler(ev) {
 var el=document.getElementById("target");
 // Release the pointer capture
 el.releasePointerCapture(ev.pointerId);
}
function init() {
 var el=document.getElementById("target");
 // Register pointerdown and pointercancel handlers
 el.onpointerdown = downHandler;
 el.onpointercancel = cancelHandler;
}
</script>
<body onload="init();">
<div id="target"> Touch me ... </div>
</body>
</html>

Specifications

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support (Yes) [1] 10 No support No support
Feature Android Android Webview Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
Basic support No support No support No support No support No support 10 No support No support

[1] Implementation withdrawn. See bug 1166347.

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/element/releasepointercapture

API DOM Element Method PointerEvent Reference