@ralphschuler.webgl shader factory.<internal>.MouseEvent

Interface: MouseEvent

@ralphschuler/webgl-shader-factory.<internal>.MouseEvent

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

Hierarchy

• UIEvent

  ↳ MouseEvent

Table of contents

Properties

• AT_TARGET
• BUBBLING_PHASE
• CAPTURING_PHASE
• NONE
• altKey
• bubbles
• button
• buttons
• cancelBubble
• cancelable
• clientX
• clientY
• composed
• ctrlKey
• currentTarget
• defaultPrevented
• detail
• eventPhase
• isTrusted
• metaKey
• movementX
• movementY
• offsetX
• offsetY
• pageX
• pageY
• relatedTarget
• returnValue
• screenX
• screenY
• shiftKey
• srcElement
• target
• timeStamp
• type
• view
• which
• x
• y

Methods

• composedPath
• getModifierState
• initEvent
• initMouseEvent
• initUIEvent
• preventDefault
• stopImmediatePropagation
• stopPropagation

Properties

AT_TARGET

• Readonly AT_TARGET: 2

Inherited from

UIEvent.AT_TARGET

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8100

---

BUBBLING_PHASE

• Readonly BUBBLING_PHASE: 3

Inherited from

UIEvent.BUBBLING_PHASE

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8101

---

CAPTURING_PHASE

• Readonly CAPTURING_PHASE: 1

Inherited from

UIEvent.CAPTURING_PHASE

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8099

---

NONE

• Readonly NONE: 0

Inherited from

UIEvent.NONE

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8098

---

altKey

• Readonly altKey: boolean

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15589

---

bubbles

• Readonly bubbles: boolean

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.

MDN Reference

Inherited from

UIEvent.bubbles

Defined in

node_modules/typescript/lib/lib.dom.d.ts:7995

---

button

• Readonly button: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15591

---

buttons

• Readonly buttons: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15593

---

cancelBubble

• cancelBubble: boolean

Deprecated

MDN Reference

Inherited from

UIEvent.cancelBubble

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8001

---

cancelable

• Readonly cancelable: boolean

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.

MDN Reference

Inherited from

UIEvent.cancelable

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8007

---

clientX

• Readonly clientX: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15595

---

clientY

• Readonly clientY: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15597

---

composed

• Readonly composed: boolean

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.

MDN Reference

Inherited from

UIEvent.composed

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8013

---

ctrlKey

• Readonly ctrlKey: boolean

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15599

---

currentTarget

• Readonly currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

Inherited from

UIEvent.currentTarget

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8019

---

defaultPrevented

• Readonly defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

Inherited from

UIEvent.defaultPrevented

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8025

---

detail

• Readonly detail: number

MDN Reference

Inherited from

UIEvent.detail

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22505

---

eventPhase

• Readonly eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

Inherited from

UIEvent.eventPhase

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8031

---

isTrusted

• Readonly isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Inherited from

UIEvent.isTrusted

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8037

---

metaKey

• Readonly metaKey: boolean

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15601

---

movementX

• Readonly movementX: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15603

---

movementY

• Readonly movementY: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15605

---

offsetX

• Readonly offsetX: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15607

---

offsetY

• Readonly offsetY: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15609

---

pageX

• Readonly pageX: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15611

---

pageY

• Readonly pageY: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15613

---

relatedTarget

• Readonly relatedTarget: null | EventTarget

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15615

---

returnValue

• returnValue: boolean

Deprecated

MDN Reference

Inherited from

UIEvent.returnValue

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8043

---

screenX

• Readonly screenX: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15617

---

screenY

• Readonly screenY: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15619

---

shiftKey

• Readonly shiftKey: boolean

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15621

---

srcElement

• Readonly srcElement: null | EventTarget

Deprecated

MDN Reference

Inherited from

UIEvent.srcElement

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8049

---

target

• Readonly target: null | EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

Inherited from

UIEvent.target

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8055

---

timeStamp

• Readonly timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Inherited from

UIEvent.timeStamp

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8061

---

type

• Readonly type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

Inherited from

UIEvent.type

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8067

---

view

• Readonly view: null | Window

MDN Reference

Inherited from

UIEvent.view

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22507

---

which

• Readonly which: number

Deprecated

MDN Reference

Inherited from

UIEvent.which

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22513

---

x

• Readonly x: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15623

---

y

• Readonly y: number

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15625

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.

MDN Reference

Returns

EventTarget[]

Inherited from

UIEvent.composedPath

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8073

---

getModifierState

▸ getModifierState(keyArg): boolean

MDN Reference

Parameters

Name	Type
keyArg	string

Returns

boolean

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15627

---

initEvent

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

Parameters

Name	Type
type	string
bubbles?	boolean
cancelable?	boolean

Returns

void

Deprecated

MDN Reference

Inherited from

UIEvent.initEvent

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8079

---

initMouseEvent

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

Parameters

Name	Type
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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:15633

---

initUIEvent

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

Parameters

Name	Type
typeArg	string
bubblesArg?	boolean
cancelableArg?	boolean
viewArg?	null | Window
detailArg?	number

Returns

void

Deprecated

MDN Reference

Inherited from

UIEvent.initUIEvent

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22519

---

preventDefault

▸ preventDefault(): void

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns

void

Inherited from

UIEvent.preventDefault

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8085

---

stopImmediatePropagation

▸ stopImmediatePropagation(): void

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

Returns

void

Inherited from

UIEvent.stopImmediatePropagation

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8091

---

stopPropagation

▸ stopPropagation(): void

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

MDN Reference

Returns

void

Inherited from

UIEvent.stopPropagation

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8097