PointerEvent extension type

The PointerEvent interface represents the state of a DOM event produced by a pointer such as the geometry of the contact point, the device type that generated the event, the amount of pressure that was applied on the contact surface, etc.

A pointer is a hardware agnostic representation of input devices (such as a mouse, pen or contact point on a touch-enable surface). The pointer can target a specific coordinate (or set of coordinates) on the contact surface such as a screen.

A pointer's hit test is the process a browser uses to determine the target element for a pointer event. Typically, this is determined by considering the pointer's location and also the visual layout of elements in a document on screen media.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

PointerEvent(String type, [PointerEventInit eventInitDict])
factory

Properties

altKey → bool
The MouseEvent.altKey read-only property is a boolean value that indicates whether the alt key was pressed or not when a given mouse event occurs.
no setterinherited
bubbles → bool
The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.
no setterinherited
button → int
The MouseEvent.button read-only property indicates which button was pressed on the mouse to trigger the event.
no setterinherited
buttons → int
The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.
no setterinherited
cancelable → bool
The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.
no setterinherited
cancelBubble ↔ bool
The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.
getter/setter pairinherited
clientX → int
The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's at which the event occurred (as opposed to the coordinate within the page).
no setterinherited
clientY → int
The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's at which the event occurred (as opposed to the coordinate within the page).
no setterinherited
composed → bool
The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
no setterinherited
ctrlKey → bool
The MouseEvent.ctrlKey read-only property is a boolean value that indicates whether the ctrl key was pressed or not when a given mouse event occurs.
no setterinherited
currentTarget → EventTarget?
The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.
no setterinherited
defaultPrevented → bool
The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault canceled the event.
no setterinherited
detail → int
The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.
no setterinherited
eventPhase → int
The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
height → double
The height read-only property of the PointerEvent interface represents the height of the pointer's contact geometry, along the y-axis (in CSS pixels). Depending on the source of the pointer device (for example a finger), for a given pointer, each event may produce a different value.
no setter
isPrimary → bool
The isPrimary read-only property of the PointerEvent interface indicates whether or not the pointer device that created the event is the primary pointer. It returns true if the pointer that caused the event to be fired is the primary one and returns false otherwise.
no setter
isTrusted → bool
The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus), and false when the event was dispatched via EventTarget.dispatchEvent. The only exception is the click event, which initializes the isTrusted property to false in user agents.
no setterinherited
metaKey → bool
The MouseEvent.metaKey read-only property is a boolean value that indicates whether the meta key was pressed or not when a given mouse event occurs.
no setterinherited
movementX → double
The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous Element.mousemove_event event. In other words, the value of the property is computed like this: currentEvent.movementX = currentEvent.screenX - previousEvent.screenX.
no setterinherited
movementY → double
The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous Element.mousemove_event event. In other words, the value of the property is computed like this: currentEvent.movementY = currentEvent.screenY - previousEvent.screenY.
no setterinherited
offsetX → double
The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.
no setterinherited
offsetY → double
The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.
no setterinherited
pageX → double
The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document. This includes any portion of the document not currently visible.
no setterinherited
pageY → double
The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate (in pixels) at which the mouse was clicked, relative to the top edge of the entire document. This includes any portion of the document not currently visible.
no setterinherited
pointerId → int
The pointerId read-only property of the PointerEvent interface is an identifier assigned to a given pointer event. The identifier is unique, being different from the identifiers of all other active pointer events. Since the value may be randomly generated, it is not guaranteed to convey any particular meaning.
no setter
pointerType → String
The pointerType read-only property of the PointerEvent interface indicates the device type (mouse, pen, or touch) that caused a given pointer event.
no setter
pressure → double
The pressure read-only property of the PointerEvent interface indicates the normalized pressure of the pointer input.
no setter
relatedTarget → EventTarget?
The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.
no setterinherited
returnValue ↔ bool
The Event property returnValue indicates whether the default action for this event has been prevented or not.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenX → int
The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in screen coordinates.
no setterinherited
screenY → int
The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in screen coordinates.
no setterinherited
shiftKey → bool
The MouseEvent.shiftKey read-only property is a boolean value that indicates whether the shift key was pressed or not when a given mouse event occurs.
no setterinherited
srcElement → EventTarget?
The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.
no setterinherited
tangentialPressure → double
The tangentialPressure read-only property of the PointerEvent interface represents the normalized tangential pressure of the pointer input (also known as barrel pressure or cylinder stress).
no setter
target → EventTarget?
The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.
no setterinherited
tiltX → int
The tiltX read-only property of the PointerEvent interface is the angle (in degrees) between the Y-Z plane of the pointer and the screen. This property is typically only useful for a pen/stylus pointer type.
no setter
tiltY → int
The tiltY read-only property of the PointerEvent interface is the angle (in degrees) between the X-Z plane of the pointer and the screen. This property is typically only useful for a pen/stylus pointer type.
no setter
timeStamp → double
The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.
no setterinherited
twist → int
The twist read-only property of the PointerEvent interface represents the clockwise rotation of the pointer (e.g., pen stylus) around its major axis, in degrees.
no setter
type → String
The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.
no setterinherited
view → Window?
The UIEvent.view read-only property returns the object from which the event was generated. In browsers, this is the Window object the event happened in.
no setterinherited
which → int
The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.
no setterinherited
width → double
The width read-only property of the PointerEvent interface represents the width of the pointer's contact geometry along the x-axis, measured in CSS pixels. Depending on the source of the pointer device (such as a finger), for a given pointer, each event may produce a different value.
no setter
x → double
The MouseEvent.x property is an alias for the MouseEvent.clientX property.
no setterinherited
y → double
The MouseEvent.y property is an alias for the MouseEvent.clientY property.
no setterinherited

Methods

composedPath() → JSArray<EventTarget>
The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
inherited
getCoalescedEvents() → JSArray<PointerEvent>
The getCoalescedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that were coalesced (merged) into a single Element.pointermove_event or Element.pointerrawupdate_event event. Instead of a stream of many Element.pointermove_event events, user agents coalesce multiple updates into a single event. This helps with performance as the user agent has less event handling to perform, but there is a reduction in the granularity and accuracy when tracking, especially with fast and large movements.
getModifierState(String keyArg) → bool
The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.
inherited
getPredictedEvents() → JSArray<PointerEvent>
The getPredictedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that are estimated future pointer positions. How the predicted positions are calculated depends on the user agent, but they are based on past points, current velocity, and trajectory.
initEvent(String type, [bool bubbles, bool cancelable]) → void
The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent.
inherited
initMouseEvent(String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, bool ctrlKeyArg, bool altKeyArg, bool shiftKeyArg, bool metaKeyArg, int buttonArg, EventTarget? relatedTargetArg]) → void
The MouseEvent.initMouseEvent() method initializes the value of a mouse event once it's been created (normally using the Document.createEvent method).
inherited
initUIEvent(String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg]) → void
The UIEvent.initUIEvent() method initializes a UI event once it's been created.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
preventDefault() → void
The preventDefault() method of the Event interface tells the that if the event does not get explicitly handled, its default action should not be taken as it normally would be.
inherited
stopImmediatePropagation() → void
The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.
inherited
stopPropagation() → void
The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the Event.preventDefault method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see Event.stopImmediatePropagation.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited