DragDropArgs<T>
Defined in: js-api/src/events.ts:346
Arguments passed to drag-and-drop callbacks (see DG.ui.makeDroppable).
Wraps the Dart DragDropArgs handle exposed via the GrokJsObject mixin.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Constructors
Constructor
new DragDropArgs<
T>(dart):DragDropArgs<T>
Defined in: js-api/src/events.ts:349
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
DragDropArgs<T>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
dart | public | any | js-api/src/events.ts:347 |
Accessors
copying
Get Signature
get copying():
boolean
Defined in: js-api/src/events.ts:363
True when the drop should copy rather than move (Ctrl / Cmd held).
Returns
boolean
dragFromElement
Get Signature
get dragFromElement():
Element|null
Defined in: js-api/src/events.ts:375
Element the drag originated from.
Returns
Element | null
dragObject
Get Signature
get dragObject():
T
Defined in: js-api/src/events.ts:354
The object being dragged (e.g. DG.Column, DG.DataFrame, or an HTMLElement).
Returns
T
dragObjectType
Get Signature
get dragObjectType():
string
Defined in: js-api/src/events.ts:360
Type tag supplied by the drag source (e.g. 'column', 'row', 'markup').
Returns
string
dragSource
Get Signature
get dragSource():
any
Defined in: js-api/src/events.ts:357
Source context of the drag (e.g. parent DataFrame for a column drag).
Returns
any
dropEvent
Get Signature
get dropEvent():
MouseEvent
Defined in: js-api/src/events.ts:372
Mouse-up event on the drop zone (set when the drop actually happens).
Returns
MouseEvent
event
Get Signature
get event():
Event
Defined in: js-api/src/events.ts:369
Original drag-start event.
Returns
Event
handled
Get Signature
get handled():
boolean
Defined in: js-api/src/events.ts:378
When true, further handling of the drop is suppressed.
Returns
boolean
Set Signature
set handled(
v):void
Defined in: js-api/src/events.ts:379
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
link
Get Signature
get link():
boolean
Defined in: js-api/src/events.ts:366
True when the drop should create a link rather than copy/move (Alt held).
Returns
boolean