Interface MouseEventExt

interface MouseEventExt {
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    CAPTURING_PHASE: 1;
    NONE: 0;
    altKey: boolean;
    bubbles: boolean;
    button: number;
    buttons: number;
    cancelBubble: boolean;
    cancelable: boolean;
    canvasX: number;
    canvasY: number;
    click_time?: number;
    clientX: number;
    clientY: number;
    composed: boolean;
    ctrlKey: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    delta?: number;
    deltaX?: number;
    deltaY?: number;
    detail: number;
    dragging: boolean;
    eventPhase: number;
    eventType?: string;
    isTrusted: boolean;
    layerX: number;
    layerY: number;
    metaKey: boolean;
    movementX: number;
    movementY: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    relatedTarget: null | EventTarget;
    returnValue: boolean;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    view: null | Window;
    wheel?: number;
    wheelDelta?: number;
    wheelDeltaY?: number;
    which: number;
    x: number;
    y: number;
    composedPath(): EventTarget[];
    getModifierState(keyArg): boolean;
    initEvent(type, bubbles?, cancelable?): void;
    initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void;
    initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE altKey bubbles button buttons cancelBubble cancelable canvasX canvasY click_time? clientX clientY composed ctrlKey currentTarget defaultPrevented delta? deltaX? deltaY? detail dragging eventPhase eventType? isTrusted layerX layerY metaKey movementX movementY offsetX offsetY pageX pageY relatedTarget returnValue screenX screenY shiftKey srcElement target timeStamp type view wheel? wheelDelta? wheelDeltaY? which x y

Methods

composedPath getModifierState initEvent initMouseEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

Properties

Readonly AT_TARGET

AT_TARGET: 2

Readonly BUBBLING_PHASE

BUBBLING_PHASE: 3

Readonly CAPTURING_PHASE

CAPTURING_PHASE: 1

Readonly NONE

NONE: 0

Readonly altKey

altKey: boolean

The MouseEvent.altKey read-only property is a boolean value that indicates whether the alt key was pressed or not when a given mouse event occurs.

MDN Reference

Readonly bubbles

bubbles: boolean

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

Readonly button

button: number

The MouseEvent.button read-only property indicates which button was pressed or released on the mouse to trigger the event.

MDN Reference

Readonly buttons

buttons: number

The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.

MDN Reference

cancelBubble

cancelBubble: boolean

The cancelBubble property of the Event interface is deprecated.

Deprecated

MDN Reference

Readonly cancelable

cancelable: boolean

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

canvasX

canvasX: number

canvasY

canvasY: number

Optional click_time

click_time?: number

Readonly clientX

clientX: number

The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

Readonly clientY

clientY: number

The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

Readonly composed

composed: boolean

The read-only composed property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

Readonly ctrlKey

ctrlKey: boolean

The MouseEvent.ctrlKey read-only property is a boolean value that indicates whether the ctrl key was pressed or not when a given mouse event occurs.

MDN Reference

Readonly currentTarget

currentTarget: null | EventTarget

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

Readonly defaultPrevented

defaultPrevented: boolean

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

Optional delta

delta?: number

Optional deltaX

deltaX?: number

Optional deltaY

deltaY?: number

Readonly detail

detail: number

The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.

MDN Reference

dragging

dragging: boolean

Readonly eventPhase

eventPhase: number

The eventPhase read-only property of the being evaluated.

MDN Reference

Optional eventType

eventType?: string

Readonly isTrusted

isTrusted: boolean

The isTrusted read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

Readonly layerX

layerX: number

The MouseEvent.layerX read-only property returns the horizontal coordinate of the event relative to the current layer.

MDN Reference

Readonly layerY

layerY: number

The MouseEvent.layerY read-only property returns the vertical coordinate of the event relative to the current layer.

MDN Reference

Readonly metaKey

metaKey: boolean

The MouseEvent.metaKey read-only property is a boolean value that indicates whether the meta key was pressed or not when a given mouse event occurs.

MDN Reference

Readonly movementX

movementX: number

The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous Element/mousemove_event event.

MDN Reference

Readonly movementY

movementY: number

The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous Element/mousemove_event event.

MDN Reference

Readonly offsetX

offsetX: number

The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

Readonly offsetY

offsetY: number

The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

Readonly pageX

pageX: number

The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document.

MDN Reference

Readonly pageY

pageY: number

The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate (in pixels) at which the mouse was clicked, relative to the top edge of the entire document.

MDN Reference

Readonly relatedTarget

relatedTarget: null | EventTarget

The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.

MDN Reference

returnValue

returnValue: boolean

The Event property returnValue indicates whether the default action for this event has been prevented or not.

Deprecated

MDN Reference

Readonly screenX

screenX: number

The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

Readonly screenY

screenY: number

The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

Readonly shiftKey

shiftKey: boolean

The MouseEvent.shiftKey read-only property is a boolean value that indicates whether the shift key was pressed or not when a given mouse event occurs.

MDN Reference

Readonly srcElement

srcElement: null | EventTarget

The deprecated Event.srcElement is an alias for the Event.target property.

Deprecated

MDN Reference

Readonly target

target: null | EventTarget

The read-only target property of the dispatched.

MDN Reference

Readonly timeStamp

timeStamp: number

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

Readonly type

type: string

The type read-only property of the Event interface returns a string containing the event's type.

MDN Reference

Readonly view

view: null | Window

The UIEvent.view read-only property returns the is the Window object the event happened in.

MDN Reference

Optional wheel

wheel?: number

Optional wheelDelta

wheelDelta?: number

Optional wheelDeltaY

wheelDeltaY?: number

Readonly which

which: number

The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.

Deprecated

MDN Reference

Readonly x

x: number

The MouseEvent.x property is an alias for the MouseEvent.clientX property.

MDN Reference

Readonly y

y: number

The MouseEvent.y property is an alias for the MouseEvent.clientY property.

MDN Reference

Methods

composedPath

  • composedPath(): EventTarget[]

  • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

    MDN Reference

    Returns EventTarget[]

getModifierState

  • getModifierState(keyArg): boolean

  • The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.

    MDN Reference

    Parameters

    • keyArg: string

    Returns boolean

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

    Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

    Deprecated

    MDN Reference

initMouseEvent

  • initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void

  • The MouseEvent.initMouseEvent() method initializes the value of a mouse event once it's been created (normally using the Document.createEvent() method).

    Parameters

    • typeArg: string
    • canBubbleArg: boolean
    • cancelableArg: boolean
    • viewArg: Window
    • detailArg: number
    • screenXArg: number
    • screenYArg: number
    • clientXArg: number
    • clientYArg: number
    • ctrlKeyArg: boolean
    • altKeyArg: boolean
    • shiftKeyArg: boolean
    • metaKeyArg: boolean
    • buttonArg: number
    • relatedTargetArg: null | EventTarget

    Returns void

    Deprecated

    MDN Reference

initUIEvent

  • initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

  • The UIEvent.initUIEvent() method initializes a UI event once it's been created.

    Parameters

    • typeArg: string
    • Optional bubblesArg: boolean
    • Optional cancelableArg: boolean
    • Optional viewArg: null | Window
    • Optional detailArg: number

    Returns void

    Deprecated

    MDN Reference

preventDefault

  • preventDefault(): void

  • The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

    MDN Reference

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

    MDN Reference

    Returns void

stopPropagation

  • stopPropagation(): void

  • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

    MDN Reference

    Returns void

Settings

Member Visibility

Theme

On This Page

AT_TARGETBUBBLING_PHASECAPTURING_PHASENONEaltKeybubblesbuttonbuttonscancelBubblecancelablecanvasXcanvasYclick_timeclientXclientYcomposedctrlKeycurrentTargetdefaultPreventeddeltadeltaXdeltaYdetaildraggingeventPhaseeventTypeisTrustedlayerXlayerYmetaKeymovementXmovementYoffsetXoffsetYpageXpageYrelatedTargetreturnValuescreenXscreenYshiftKeysrcElementtargettimeStamptypeviewwheelwheelDeltawheelDeltaYwhichxycomposedPathgetModifierStateinitEventinitMouseEventinitUIEventpreventDefaultstopImmediatePropagationstopPropagation