Document: pointercancel event
The pointercancel event is fired when the browser determines that there are unlikely to be any more pointer events, or if after the pointerdown event is fired, the pointer is then used to manipulate the viewport by panning, zooming, or scrolling.
| Bubbles | Yes |
|---|---|
| Cancelable | No |
| Interface | PointerEvent |
| Event handler property | onpointercancel |
Some examples of situations that will trigger a pointercancel event:
- A hardware event occurs that cancels the pointer activities. This may include, for example, the user switching applications using an application switcher interface or the "home" button on a mobile device.
- The device's screen orientation is changed while the pointer is active.
- The browser decides that the user started pointer input accidentally. This can happen if, for example, the hardware supports palm rejection to prevent a hand resting on the display while using a stylus from accidentally triggering events.
- The
touch-actionCSS property prevents the input from continuing.
Note: After the pointercancel event is fired, the browser will also send pointerout followed by pointerleave.
Examples
Using addEventListener():
document.addEventListener('pointercancel', (event) => { console.log('Pointer event cancelled') });
Using the onpointercancel event handler property:
document.onpointercancel = (event) => { console.log('Pointer event cancelled') };
Specifications
| Specification |
|---|
| Pointer Events # the-pointercancel-event |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
pointercancel_event |
55 |
12
12-79
|
59
29
|
11
10
|
42 |
13 |
55 |
55 |
79
29
|
42 |
13 |
6.0 |
See also
- Related events
-
GlobalEventHandlers.onpointercancelevent handler property - This event on
HTMLElementtargets:pointercancelevent
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Document/pointercancel_event