Interface MouseEvent
altKey: boolean;
AT_TARGET: 2;
bubbles: boolean;
BUBBLING_PHASE: 3;
button: number;
buttons: number;
cancelable: boolean;
cancelBubble: boolean;
CAPTURING_PHASE: 1;
clientX: number;
clientY: number;
composed: boolean;
ctrlKey: boolean;
currentTarget: EventTarget;
defaultPrevented: boolean;
detail: number;
eventPhase: number;
isTrusted: boolean;
layerX: number;
layerY: number;
metaKey: boolean;
movementX: number;
movementY: number;
NONE: 0;
offsetX: number;
offsetY: number;
pageX: number;
pageY: number;
relatedTarget: EventTarget;
returnValue: boolean;
screenX: number;
screenY: number;
shiftKey: boolean;
srcElement: EventTarget;
target: EventTarget;
timeStamp: number;
type: string;
view: Window;
which: number;
x: number;
y: number;
composedPath(): EventTarget[];
getModifierState(keyArg: string): boolean;
initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
initMouseEvent(
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: EventTarget,
): void;
initUIEvent(
typeArg: string,
bubblesArg?: boolean,
cancelableArg?: boolean,
viewArg?: Window,
detailArg?: number,
): void;
preventDefault(): void;
stopImmediatePropagation(): void;
stopPropagation(): void;
}
Hierarchy
- UIEvent
- MouseEvent (View Summary)
Index
Properties
Methods
Properties
ReadonlyaltKey
ReadonlyAT_TARGET
Readonlybubbles
Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
ReadonlyBUBBLING_PHASE
Readonlybutton
Readonlybuttons
Readonlycancelable
Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
cancelBubble
ReadonlyCAPTURING_PHASE
ReadonlyclientX
ReadonlyclientY
Readonlycomposed
Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
ReadonlyctrlKey
ReadonlycurrentTarget
Returns the object whose event listener's callback is currently being invoked.
ReadonlydefaultPrevented
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
Readonlydetail
ReadonlyeventPhase
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
ReadonlyisTrusted
Returns true if event was dispatched by the user agent, and false otherwise.
ReadonlylayerX
ReadonlylayerY
ReadonlymetaKey
ReadonlymovementX
ReadonlymovementY
ReadonlyNONE
ReadonlyoffsetX
ReadonlyoffsetY
ReadonlypageX
ReadonlypageY
ReadonlyrelatedTarget
returnValue
ReadonlyscreenX
ReadonlyscreenY
ReadonlyshiftKey
ReadonlysrcElement
Readonlytarget
Returns the object to which event is dispatched (its target).
ReadonlytimeStamp
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
Readonlytype
Returns the type of event, e.g. "click", "hashchange", or "submit".
Readonlyview
Readonlywhich
Readonlyx
Readonlyy
Methods
composedPath
- composedPath(): EventTarget[]
Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
Returns EventTarget[]
getModifierState
initEvent
initMouseEvent
- initMouseEvent(
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: EventTarget,
): void 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: EventTarget
Returns void
Events that occur due to the user interacting with a pointing device (such as a mouse). Common events using this interface include click, dblclick, mouseup, mousedown.
MDN Reference