Class DockviewWillShowOverlayLocationEvent

constructor

• new DockviewWillShowOverlayLocationEvent(
      event: WillShowOverlayEvent,
      options: DockviewWillShowOverlayLocationEventOptions,
  ): DockviewWillShowOverlayLocationEvent

  Parameters

  • event: WillShowOverlayEvent
  • options: DockviewWillShowOverlayLocationEventOptions

  Returns DockviewWillShowOverlayLocationEvent

Readonlyoptions

api

• get api(): DockviewApi

  Returns DockviewApi

defaultPrevented

• get defaultPrevented(): boolean

  Returns boolean

edge

• get edge(): boolean

  The resolved cell was marked edge (an outer "dock to the whole layout" cell). See DroptargetEvent.edge.

  Returns boolean

edgeGroup

• get edgeGroup(): boolean

  The resolved cell docks as a dedicated edge group (display hint). See PositionResolverResult.edgeGroup.

  Returns boolean

group

• get group(): DockviewGroupPanel | undefined

  Returns DockviewGroupPanel | undefined

kind

• get kind(): DockviewGroupDropLocation

  Returns DockviewGroupDropLocation

nativeEvent

• get nativeEvent(): DragEvent | PointerEvent

  Narrow with instanceof DragEvent before reading dataTransfer.

  Returns DragEvent | PointerEvent

panel

• get panel(): IDockviewPanel | undefined

  Returns IDockviewPanel | undefined

position

• get position(): Position

  Returns Position

getData

• getData(): PanelTransfer | undefined

  Returns PanelTransfer | undefined

preventDefault

• preventDefault(): void

  Returns void