DragEvent extension type

The DragEvent interface is a 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.

This interface inherits properties from MouseEvent and Event.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

DragEvent(String type, [DragEventInit eventInitDict])
factory

Properties

altKey → bool
The MouseEvent.altKey read-only property is a boolean value that indicates whether the alt key was pressed or not when a given mouse event occurs.
no setterinherited
bubbles → bool
The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.
no setterinherited
button → int
The MouseEvent.button read-only property indicates which button was pressed on the mouse to trigger the event.
no setterinherited
buttons → int
The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.
no setterinherited
cancelable → bool
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.
no setterinherited
cancelBubble ↔ bool
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.
getter/setter pairinherited
clientX → int
The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's at which the event occurred (as opposed to the coordinate within the page).
no setterinherited
clientY → int
The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's at which the event occurred (as opposed to the coordinate within the page).
no setterinherited
composed → bool
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.
no setterinherited
ctrlKey → bool
The MouseEvent.ctrlKey read-only property is a boolean value that indicates whether the ctrl key was pressed or not when a given mouse event occurs.
no setterinherited
currentTarget → EventTarget?
The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.
no setterinherited
dataTransfer → DataTransfer?
The DragEvent.dataTransfer read-only property holds the drag operation's data (as a DataTransfer object).
no setter
defaultPrevented → bool
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.
no setterinherited
detail → int
The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.
no setterinherited
eventPhase → int
The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isTrusted → bool
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.
no setterinherited
metaKey → bool
The MouseEvent.metaKey read-only property is a boolean value that indicates whether the meta key was pressed or not when a given mouse event occurs.
no setterinherited
movementX → double
The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse pointer between the given event and the previous Element.mousemove_event event. In other words, the value of the property is computed like this: currentEvent.movementX = currentEvent.screenX - previousEvent.screenX.
no setterinherited
movementY → double
The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous Element.mousemove_event event. In other words, the value of the property is computed like this: currentEvent.movementY = currentEvent.screenY - previousEvent.screenY.
no setterinherited
offsetX → double
The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.
no setterinherited
offsetY → double
The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.
no setterinherited
pageX → double
The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document. This includes any portion of the document not currently visible.
no setterinherited
pageY → double
The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate (in pixels) at which the mouse was clicked, relative to the top edge of the entire document. This includes any portion of the document not currently visible.
no setterinherited
relatedTarget → EventTarget?
The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.
no setterinherited
returnValue ↔ bool
The Event property returnValue indicates whether the default action for this event has been prevented or not.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenX → int
The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in screen coordinates.
no setterinherited
screenY → int
The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in screen coordinates.
no setterinherited
shiftKey → bool
The MouseEvent.shiftKey read-only property is a boolean value that indicates whether the shift key was pressed or not when a given mouse event occurs.
no setterinherited
srcElement → EventTarget?
The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.
no setterinherited
target → EventTarget?
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.
no setterinherited
timeStamp → double
The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.
no setterinherited
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.
no setterinherited
view → Window?
The UIEvent.view read-only property returns the object from which the event was generated. In browsers, this is the Window object the event happened in.
no setterinherited
which → int
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.
no setterinherited
x → double
The MouseEvent.x property is an alias for the MouseEvent.clientX property.
no setterinherited
y → double
The MouseEvent.y property is an alias for the MouseEvent.clientY property.
no setterinherited

Methods

composedPath() → JSArray<EventTarget>
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.
inherited
getModifierState(String keyArg) → bool
The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.
inherited
initEvent(String type, [bool bubbles, bool cancelable]) → void
The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent.
inherited
initMouseEvent(String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, bool ctrlKeyArg, bool altKeyArg, bool shiftKeyArg, bool metaKeyArg, int buttonArg, EventTarget? relatedTargetArg]) → void
The MouseEvent.initMouseEvent() method initializes the value of a mouse event once it's been created (normally using the Document.createEvent method).
inherited
initUIEvent(String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg]) → void
The UIEvent.initUIEvent() method initializes a UI event once it's been created.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
preventDefault() → void
The preventDefault() method of the Event interface tells the that if the event does not get explicitly handled, its default action should not be taken as it normally would be.
inherited
stopImmediatePropagation() → void
The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.
inherited
stopPropagation() → void
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 Event.preventDefault method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see Event.stopImmediatePropagation.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited