PointerEvent.PointerEvent()

The PointerEvent() constructor creates a new synthetic and untrusted PointerEvent object instance.

Syntax

 event = new PointerEvent(type, PointerEventInit);

Arguments

type

Is a DOMString representing the name of the event (see PointerEvent event types).

PointerEventInitOptional

Is a PointerEventInit dictionary, having the following fields:

• pointerId — optional and defaulting to 0, of type long, that sets the value of the instance's PointerEvent.pointerId.
• width — optional and defaulting to 1, of type double, that sets the value of the instance's PointerEvent.width.
• height — optional and defaulting to 1, of type double, that sets the value of the instance's PointerEvent.height.
• pressure — optional and defaulting to 0, of type float, that sets the value of the instance's PointerEvent.pressure.
• tangentialPressure — optional and defaulting to 0, of type float, that sets the value of the instance's PointerEvent.tangentialPressure.
• tiltX — optional and defaulting to 0, of type long, that sets the value of the instance's PointerEvent.tiltX.
• tiltY — optional and defaulting to 0, of type long, that sets the value of the instance's PointerEvent.tiltY.
• twist — optional and defaulting to 0, of type long, that sets the value of the instance's PointerEvent.twist.
• pointerType — optional and defaulting to "", of type DOMString, that sets the value of the instance's PointerEvent.pointerType.
• isPrimary — optional and defaulting to false, of type Boolean, that sets the value of the instance's PointerEvent.isPrimary.

Note: The PointerEventInit dictionary also accepts fields from the MouseEvent, UIEventInit and EventInit dictionaries.

Example

var moveEvent = new PointerEvent("pointermove");
var downEvent = new PointerEvent("pointerdown",
   {pointerId: 1,
    bubbles: true,
    cancelable: true,
    pointerType: "touch",
    width: 100,
    height: 100,
    isPrimary: true
   });

Specifications

Browser compatibility

[1] This feature is currently hidden behind a flag — to enable it and experiment, go to about:config and enable dom.w3c_pointer_events.enabled.

[2] tangentialPressure and twist were implemented in Firefox 54.