Class DockviewDidDropEvent

Hierarchy (View Summary)

DockviewEvent
- DockviewDidDropEvent
  - DockviewWillDropEvent

Index

Constructors

Accessors

api defaultPrevented group nativeEvent panel position

Methods

getData preventDefault

Constructors

constructor

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

Accessors

api

get api(): DockviewApi
Returns DockviewApi
- Defined in dockview/dockviewGroupPanelModel.ts:125

defaultPrevented

get defaultPrevented(): boolean
Returns boolean
Inherited from DockviewEvent.defaultPrevented
- Defined in events.ts:35

group

get group(): DockviewGroupPanel | undefined
Returns DockviewGroupPanel | undefined
- Defined in dockview/dockviewGroupPanelModel.ts:121

nativeEvent

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

Returns PointerEvent | DragEvent
- Defined in dockview/dockviewGroupPanelModel.ts:109

panel

get panel(): IDockviewPanel | undefined
Returns IDockviewPanel | undefined
- Defined in dockview/dockviewGroupPanelModel.ts:117

position

get position(): Position
Returns Position
- Defined in dockview/dockviewGroupPanelModel.ts:113

Methods

getData

getData(): PanelTransfer | undefined
Returns PanelTransfer | undefined
- Defined in dockview/dockviewGroupPanelModel.ts:142

preventDefault

preventDefault(): void
Returns void
Inherited from DockviewEvent.preventDefault
- Defined in events.ts:39