Interface DragEvent

A DOM event that represents a drag and drop interaction. The user initiates a drag by placing a pointer device (such as a mouse) on the touch surface and then dragging the pointer to a new location (such as another DOM element). Applications are free to interpret a drag and drop interaction in an application-specific way.

interface DragEvent {
    AT_TARGET: number;
    BUBBLING_PHASE: number;
    CAPTURING_PHASE: number;
    NONE: number;
    altKey: boolean;
    bubbles: boolean;
    button: number;
    buttons: number;
    cancelBubble: boolean;
    cancelable: boolean;
    clientX: number;
    clientY: number;
    composed: boolean;
    ctrlKey: boolean;
    currentTarget: null | EventTarget;
    dataTransfer: null | DataTransfer;
    defaultPrevented: boolean;
    detail: number;
    eventPhase: number;
    isTrusted: boolean;
    metaKey: boolean;
    movementX: number;
    movementY: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    relatedTarget: null | EventTarget;
    returnValue: boolean;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    view: null | 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: null | EventTarget): void;
    initUIEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: null | Window, detailArg?: number): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE altKey bubbles button buttons cancelBubble cancelable clientX clientY composed ctrlKey currentTarget dataTransfer 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

ReadonlyAT_TARGET

AT_TARGET: number

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: number

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: number

ReadonlyNONE

NONE: number

ReadonlyaltKey

altKey: boolean

Readonlybubbles

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.

Readonlybutton

button: number

Readonlybuttons

buttons: number

cancelBubble

cancelBubble: boolean

Deprecated

Readonlycancelable

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.

ReadonlyclientX

clientX: number

ReadonlyclientY

clientY: number

Readonlycomposed

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.

ReadonlyctrlKey

ctrlKey: boolean

ReadonlycurrentTarget

currentTarget: null | EventTarget

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

ReadonlydataTransfer

dataTransfer: null | DataTransfer

Returns the DataTransfer object for the event.

ReadonlydefaultPrevented

defaultPrevented: boolean

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

Readonlydetail

detail: number

ReadonlyeventPhase

eventPhase: number

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

ReadonlyisTrusted

isTrusted: boolean

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

ReadonlymetaKey

metaKey: boolean

ReadonlymovementX

movementX: number

ReadonlymovementY

movementY: number

ReadonlyoffsetX

offsetX: number

ReadonlyoffsetY

offsetY: number

ReadonlypageX

pageX: number

ReadonlypageY

pageY: number

ReadonlyrelatedTarget

relatedTarget: null | EventTarget

returnValue

returnValue: boolean

Deprecated

ReadonlyscreenX

screenX: number

ReadonlyscreenY

screenY: number

ReadonlyshiftKey

shiftKey: boolean

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

Readonlytarget

target: null | EventTarget

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

ReadonlytimeStamp

timeStamp: number

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

Readonlytype

type: string

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

Readonlyview

view: null | Window

Readonlywhich

which: number

Deprecated

Readonlyx

x: number

Readonlyy

y: number

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

  • getModifierState(keyArg): boolean

  • Parameters

    • keyArg: string

    Returns boolean

initEvent

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

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    Deprecated

initMouseEvent

  • initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): 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: null | EventTarget

    Returns void

    Deprecated

initUIEvent

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

  • Parameters

    • typeArg: string
    • OptionalbubblesArg: boolean
    • OptionalcancelableArg: boolean
    • OptionalviewArg: null | Window
    • OptionaldetailArg: number

    Returns void

    Deprecated

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.

    Returns void

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.

    Returns void

stopPropagation

  • stopPropagation(): void

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

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods