Element: pointercancel event
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2020.
Thepointercancel event is fired when the browser determines that there are unlikely to be any more pointer events, or if after thepointerdown event is fired, the pointer is then used to manipulate the viewport by panning, zooming, or scrolling.
Some examples of situations that will trigger apointercancel 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. - When the user interacts with too many simultaneous pointers, the browser can fire this event for all existing pointers (even if the user is still touching the screen).
Note:After thepointercancel event is fired, the browser will also sendpointerout followed bypointerleave.
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("pointercancel", (event) => { })onpointercancel = (event) => { }Event type
APointerEvent. Inherits fromEvent.
Event properties
This interface inherits properties fromMouseEvent andEvent.
PointerEvent.altitudeAngleRead onlyExperimentalRepresents the angle between a transducer (a pointer or stylus) axis and the X-Y plane of a device screen.
PointerEvent.azimuthAngleRead onlyExperimentalRepresents the angle between the Y-Z plane and the plane containing both the transducer (a pointer or stylus) axis and the Y axis.
PointerEvent.persistentDeviceIdRead onlyExperimentalA unique identifier for the pointing device generating the
PointerEvent.PointerEvent.pointerIdRead onlyA unique identifier for the pointer causing the event.
PointerEvent.widthRead onlyThe width (magnitude on the X axis), in CSS pixels, of the contact geometry of the pointer.
PointerEvent.heightRead onlyThe height (magnitude on the Y axis), in CSS pixels, of the contact geometry of the pointer.
PointerEvent.pressureRead onlyThe normalized pressure of the pointer input in the range
0to1, where0and1represent the minimum and maximum pressure the hardware is capable of detecting, respectively.PointerEvent.tangentialPressureRead onlyThe normalized tangential pressure of the pointer input (also known as barrel pressure orcylinder stress) in the range
-1to1, where0is the neutral position of the control.PointerEvent.tiltXRead onlyThe plane angle (in degrees, in the range of
-90to90) between the Y–Z plane and the plane containing both the pointer (e.g., pen stylus) axis and the Y axis.PointerEvent.tiltYRead onlyThe plane angle (in degrees, in the range of
-90to90) between the X–Z plane and the plane containing both the pointer (e.g., pen stylus) axis and the X axis.PointerEvent.twistRead onlyThe clockwise rotation of the pointer (e.g., pen stylus) around its major axis in degrees, with a value in the range
0to359.PointerEvent.pointerTypeRead onlyIndicates the device type that caused the event (mouse, pen, touch, etc.).
PointerEvent.isPrimaryRead onlyIndicates if the pointer represents the primary pointer of this pointer type.
Examples
UsingaddEventListener():
const para = document.querySelector("p");para.addEventListener("pointercancel", (event) => { console.log("Pointer event cancelled");});Using theonpointercancel event handler property:
const para = document.querySelector("p");para.onpointercancel = (event) => { console.log("Pointer event cancelled");};Specifications
| Specification |
|---|
| Pointer Events> # the-pointercancel-event> |
| Pointer Events> # dom-globaleventhandlers-onpointercancel> |