---
title: "InputEvent | 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 InputEvent

The **`InputEvent`** interface represents an event notifying the user of editable content changes.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent)

interface InputEvent {  
    [AT\_TARGET](#at_target): 2;  
    [bubbles](#bubbles): boolean;  
    [BUBBLING\_PHASE](#bubbling_phase): 3;  
    [cancelable](#cancelable): boolean;  
    [cancelBubble](#cancelbubble): boolean;  
    [CAPTURING\_PHASE](#capturing_phase): 1;  
    [composed](#composed): boolean;  
    [currentTarget](#currenttarget): EventTarget | null;  
    [data](#data): string | null;  
    [dataTransfer](#datatransfer): [DataTransfer](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.DataTransfer/) | null;  
    [defaultPrevented](#defaultprevented): boolean;  
    [detail](#detail): number;  
    [eventPhase](#eventphase): number;  
    [inputType](#inputtype): string;  
    [isComposing](#iscomposing): boolean;  
    [isTrusted](#istrusted): boolean;  
    [NONE](#none): 0;  
    [returnValue](#returnvalue): boolean;  
    [srcElement](#srcelement): EventTarget | null;  
    [target](#target): EventTarget | null;  
    [timeStamp](#timestamp): number;  
    [type](#type): string;  
    [view](#view): [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null;  
    [which](#which): number;  
    [composedPath](#composedpath-1)(): EventTarget\[\];  
    [getTargetRanges](#gettargetranges-1)(): [StaticRange](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.StaticRange/)\[\];  
    [initEvent](#initevent-1)(type: string, bubbles?: boolean, cancelable?: boolean): void;  
    [initUIEvent](#inituievent-1)(  
        typeArg: string,  
        bubblesArg?: boolean,  
        cancelableArg?: boolean,  
        viewArg?: [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null,  
        detailArg?: number,  
    ): void;  
    [preventDefault](#preventdefault-1)(): void;  
    [stopImmediatePropagation](#stopimmediatepropagation-1)(): void;  
    [stopPropagation](#stoppropagation-1)(): void;  
}

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

-   [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/)
    -   InputEvent

##### Index

### Properties[](#properties)

[AT\_TARGET](#at_target) [bubbles](#bubbles) [BUBBLING\_PHASE](#bubbling_phase) [cancelable](#cancelable) [cancelBubble](#cancelbubble) [CAPTURING\_PHASE](#capturing_phase) [composed](#composed) [currentTarget](#currenttarget) [data](#data) [dataTransfer](#datatransfer) [defaultPrevented](#defaultprevented) [detail](#detail) [eventPhase](#eventphase) [inputType](#inputtype) [isComposing](#iscomposing) [isTrusted](#istrusted) [NONE](#none) [returnValue](#returnvalue) [srcElement](#srcelement) [target](#target) [timeStamp](#timestamp) [type](#type) [view](#view) [which](#which)

### Methods[](#methods)

[composedPath](#composedpath) [getTargetRanges](#gettargetranges) [initEvent](#initevent) [initUIEvent](#inituievent) [preventDefault](#preventdefault) [stopImmediatePropagation](#stopimmediatepropagation) [stopPropagation](#stoppropagation)

## Properties[](#properties-1)

### `Readonly`AT\_TARGET[](#at_target)

AT\_TARGET: 2

Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[AT\_TARGET](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#at_target)

### `Readonly`bubbles[](#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](https://developer.mozilla.org/docs/Web/API/Event/bubbles)

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

### `Readonly`BUBBLING\_PHASE[](#bubbling_phase)

BUBBLING\_PHASE: 3

Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[BUBBLING\_PHASE](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#bubbling_phase)

### `Readonly`cancelable[](#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](https://developer.mozilla.org/docs/Web/API/Event/cancelable)

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

### cancelBubble[](#cancelbubble)

cancelBubble: boolean

The **`cancelBubble`** property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

#### Deprecated[](#deprecated)

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)

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

### `Readonly`CAPTURING\_PHASE[](#capturing_phase)

CAPTURING\_PHASE: 1

Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[CAPTURING\_PHASE](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#capturing_phase)

### `Readonly`composed[](#composed)

composed: boolean

The read-only **`composed`** property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)

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

### `Readonly`currentTarget[](#currenttarget)

currentTarget: EventTarget | null

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

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)

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

### `Readonly`data[](#data)

data: string | null

The **`data`** read-only property of the InputEvent interface returns a string with inserted characters. This may be an empty string if the change doesn't insert text, such as when characters are deleted.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent/data)

### `Readonly`dataTransfer[](#datatransfer)

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

The **`dataTransfer`** read-only property of the InputEvent interface returns a DataTransfer object containing information about richtext or plaintext data being added to or removed from editable content.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent/dataTransfer)

### `Readonly`defaultPrevented[](#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](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)

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

### `Readonly`detail[](#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](https://developer.mozilla.org/docs/Web/API/UIEvent/detail)

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

### `Readonly`eventPhase[](#eventphase)

eventPhase: number

The **`eventPhase`** read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)

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

### `Readonly`inputType[](#inputtype)

inputType: string

The **`inputType`** read-only property of the InputEvent interface returns the type of change made to editable content. Possible changes include for example inserting, deleting, and formatting text.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent/inputType)

### `Readonly`isComposing[](#iscomposing)

isComposing: boolean

The **`InputEvent.isComposing`** read-only property returns a boolean value indicating if the event is fired after compositionstart and before compositionend.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent/isComposing)

### `Readonly`isTrusted[](#istrusted)

isTrusted: boolean

The **`isTrusted`** read-only property of the Event interface is a boolean value that is true 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 EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)

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

### `Readonly`NONE[](#none)

NONE: 0

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

### returnValue[](#returnvalue)

returnValue: boolean

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

#### Deprecated[](#deprecated-1)

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)

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

### `Readonly`srcElement[](#srcelement)

srcElement: EventTarget | null

The deprecated **`Event.srcElement`** is an alias for the Event.target property. Use Event.target instead.

#### Deprecated[](#deprecated-2)

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)

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

### `Readonly`target[](#target)

target: EventTarget | null

The read-only **`target`** property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)

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

### `Readonly`timeStamp[](#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](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)

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

### `Readonly`type[](#type)

type: string

The **`type`** read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)

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

### `Readonly`view[](#view)

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

The **`UIEvent.view`** read-only property returns the WindowProxy object from which the event was generated. In browsers, this is the Window object the event happened in.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/UIEvent/view)

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

### `Readonly`which[](#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[](#deprecated-3)

[MDN Reference](https://developer.mozilla.org/docs/Web/API/UIEvent/which)

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

## Methods[](#methods-1)

### composedPath[](#composedpath)

-   composedPath(): EventTarget\[\][](#composedpath-1)
    
    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. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)
    
    #### Returns EventTarget\[\]
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[composedPath](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#composedpath)
    

### getTargetRanges[](#gettargetranges)

-   getTargetRanges(): [StaticRange](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.StaticRange/)\[\][](#gettargetranges-1)
    
    The **`getTargetRanges()`** method of the InputEvent interface returns an array of StaticRange objects that will be affected by a change to the DOM if the input event is not canceled.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/InputEvent/getTargetRanges)
    
    #### Returns [StaticRange](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.StaticRange/)\[\]
    

### initEvent[](#initevent)

-   initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void[](#initevent-1)
    
    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[](#deprecated-4)
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[initEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#initevent)
    

### initUIEvent[](#inituievent)

-   initUIEvent(  
        typeArg: string,  
        bubblesArg?: boolean,  
        cancelableArg?: boolean,  
        viewArg?: [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null,  
        detailArg?: number,  
    ): void[](#inituievent-1)
    
    The **`UIEvent.initUIEvent()`** method initializes a UI event once it's been created.
    
    #### Parameters
    
    -   typeArg: string
    -   `Optional`bubblesArg: boolean
    -   `Optional`cancelableArg: boolean
    -   `Optional`viewArg: [Window](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.Window/) | null
    -   `Optional`detailArg: number
    
    #### Returns void
    
    #### Deprecated[](#deprecated-5)
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/UIEvent/initUIEvent)
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[initUIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#inituievent)
    

### preventDefault[](#preventdefault)

-   preventDefault(): void[](#preventdefault-1)
    
    The **`preventDefault()`** method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)
    
    #### Returns void
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[preventDefault](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#preventdefault)
    

### stopImmediatePropagation[](#stopimmediatepropagation)

-   stopImmediatePropagation(): void[](#stopimmediatepropagation-1)
    
    The **`stopImmediatePropagation()`** method of the Event interface prevents other listeners of the same event from being called.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
    
    #### Returns void
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[stopImmediatePropagation](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#stopimmediatepropagation)
    

### stopPropagation[](#stoppropagation)

-   stopPropagation(): void[](#stoppropagation-1)
    
    The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)
    
    #### Returns void
    
    Inherited from [UIEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/).[stopPropagation](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.UIEvent/#stoppropagation)