class PointerEvent extends MouseEvent
Most of today's web content assumes the user's pointing device will be a mouse. However, since many devices support other types of pointing input devices, such as pen/stylus and touch surfaces, extensions to the existing pointing device event models are needed and pointer events address that need.
Pointer events are DOM events that are fired for a pointing device. They are designed to create a single DOM event model to handle pointing input devices such as a mouse, pen/stylus or touch (such as one or more fingers). The pointer is a hardware-agnostic device that can target a specific set of screen coordinates. Having a single event model for pointers can simplify creating Web sites and applications and provide a good user experience regardless of the user's hardware. However, for scenarios when device-specific handling is desired, pointer events defines a property to inspect the device type which produced the event.
The events needed to handle generic pointer input are analogous to mouse events (mousedown/pointerdown, mousemove/pointermove, etc.). Consequently, pointer event types are intentionally similar to mouse event types. Additionally, a pointer event contains the usual properties present in mouse events (client coordinates, target element, button states, etc.) in addition to new properties for other forms of input: pressure, contact geometry, tilt, etc. In fact, the PointerEvent interface inherits all of the MouseEvent's properties thus facilitating migrating content from mouse events to pointer events.
MDN
- Annotations
- @JSType() @native() @JSGlobal()
- Alphabetic
- By Inheritance
- PointerEvent
- MouseEvent
- ModifierKeyEvent
- UIEvent
- Event
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PointerEvent(typeArg: String)
- new PointerEvent(typeArg: String, pointerEventInit: UndefOr[PointerEventInit] = js.undefined)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
altKey: Boolean
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
MDN
- Definition Classes
- ModifierKeyEvent
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bubbles: Boolean
A boolean indicating whether the event bubbles up through the DOM or not.
A boolean indicating whether the event bubbles up through the DOM or not.
MDN
- Definition Classes
- Event
-
def
button: Int
The button property indicates which button was pressed on the mouse to trigger the event.
The button property indicates which button was pressed on the mouse to trigger the event.
MDN
- Definition Classes
- MouseEvent
-
def
buttons: Int
The buttons property indicates which buttons were pressed on the mouse to trigger the event.
The buttons property indicates which buttons were pressed on the mouse to trigger the event.
MDN
- Definition Classes
- MouseEvent
-
def
cancelBubble: Boolean
A boolean indicating whether the bubbling of the event has been canceled or not.
A boolean indicating whether the bubbling of the event has been canceled or not.
MDN
- Definition Classes
- Event
-
def
cancelable: Boolean
A boolean indicating whether the event is cancelable.
A boolean indicating whether the event is cancelable.
MDN
- Definition Classes
- Event
-
def
clientX: Double
The clientX property provides the X coordinate of the mouse pointer in local (DOM content) coordinates.
The clientX property provides the X coordinate of the mouse pointer in local (DOM content) coordinates.
MDN
- Definition Classes
- MouseEvent
-
def
clientY: Double
The clientY property provides the Y coordinate of the mouse pointer in local (DOM content) coordinates.
The clientY property provides the Y coordinate of the mouse pointer in local (DOM content) coordinates.
MDN
- Definition Classes
- MouseEvent
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ctrlKey: Boolean
A Boolean value indicating whether or not the control key was down when the touch event was fired.
A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.
MDN
- Definition Classes
- ModifierKeyEvent
-
def
currentTarget: EventTarget
Identifies the current target for the event, as the event traverses the DOM.
Identifies the current target for the event, as the event traverses the DOM. It always refers to the element the event handler has been attached to as opposed to event.target which identifies the element on which the event occurred.
MDN
- Definition Classes
- Event
-
def
defaultPrevented: Boolean
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
MDN
- Definition Classes
- Event
-
def
detail: Int
Detail about the event, depending on the type of event.
Detail about the event, depending on the type of event. Read only.
MDN
- Definition Classes
- UIEvent
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
eventPhase: Int
Indicates which phase of the event flow is currently being evaluated.
Indicates which phase of the event flow is currently being evaluated.
MDN
- Definition Classes
- Event
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getModifierState(keyArg: String): Boolean
Returns the current state of the specified modifier key.
Returns the current state of the specified modifier key. See the KeyboardEvent.getModifierState() documentation for details.
MDN
- Definition Classes
- MouseEvent
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
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).
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.
MDN
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrimary: Boolean
Indicates if the pointer represents the primary pointer of this pointer type.
Indicates if the pointer represents the primary pointer of this pointer type.
In some scenarios there may be multiple pointers (for example a device with both a touchscreen and a mouse) or a pointer supports multiple contact points (for example a touchscreen that supports multiple finger touches). The application can use the isPrimary property to identify a master pointer among the set of active pointers for each pointer type. If an application only wants to support a primary pointer, it can ignore all pointer events that are not primary.
For mouse there is only one pointer, so it will always be the primary pointer. For touch input, a pointer is considered primary if the user touched the screen when there were no other active touches. For pen and stylus input, a pointer is considered primary if the user's pen initially contacted the screenwhen there were no other active pens contacting the screen.
MDN
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
def
isTrusted: Boolean
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)
MDN
- Definition Classes
- Event
-
def
metaKey: Boolean
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
MDN
- Definition Classes
- ModifierKeyEvent
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
pageX: Double
The pageX property is an integer value in pixels for the X coordinate of the mouse pointer, relative to the whole document, when the mouse event fired.
The pageX property is an integer value in pixels for the X coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any horizontal scrolling of the page.
MDN
- Definition Classes
- MouseEvent
-
def
pageY: Double
The pageY property is an integer value in pixels for the Y coordinate of the mouse pointer, relative to the whole document, when the mouse event fired.
The pageY property is an integer value in pixels for the Y coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any vertical scrolling of the page.
MDN
- Definition Classes
- MouseEvent
-
def
pointerId: Double
An identifier assigned to a pointer event that is unique from the identifiers of all active pointer events at the time.
An identifier assigned to a pointer event that is unique from the identifiers of all active pointer events at the time. Authors cannot assume values convey any particular meaning other than an identifier for the pointer that is unique from all other active pointers.
MDN
-
def
pointerType: String
The pointerType read-only property of the PointerEvent interface indicates the device type that caused the pointer event.
The pointerType read-only property of the PointerEvent interface indicates the device type that caused the pointer event. The supported values are the following strings:
mouse The event was generated by a mouse device.
pen The event was generated by a pen or stylus device.
touch The event was generated by a touch such as a finger. If the device type cannot be detected by the browser, the value can be an empty string (""). If the browser supports pointer device types other than those listed above, the value should be vendor prefixed to avoid conflicting names for different types of devices.
MDN
-
def
pressure: Double
The normalized pressure of the pointer input in the range of 0 to 1, where 0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.
The normalized pressure of the pointer input in the range of 0 to 1, where 0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.
For hardware that does not support pressure, including but not limited to mouse, the value MUST be 0.5 when the pointer is active and 0 otherwise.
MDN
-
def
preventDefault(): Unit
Cancels the event if it is cancelable, without stopping further propagation of the event.
Cancels the event if it is cancelable, without stopping further propagation of the event.
MDN
- Definition Classes
- Event
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
def
relatedTarget: EventTarget
The relatedTarget property is the secondary target for the event, if there is one.
The relatedTarget property is the secondary target for the event, if there is one.
MDN
- Definition Classes
- MouseEvent
-
def
screenX: Double
The screenX property provides the X coordinate of the mouse pointer in global (screen) coordinates.
The screenX property provides the X coordinate of the mouse pointer in global (screen) coordinates.
MDN
- Definition Classes
- MouseEvent
-
def
screenY: Double
The screenY property provides the Y coordinate of the mouse pointer in global (screen) coordinates.
The screenY property provides the Y coordinate of the mouse pointer in global (screen) coordinates.
MDN
- Definition Classes
- MouseEvent
-
def
shiftKey: Boolean
A Boolean value indicating whether or not the shift key was down when the touch event was fired.
A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.
MDN
- Definition Classes
- ModifierKeyEvent
-
def
stopImmediatePropagation(): Unit
For this particular event, no other listener will be called.
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
MDN
- Definition Classes
- Event
-
def
stopPropagation(): Unit
Stops the propagation of events further along in the DOM.
Stops the propagation of events further along in the DOM.
MDN
- Definition Classes
- Event
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
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) in the range -1 to 1, where 0 is the neutral position of the control.
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) in the range -1 to 1, where 0 is the neutral position of the control.
Note that some hardware may only support positive values in the range 0 to 1. For hardware that does not support tangential pressure, the value will be 0.
MDN
-
def
target: EventTarget
This property of event objects is the object the event was dispatched on.
This property of event objects is the object the event was dispatched on. It is different than event.currentTarget when the event handler is called in bubbling or capturing phase of the event.
MDN
- Definition Classes
- Event
-
def
tiltX: Double
This property is the angle (in degrees) between the Y-Z plane of the pointer and the screen.
This property 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. The range of values is -90 to 90 degrees and a positive value means a tilt to the right. For devices that do not support this property, the value is 0.
MDN
-
def
tiltY: Double
This property is the angle (in degrees) between the X-Z plane of the pointer and the screen.
This property 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. The range of values is -90 to 90 degrees and a positive value is a tilt toward the user. For devices that do not support this property, the value is 0.
MDN
-
def
timeStamp: Double
Returns the time (in milliseconds since the epoch) at which the event was created.
Returns the time (in milliseconds since the epoch) at which the event was created.
MDN
- Definition Classes
- Event
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
twist: Double
The twist read-only property of the PointerEvent interface represents the clockwise rotation of the transducer (e.g.
The twist read-only property of the PointerEvent interface represents the clockwise rotation of the transducer (e.g. pen stylus) around its major axis in degrees, with a value in the range 0 to 359.
For devices that do not report twist, the value MUST be 0.
MDN
-
def
type: String
- Definition Classes
- Event
-
def
valueOf(): Any
- Definition Classes
- Object
-
def
view: Window
A view which generated the event.
A view which generated the event. Read only.
MDN
- Definition Classes
- UIEvent
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
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.
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.
MDN