Skip to main content

DragDropArgs<T>

Defined in: src/events.ts:303

Arguments passed to drag-and-drop callbacks (see DG.ui.makeDroppable). Wraps the Dart DragDropArgs handle exposed via the GrokJsObject mixin.

Type Parameters

Type ParameterDefault type
Tany

Constructors

Constructor

new DragDropArgs<T>(dart): DragDropArgs<T>

Defined in: src/events.ts:306

Parameters

ParameterType
dartany

Returns

DragDropArgs<T>

Properties

PropertyModifierTypeDefined in
dartpublicanysrc/events.ts:304

Accessors

copying

Get Signature

get copying(): boolean

Defined in: src/events.ts:320

True when the drop should copy rather than move (Ctrl / Cmd held).

Returns

boolean


dragFromElement

Get Signature

get dragFromElement(): Element | null

Defined in: src/events.ts:332

Element the drag originated from.

Returns

Element | null


dragObject

Get Signature

get dragObject(): T

Defined in: src/events.ts:311

The object being dragged (e.g. DG.Column, DG.DataFrame, or an HTMLElement).

Returns

T


dragObjectType

Get Signature

get dragObjectType(): string

Defined in: src/events.ts:317

Type tag supplied by the drag source (e.g. 'column', 'row', 'markup').

Returns

string


dragSource

Get Signature

get dragSource(): any

Defined in: src/events.ts:314

Source context of the drag (e.g. parent DataFrame for a column drag).

Returns

any


dropEvent

Get Signature

get dropEvent(): MouseEvent

Defined in: src/events.ts:329

Mouse-up event on the drop zone (set when the drop actually happens).

Returns

MouseEvent


event

Get Signature

get event(): Event

Defined in: src/events.ts:326

Original drag-start event.

Returns

Event


handled

Get Signature

get handled(): boolean

Defined in: src/events.ts:335

When true, further handling of the drop is suppressed.

Returns

boolean

Set Signature

set handled(v): void

Defined in: src/events.ts:336

Parameters
ParameterType
vboolean
Returns

void


Get Signature

get link(): boolean

Defined in: src/events.ts:323

True when the drop should create a link rather than copy/move (Alt held).

Returns

boolean