### Hierarchy

- MouseEvent
  - PointerEvent

## Index

### Properties

- AT_TARGET
- BUBBLING_PHASE
- CAPTURING_PHASE
- MouseEvent
- NONE
- altKey
- bubbles
- button
- buttons
- cancelBubble
- cancelable
- clientX
- clientY
- composed
- ctrlKey
- currentTarget
- defaultPrevented
- detail
- eventPhase
- fromElement
- height
- isPrimary
- isTrusted
- layerX
- layerY
- metaKey
- movementX
- movementY
- offsetX
- offsetY
- pageX
- pageY
- pointerId
- pointerType
- pressure
- relatedTarget
- returnValue
- screenX
- screenY
- shiftKey
- srcElement
- tangentialPressure
- target
- tiltX
- tiltY
- timeStamp
- toElement
- twist
- type
- view
- which
- width
- x
- y

### Methods

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

## Properties

### AT_TARGET

AT_TARGET: number

Inherited from Event.AT_TARGET

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5017

### BUBBLING_PHASE

BUBBLING_PHASE: number

Inherited from Event.BUBBLING_PHASE

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5018

### CAPTURING_PHASE

CAPTURING_PHASE: number

Inherited from Event.CAPTURING_PHASE

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5019

### MouseEvent

MouseEvent: object

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10160

#### Type declaration

- ##### constructor: function

  - new __type(typeArg: string, eventInitDict?: MouseEventInit): MouseEvent
  - - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10161

    #### Parameters

    - ##### typeArg: string

    - ##### Optional eventInitDict: MouseEventInit

    #### Returns MouseEvent

- ##### prototype: MouseEvent

### NONE

NONE: number

Inherited from Event.NONE

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5020

### altKey

altKey: boolean

Inherited from MouseEvent.altKey

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10129

### bubbles

bubbles: boolean

Inherited from Event.bubbles

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4967

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.

### button

button: number

Inherited from MouseEvent.button

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10130

### buttons

buttons: number

Inherited from MouseEvent.buttons

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10131

### cancelBubble

cancelBubble: boolean

Inherited from Event.cancelBubble

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4968

### cancelable

cancelable: boolean

Inherited from Event.cancelable

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4969

### clientX

clientX: number

Inherited from MouseEvent.clientX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10132

### clientY

clientY: number

Inherited from MouseEvent.clientY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10133

### composed

composed: boolean

Inherited from Event.composed

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4973

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.

### ctrlKey

ctrlKey: boolean

Inherited from MouseEvent.ctrlKey

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10134

### currentTarget

currentTarget: EventTarget | null

Inherited from Event.currentTarget

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4978

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

### defaultPrevented

defaultPrevented: boolean

Inherited from Event.defaultPrevented

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4979

### detail

detail: number

Inherited from UIEvent.detail

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:15055

### eventPhase

eventPhase: number

Inherited from Event.eventPhase

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4980

### fromElement

fromElement: Element

Inherited from MouseEvent.fromElement

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10136

deprecated

### height

height: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11188

### isPrimary

isPrimary: boolean

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11189

### isTrusted

isTrusted: boolean

Inherited from Event.isTrusted

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4985

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

### layerX

layerX: number

Inherited from MouseEvent.layerX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10137

### layerY

layerY: number

Inherited from MouseEvent.layerY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10138

### metaKey

metaKey: boolean

Inherited from MouseEvent.metaKey

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10139

### movementX

movementX: number

Inherited from MouseEvent.movementX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10140

### movementY

movementY: number

Inherited from MouseEvent.movementY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10141

### offsetX

offsetX: number

Inherited from MouseEvent.offsetX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10142

### offsetY

offsetY: number

Inherited from MouseEvent.offsetY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10143

### pageX

pageX: number

Inherited from MouseEvent.pageX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10144

### pageY

pageY: number

Inherited from MouseEvent.pageY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10145

### pointerId

pointerId: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11190

### pointerType

pointerType: string

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11191

### pressure

pressure: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11192

### relatedTarget

relatedTarget: EventTarget

Inherited from MouseEvent.relatedTarget

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10146

### returnValue

returnValue: boolean

Inherited from Event.returnValue

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4986

### screenX

screenX: number

Inherited from MouseEvent.screenX

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10147

### screenY

screenY: number

Inherited from MouseEvent.screenY

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10148

### shiftKey

shiftKey: boolean

Inherited from MouseEvent.shiftKey

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10149

### srcElement

srcElement: Element | null

Inherited from Event.srcElement

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4988

deprecated

### tangentialPressure

tangentialPressure: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11193

### target

target: EventTarget | null

Inherited from Event.target

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4992

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

### tiltX

tiltX: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11194

### tiltY

tiltY: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11195

### timeStamp

timeStamp: number

Inherited from Event.timeStamp

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:4997

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

### toElement

toElement: Element

Inherited from MouseEvent.toElement

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10151

deprecated

### twist

twist: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11196

### type

type: string

Inherited from Event.type

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5003

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

### view

view: Window

Inherited from UIEvent.view

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:15056

### which

which: number

Inherited from MouseEvent.which

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10153

deprecated

### width

width: number

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11197

### x

x: number

Inherited from MouseEvent.x

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10154

### y

y: number

Inherited from MouseEvent.y

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10155

## Methods

### composedPath

- composedPath(): EventTarget[]

- Inherited from Event.composedPath

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5004

  #### Returns EventTarget[]

### getModifierState

- getModifierState(keyArg: string): boolean

- Inherited from MouseEvent.getModifierState

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10156

  #### Parameters

  - ##### keyArg: string

  #### Returns boolean

### initEvent

- initEvent(type: string, bubbles?: undefined | false | true, cancelable?: undefined | false | true): void

- Inherited from Event.initEvent

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5005

  #### Parameters

  - ##### type: string

  - ##### Optional bubbles: undefined | false | true

  - ##### Optional cancelable: undefined | false | true

  #### Returns void

### 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 | null): void

- Inherited from MouseEvent.initMouseEvent

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:10157

  #### 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 | null

  #### Returns void

### initUIEvent

- initUIEvent(typeArg: string, canBubbleArg: boolean, cancelableArg: boolean, viewArg: Window, detailArg: number): void

- Inherited from UIEvent.initUIEvent

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:15057

  #### Parameters

  - ##### typeArg: string

  - ##### canBubbleArg: boolean

  - ##### cancelableArg: boolean

  - ##### viewArg: Window

  - ##### detailArg: number

  #### Returns void

### preventDefault

- preventDefault(): void

- Inherited from Event.preventDefault

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5006

  #### Returns void

### stopImmediatePropagation

- stopImmediatePropagation(): void

- Inherited from Event.stopImmediatePropagation

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5012

  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.

  #### Returns void

### stopPropagation

- stopPropagation(): void

- Inherited from Event.stopPropagation

  - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5016

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

  #### Returns void

Generated using TypeDoc