Interface IDragEvent

Deprecated

Notes

This interface is deprecated. Use Drag.Event instead.

interface IDragEvent {
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    CAPTURING_PHASE: 1;
    NONE: 0;
    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;
    dropAction: DropAction;
    eventPhase: number;
    isTrusted: boolean;
    metaKey: boolean;
    mimeData: MimeData;
    movementX: number;
    movementY: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    proposedAction: DropAction;
    relatedTarget: null | EventTarget;
    returnValue: boolean;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    source: any;
    srcElement: null | EventTarget;
    supportedActions: SupportedActions;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    view: null | Window;
    which: number;
    x: number;
    y: number;
    composedPath(): EventTarget[];
    getModifierState(keyArg): boolean;
    initEvent(type, bubbles?, cancelable?): void;
    initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void;
    initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): 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 dropAction eventPhase isTrusted metaKey mimeData movementX movementY offsetX offsetY pageX pageY proposedAction relatedTarget returnValue screenX screenY shiftKey source srcElement supportedActions target timeStamp type view which x y

Methods

composedPath getModifierState initEvent initMouseEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

Properties

Readonly AT_TARGET

AT_TARGET: 2

Readonly BUBBLING_PHASE

BUBBLING_PHASE: 3

Readonly CAPTURING_PHASE

CAPTURING_PHASE: 1

Readonly NONE

NONE: 0

Readonly altKey

altKey: boolean

MDN Reference

Readonly bubbles

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

Readonly button

button: number

MDN Reference

Readonly buttons

buttons: number

MDN Reference

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

Readonly cancelable

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

Readonly clientX

clientX: number

MDN Reference

Readonly clientY

clientY: number

MDN Reference

Readonly composed

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

Readonly ctrlKey

ctrlKey: boolean

MDN Reference

Readonly currentTarget

currentTarget: null | EventTarget

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

MDN Reference

Readonly dataTransfer

dataTransfer: null | DataTransfer

Returns the DataTransfer object for the event.

MDN Reference

Readonly defaultPrevented

defaultPrevented: boolean

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

MDN Reference

Readonly detail

detail: number

MDN Reference

dropAction

dropAction: DropAction

The drop action supported or taken by the drop target.

Notes

At the start of each event, this value will be 'none'. During a 'lm-dragover' event, the drop target must set this value to one of the supported actions, or the drop event will not occur.

When handling the drop event, the drop target should set this to the action which was actually taken. This value will be reported back to the drag initiator.

Readonly eventPhase

eventPhase: number

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

MDN Reference

Readonly isTrusted

isTrusted: boolean

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

MDN Reference

Readonly metaKey

metaKey: boolean

MDN Reference

Readonly mimeData

mimeData: MimeData

The mime data associated with the event.

Notes

This is mime data provided by the drag initiator. Drop targets should use this data to determine if they can handle the drop.

Readonly movementX

movementX: number

MDN Reference

Readonly movementY

movementY: number

MDN Reference

Readonly offsetX

offsetX: number

MDN Reference

Readonly offsetY

offsetY: number

MDN Reference

Readonly pageX

pageX: number

MDN Reference

Readonly pageY

pageY: number

MDN Reference

Readonly proposedAction

proposedAction: DropAction

The drop action proposed by the drag initiator.

Notes

This is the action which is preferred by the drag initiator. The drop target is not required to perform this action, but should if it all possible.

Readonly relatedTarget

relatedTarget: null | EventTarget

MDN Reference

returnValue

returnValue: boolean

Deprecated

MDN Reference

Readonly screenX

screenX: number

MDN Reference

Readonly screenY

screenY: number

MDN Reference

Readonly shiftKey

shiftKey: boolean

MDN Reference

Readonly source

source: any

The source object of the drag, as provided by the drag initiator.

Notes

For advanced applications, the drag initiator may wish to expose a source object to the drop targets. That will be provided here if given by the drag initiator, otherwise it will be null.

Readonly srcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

Readonly supportedActions

supportedActions: SupportedActions

The drop actions supported by the drag initiator.

Notes

If the dropAction is not set to one of the supported actions during the 'lm-dragover' event, the drop event will not occur.

Readonly target

target: null | EventTarget

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

MDN Reference

Readonly timeStamp

timeStamp: number

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

MDN Reference

Readonly type

type: string

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

MDN Reference

Readonly view

view: null | Window

MDN Reference

Readonly which

which: number

Deprecated

MDN Reference

Readonly x

x: number

MDN Reference

Readonly y

y: number

MDN Reference

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[]

getModifierState

  • getModifierState(keyArg): boolean

  • MDN Reference

    Parameters

    • keyArg: string

    Returns boolean

initEvent

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

  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

    Deprecated

    MDN Reference

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

    MDN Reference

initUIEvent

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

  • Parameters

    • typeArg: string
    • Optional bubblesArg: boolean
    • Optional cancelableArg: boolean
    • Optional viewArg: null | Window
    • Optional detailArg: number

    Returns void

    Deprecated

    MDN Reference

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

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

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

Settings

Member Visibility

Theme

On This Page

AT_TARGETBUBBLING_PHASECAPTURING_PHASENONEaltKeybubblesbuttonbuttonscancelBubblecancelableclientXclientYcomposedctrlKeycurrentTargetdataTransferdefaultPreventeddetaildropActioneventPhaseisTrustedmetaKeymimeDatamovementXmovementYoffsetXoffsetYpageXpageYproposedActionrelatedTargetreturnValuescreenXscreenYshiftKeysourcesrcElementsupportedActionstargettimeStamptypeviewwhichxycomposedPathgetModifierStateinitEventinitMouseEventinitUIEventpreventDefaultstopImmediatePropagationstopPropagation