---
title: "MouseEventInit | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface MouseEventInit

interface MouseEventInit {  
    [altKey](#altkey)?: boolean;  
    [bubbles](#bubbles)?: boolean;  
    [button](#button)?: number;  
    [buttons](#buttons)?: number;  
    [cancelable](#cancelable)?: boolean;  
    [clientX](#clientx)?: number;  
    [clientY](#clienty)?: number;  
    [composed](#composed)?: boolean;  
    [ctrlKey](#ctrlkey)?: boolean;  
    [detail](#detail)?: number;  
    [metaKey](#metakey)?: boolean;  
    [modifierAltGraph](#modifieraltgraph)?: boolean;  
    [modifierCapsLock](#modifiercapslock)?: boolean;  
    [modifierFn](#modifierfn)?: boolean;  
    [modifierFnLock](#modifierfnlock)?: boolean;  
    [modifierHyper](#modifierhyper)?: boolean;  
    [modifierNumLock](#modifiernumlock)?: boolean;  
    [modifierScrollLock](#modifierscrolllock)?: boolean;  
    [modifierSuper](#modifiersuper)?: boolean;  
    [modifierSymbol](#modifiersymbol)?: boolean;  
    [modifierSymbolLock](#modifiersymbollock)?: boolean;  
    [movementX](#movementx)?: number;  
    [movementY](#movementy)?: number;  
    [relatedTarget](#relatedtarget)?: EventTarget | null;  
    [screenX](#screenx)?: number;  
    [screenY](#screeny)?: number;  
    [shiftKey](#shiftkey)?: boolean;  
    [view](#view)?: [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null;  
    [which](#which)?: number;  
}

#### Hierarchy ([View Summary](https://docs.maptiler.com/sdk-js/api-reference/hierarchy/#Externals.MouseEventInit))

-   [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/)
    -   MouseEventInit
        -   [WheelEventInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.WheelEventInit/)
        -   [PointerEventInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.PointerEventInit/)
        -   [DragEventInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.DragEventInit/)

##### Index

### Properties[](#properties)

[altKey?](#altkey) [bubbles?](#bubbles) [button?](#button) [buttons?](#buttons) [cancelable?](#cancelable) [clientX?](#clientx) [clientY?](#clienty) [composed?](#composed) [ctrlKey?](#ctrlkey) [detail?](#detail) [metaKey?](#metakey) [modifierAltGraph?](#modifieraltgraph) [modifierCapsLock?](#modifiercapslock) [modifierFn?](#modifierfn) [modifierFnLock?](#modifierfnlock) [modifierHyper?](#modifierhyper) [modifierNumLock?](#modifiernumlock) [modifierScrollLock?](#modifierscrolllock) [modifierSuper?](#modifiersuper) [modifierSymbol?](#modifiersymbol) [modifierSymbolLock?](#modifiersymbollock) [movementX?](#movementx) [movementY?](#movementy) [relatedTarget?](#relatedtarget) [screenX?](#screenx) [screenY?](#screeny) [shiftKey?](#shiftkey) [view?](#view) [which?](#which)

## Properties[](#properties-1)

### `Optional`altKey[](#altkey)

altKey?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[altKey](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#altkey)

### `Optional`bubbles[](#bubbles)

bubbles?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[bubbles](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#bubbles)

### `Optional`button[](#button)

button?: number

### `Optional`buttons[](#buttons)

buttons?: number

### `Optional`cancelable[](#cancelable)

cancelable?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[cancelable](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#cancelable)

### `Optional`clientX[](#clientx)

clientX?: number

### `Optional`clientY[](#clienty)

clientY?: number

### `Optional`composed[](#composed)

composed?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[composed](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#composed)

### `Optional`ctrlKey[](#ctrlkey)

ctrlKey?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[ctrlKey](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#ctrlkey)

### `Optional`detail[](#detail)

detail?: number

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[detail](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#detail)

### `Optional`metaKey[](#metakey)

metaKey?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[metaKey](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#metakey)

### `Optional`modifierAltGraph[](#modifieraltgraph)

modifierAltGraph?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierAltGraph](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifieraltgraph)

### `Optional`modifierCapsLock[](#modifiercapslock)

modifierCapsLock?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierCapsLock](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifiercapslock)

### `Optional`modifierFn[](#modifierfn)

modifierFn?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierFn](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifierfn)

### `Optional`modifierFnLock[](#modifierfnlock)

modifierFnLock?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierFnLock](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifierfnlock)

### `Optional`modifierHyper[](#modifierhyper)

modifierHyper?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierHyper](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifierhyper)

### `Optional`modifierNumLock[](#modifiernumlock)

modifierNumLock?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierNumLock](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifiernumlock)

### `Optional`modifierScrollLock[](#modifierscrolllock)

modifierScrollLock?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierScrollLock](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifierscrolllock)

### `Optional`modifierSuper[](#modifiersuper)

modifierSuper?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierSuper](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifiersuper)

### `Optional`modifierSymbol[](#modifiersymbol)

modifierSymbol?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierSymbol](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifiersymbol)

### `Optional`modifierSymbolLock[](#modifiersymbollock)

modifierSymbolLock?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[modifierSymbolLock](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#modifiersymbollock)

### `Optional`movementX[](#movementx)

movementX?: number

### `Optional`movementY[](#movementy)

movementY?: number

### `Optional`relatedTarget[](#relatedtarget)

relatedTarget?: EventTarget | null

### `Optional`screenX[](#screenx)

screenX?: number

### `Optional`screenY[](#screeny)

screenY?: number

### `Optional`shiftKey[](#shiftkey)

shiftKey?: boolean

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[shiftKey](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#shiftkey)

### `Optional`view[](#view)

view?: [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[view](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#view)

### `Optional`which[](#which)

which?: number

#### Deprecated[](#deprecated)

Inherited from [EventModifierInit](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/).[which](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.EventModifierInit/#which)