Interface NativeMouseEvent

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

interface NativeMouseEvent {
    altKey: boolean;
    button: number;
    buttons: number;
    clientX: number;
    clientY: number;
    ctrlKey: boolean;
    detail: number;
    metaKey: boolean;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    relatedTarget: null | number | Component<unknown, {}, any> & Readonly<NativeMethods>;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    x: number;
    y: number;
}

Hierarchy (view full)

Properties

altKey button buttons clientX clientY ctrlKey detail metaKey offsetX offsetY pageX pageY relatedTarget screenX screenY shiftKey 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 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 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 x

x: number

Alias for NativeMouseEvent.clientX

Readonly y

y: number

Alias for NativeMouseEvent.clientY

On This Page