Class WillShowOverlayLocationEvent

Implements

IDockviewEvent

Index

Constructors

Properties

Accessors

api defaultPrevented group kind nativeEvent panel position

Methods

getData preventDefault

Constructors

constructor

new WillShowOverlayLocationEvent(event, options): WillShowOverlayLocationEvent
Parameters
- event: WillShowOverlayEvent
- options: {
      api: DockviewApi;
      getData: (() => undefined | PanelTransfer);
      group: undefined | DockviewGroupPanel;
      kind: DockviewGroupDropLocation;
      panel: undefined | IDockviewPanel;
  }
  - api: DockviewApi
  - getData: (() => undefined | PanelTransfer)
    - (): undefined | PanelTransfer
      Returns undefined | PanelTransfer
  - group: undefined | DockviewGroupPanel
  - kind: DockviewGroupDropLocation
  - panel: undefined | IDockviewPanel
Returns WillShowOverlayLocationEvent
- Defined in dockview/dockviewGroupPanelModel.ts:238

Properties

`Private` `Readonly` event

event: WillShowOverlayEvent

`Private` `Readonly` options

options: {
    api: DockviewApi;
    getData: (() => undefined | PanelTransfer);
    group: undefined | DockviewGroupPanel;
    kind: DockviewGroupDropLocation;
    panel: undefined | IDockviewPanel;
}

Type declaration

api: DockviewApi
getData: (() => undefined | PanelTransfer)
- - (): undefined | PanelTransfer
  - Returns undefined | PanelTransfer
group: undefined | DockviewGroupPanel
kind: DockviewGroupDropLocation
panel: undefined | IDockviewPanel

Accessors

api

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

defaultPrevented

get defaultPrevented(): boolean
Returns boolean
Implementation of IDockviewEvent.defaultPrevented
- Defined in dockview/dockviewGroupPanelModel.ts:214

group

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

kind

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

nativeEvent

get nativeEvent(): DragEvent
Returns DragEvent
- Defined in dockview/dockviewGroupPanelModel.ts:206

panel

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

position

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

Methods

getData

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

preventDefault

preventDefault(): void
Returns void
Implementation of IDockviewEvent.preventDefault
- Defined in dockview/dockviewGroupPanelModel.ts:230

Generated using TypeDoc