Class DockviewWillDropEvent

Hierarchy (View Summary)

DockviewDidDropEvent
- DockviewWillDropEvent

Index

Constructors

Accessors

api defaultPrevented group kind nativeEvent panel position

Methods

getData preventDefault

Constructors

constructor

new DockviewWillDropEvent(
    options: {
        api: DockviewApi;
        group?: DockviewGroupPanel;
        kind: DockviewGroupDropLocation;
        nativeEvent: DragEvent | PointerEvent;
        panel?: IDockviewPanel;
        position: Position;
        getData(): PanelTransfer | undefined;
    },
): DockviewWillDropEvent
Parameters
- options: {
      api: DockviewApi;
      group?: DockviewGroupPanel;
      kind: DockviewGroupDropLocation;
      nativeEvent: DragEvent | PointerEvent;
      panel?: IDockviewPanel;
      position: Position;
      getData(): PanelTransfer | undefined;
  }
Returns DockviewWillDropEvent
Overrides DockviewDidDropEvent.constructor
- Defined in dockview/dockviewGroupPanelModel.ts:161

Accessors

api

get api(): DockviewApi
Returns DockviewApi
Inherited from DockviewDidDropEvent.api
- Defined in dockview/dockviewGroupPanelModel.ts:132

defaultPrevented

get defaultPrevented(): boolean
Returns boolean
Inherited from DockviewDidDropEvent.defaultPrevented
- Defined in events.ts:37

group

get group(): DockviewGroupPanel | undefined
Returns DockviewGroupPanel | undefined
Inherited from DockviewDidDropEvent.group
- Defined in dockview/dockviewGroupPanelModel.ts:128

kind

get kind(): DockviewGroupDropLocation
Returns DockviewGroupDropLocation
- Defined in dockview/dockviewGroupPanelModel.ts:157

nativeEvent

get nativeEvent(): DragEvent | PointerEvent
PointerEvent for touch drags has no dataTransfer; use getData() for the dockview payload regardless of input method.

Returns DragEvent | PointerEvent
Inherited from DockviewDidDropEvent.nativeEvent
- Defined in dockview/dockviewGroupPanelModel.ts:116

panel

get panel(): IDockviewPanel | undefined
Returns IDockviewPanel | undefined
Inherited from DockviewDidDropEvent.panel
- Defined in dockview/dockviewGroupPanelModel.ts:124

position

get position(): Position
Returns Position
Inherited from DockviewDidDropEvent.position
- Defined in dockview/dockviewGroupPanelModel.ts:120

Methods

getData

getData(): PanelTransfer | undefined
Returns PanelTransfer | undefined
Inherited from DockviewDidDropEvent.getData
- Defined in dockview/dockviewGroupPanelModel.ts:149

preventDefault

preventDefault(): void
Returns void
Inherited from DockviewDidDropEvent.preventDefault
- Defined in events.ts:41