PointerEvent

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.

A boolean indicating whether the event bubbles up through the DOM or not.

The button property indicates which button was pressed on the mouse to trigger the event.

The buttons property indicates which buttons were pressed on the mouse to trigger the event.

A boolean indicating whether the bubbling of the event has been canceled or not.

A boolean indicating whether the event is cancelable.

The clientX property provides the X 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.

Indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.

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.

Returns a boolean indicating whether or not event.preventDefault() was called on the event.

Detail about the event, depending on the type of event. Read only.

Indicates which phase of the event flow is currently being evaluated.

Returns the current state of the specified modifier key. See the KeyboardEvent.getModifierState() documentation for details.

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)

The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.

Provides the difference in the X coordinate of the mouse pointer between the given event and the previous mousemove event

Provides the difference in the Y coordinate of the mouse pointer between the given event and the previous mousemove event

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.

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.

Cancels the event if it is cancelable, without stopping further propagation of the event.

The relatedTarget property is the secondary target for the event, if there is one.

The screenX property provides the X coordinate of the mouse pointer in global (screen) coordinates.

The screenY property provides the Y coordinate of the mouse pointer in global (screen) coordinates.

A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.

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)

Stops the propagation of events further along in the DOM.

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.

Returns the time (in milliseconds since the epoch) at which the event was created.

A view which generated the event. Read only.