Class

org.scalajs.dom.raw

PointerEvent

Related Doc: package raw

Permalink

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
@RawJSType() @native() @JSGlobal()
Linear Supertypes
MouseEvent, ModifierKeyEvent, UIEvent, Event, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PointerEvent
  2. MouseEvent
  3. ModifierKeyEvent
  4. UIEvent
  5. Event
  6. Object
  7. Any
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PointerEvent(typeArg: String)

    Permalink
  2. new PointerEvent(typeArg: String, pointerEventInit: PointerEventInit)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def altKey: Boolean

    Permalink

    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
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def bubbles: Boolean

    Permalink

    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
  7. def button: Int

    Permalink

    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
  8. def buttons: Int

    Permalink

    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
  9. def cancelBubble: Boolean

    Permalink

    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
  10. def cancelable: Boolean

    Permalink

    A boolean indicating whether the event is cancelable.

    A boolean indicating whether the event is cancelable.

    MDN

    Definition Classes
    Event
  11. def clientX: Double

    Permalink

    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
  12. def clientY: Double

    Permalink

    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
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def ctrlKey: Boolean

    Permalink

    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
  15. def currentTarget: EventTarget

    Permalink

    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
  16. def defaultPrevented: Boolean

    Permalink

    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
  17. def detail: Int

    Permalink

    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
  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  20. def eventPhase: Int

    Permalink

    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
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def getModifierState(keyArg: String): Boolean

    Permalink

    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
  24. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. def height: Double

    Permalink

    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

  27. def initUIEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, detailArg: Int): Unit

    Permalink
    Definition Classes
    UIEvent
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def isPrimary: Boolean

    Permalink

    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

  30. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  31. def isTrusted: Boolean

    Permalink

    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
  32. def metaKey: Boolean

    Permalink

    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
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. def pageX: Double

    Permalink

    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
  37. def pageY: Double

    Permalink

    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
  38. def pointerId: Double

    Permalink

    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

  39. def pointerType: String

    Permalink

    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

  40. def pressure: Double

    Permalink

    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

  41. def preventDefault(): Unit

    Permalink

    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
  42. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  43. def relatedTarget: EventTarget

    Permalink

    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
  44. def screenX: Double

    Permalink

    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
  45. def screenY: Double

    Permalink

    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
  46. def shiftKey: Boolean

    Permalink

    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
  47. def stopImmediatePropagation(): Unit

    Permalink

    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
  48. def stopPropagation(): Unit

    Permalink

    Stops the propagation of events further along in the DOM.

    Stops the propagation of events further along in the DOM.

    MDN

    Definition Classes
    Event
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  50. def tangentialPressure: Double

    Permalink

    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

  51. def target: EventTarget

    Permalink

    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
  52. def tiltX: Double

    Permalink

    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

  53. def tiltY: Double

    Permalink

    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

  54. def timeStamp: Double

    Permalink

    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
  55. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  56. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  57. def twist: Double

    Permalink

    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

  58. def type: String

    Permalink
    Definition Classes
    Event
  59. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  60. def view: Window

    Permalink

    A view which generated the event.

    A view which generated the event. Read only.

    MDN

    Definition Classes
    UIEvent
  61. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. def width: Double

    Permalink

    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

Deprecated Value Members

  1. def initEvent(eventTypeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean): Unit

    Permalink

    The initEvent method is used to initialize the value of an event created using document.createEvent.

    The initEvent method is used to initialize the value of an event created using document.createEvent.

    MDN

    Definition Classes
    Event
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Non-standard

  2. def initMouseEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, detailArg: Int, screenXArg: Int, screenYArg: Int, clientXArg: Int, clientYArg: Int, ctrlKeyArg: Boolean, altKeyArg: Boolean, shiftKeyArg: Boolean, metaKeyArg: Boolean, buttonArg: Int, relatedTargetArg: EventTarget): Unit

    Permalink
    Definition Classes
    MouseEvent
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Non-standard

  3. def srcElement: Element

    Permalink
    Definition Classes
    Event
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Non standard.

Inherited from MouseEvent

Inherited from ModifierKeyEvent

Inherited from UIEvent

Inherited from Event

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped