Element.releasePointerCapture()

This article needs a technical review. How you can help.

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.

SyntaxEdit

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.

ExampleEdit

<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>

SpecificationsEdit

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 compatibilityEdit

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support (Yes) [1] 10 No support No support

[1] Implementation withdrawn. See bug 1166347.

See alsoEdit

Document Tags and Contributors

 Contributors to this page: rolfedh, AFBarstow
 Last updated by: rolfedh,