Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDragEvent

A custom event type used for drag-drop operations.

Notes

In order to receive 'p-dragover', 'p-dragleave', or 'p-drop' events, a drop target must cancel the 'p-dragenter' event by calling the event's preventDefault() method.

Hierarchy

  • MouseEvent
    • IDragEvent

Index

Properties

AT_TARGET

AT_TARGET: number

BUBBLING_PHASE

BUBBLING_PHASE: number

CAPTURING_PHASE

CAPTURING_PHASE: number

MouseEvent

MouseEvent: object

Type declaration

NONE

NONE: number

altKey

altKey: boolean

bubbles

bubbles: boolean

button

button: number

buttons

buttons: number

cancelBubble

cancelBubble: boolean

cancelable

cancelable: boolean

clientX

clientX: number

clientY

clientY: number

composed

composed: boolean

ctrlKey

ctrlKey: boolean

currentTarget

currentTarget: EventTarget | null

defaultPrevented

defaultPrevented: boolean

detail

detail: number

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 'p-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.

eventPhase

eventPhase: number

fromElement

fromElement: Element
deprecated

isTrusted

isTrusted: boolean

layerX

layerX: number

layerY

layerY: number

metaKey

metaKey: boolean

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.

movementX

movementX: number

movementY

movementY: number

offsetX

offsetX: number

offsetY

offsetY: number

pageX

pageX: number

pageY

pageY: number

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.

relatedTarget

relatedTarget: EventTarget

returnValue

returnValue: boolean

screenX

screenX: number

screenY

screenY: number

shiftKey

shiftKey: boolean

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.

srcElement

srcElement: Element | null

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 'p-dragover' event, the drop event will not occur.

target

target: EventTarget | null

timeStamp

timeStamp: number

toElement

toElement: Element
deprecated

type

type: string

view

view: Window

which

which: number
deprecated

x

x: number

y

y: number

Methods

deepPath

  • deepPath(): EventTarget[]
  • Returns EventTarget[]

getModifierState

  • getModifierState(keyArg: string): boolean
  • Parameters

    • keyArg: string

    Returns boolean

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void
  • Parameters

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

    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
  • 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
  • Parameters

    • typeArg: string
    • canBubbleArg: boolean
    • cancelableArg: boolean
    • viewArg: Window
    • detailArg: number

    Returns void

preventDefault

  • preventDefault(): void
  • Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void
  • Returns void

stopPropagation

  • stopPropagation(): void
  • Returns void

Generated using TypeDoc