Interface NativePointerEvent

https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent

interface NativePointerEvent {
    altKey: boolean;
    button: number;
    buttons: number;
    clientX: number;
    clientY: number;
    ctrlKey: boolean;
    detail: number;
    height: number;
    isPrimary: boolean;
    metaKey: boolean;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    pointerId: number;
    pointerType: string;
    pressure: number;
    relatedTarget: null | number | Component<unknown, {}, any> & Readonly<NativeMethods>;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    tangentialPressure: number;
    tiltX: number;
    tiltY: number;
    twist: number;
    width: number;
    x: number;
    y: number;
}

Hierarchy (view full)

Properties

altKey button buttons clientX clientY ctrlKey detail height isPrimary metaKey offsetX offsetY pageX pageY pointerId pointerType pressure relatedTarget screenX screenY shiftKey tangentialPressure tiltX tiltY twist width x y

Properties

Readonly altKey

altKey: boolean

Returns true if the alt key was down when the mouse event was fired.

Readonly button

button: number

The button number that was pressed (if applicable) when the mouse event was fired.

Readonly buttons

buttons: number

The buttons being depressed (if any) when the mouse event was fired.

Readonly clientX

clientX: number

The X coordinate of the mouse pointer in local (DOM content) coordinates.

Readonly clientY

clientY: number

The Y coordinate of the mouse pointer in local (DOM content) coordinates.

Readonly ctrlKey

ctrlKey: boolean

Returns true if the control key was down when the mouse event was fired.

Readonly detail

detail: number

Returns a long with details about the event, depending on the event type.

Readonly height

height: number

The height (magnitude on the Y axis), in CSS pixels, of the contact geometry of the pointer.

Readonly isPrimary

isPrimary: boolean

Indicates if the pointer represents the primary pointer of this pointer type.

Readonly metaKey

metaKey: boolean

Returns true if the meta key was down when the mouse event was fired.

Readonly offsetX

offsetX: number

The X coordinate of the mouse pointer between that event and the padding edge of the target node

Readonly offsetY

offsetY: number

The Y coordinate of the mouse pointer between that event and the padding edge of the target node

Readonly pageX

pageX: number

The X coordinate of the mouse pointer relative to the whole document.

Readonly pageY

pageY: number

The Y coordinate of the mouse pointer relative to the whole document.

Readonly pointerId

pointerId: number

A unique identifier for the pointer causing the event.

Readonly pointerType

pointerType: string

Indicates the device type that caused the event (mouse, pen, touch, etc.)

Readonly pressure

pressure: number

The normalized pressure of the pointer input in the range 0 to 1, where 0 and 1 represent the minimum and maximum pressure the hardware is capable of detecting, respectively.

Readonly relatedTarget

relatedTarget: null | number | Component<unknown, {}, any> & Readonly<NativeMethods>

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

Readonly screenX

screenX: number

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

Readonly screenY

screenY: number

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

Readonly shiftKey

shiftKey: boolean

Returns true if the shift key was down when the mouse event was fired.

Readonly tangentialPressure

tangentialPressure: number

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.

Readonly tiltX

tiltX: number

The plane angle (in degrees, in the range of -90 to 90) between the Y–Z plane and the plane containing both the pointer (e.g. pen stylus) axis and the Y axis.

Readonly tiltY

tiltY: number

The plane angle (in degrees, in the range of -90 to 90) between the X–Z plane and the plane containing both the pointer (e.g. pen stylus) axis and the X axis.

Readonly twist

twist: number

The clockwise rotation of the pointer (e.g. pen stylus) around its major axis in degrees, with a value in the range 0 to 359.

Readonly width

width: number

The width (magnitude on the X axis), in CSS pixels, of the contact geometry of the pointer

Readonly x

x: number

Alias for NativeMouseEvent.clientX

Readonly y

y: number

Alias for NativeMouseEvent.clientY

On This Page