Dockview
    Preparing search index...

    Class DockviewComponent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    _activeGroup: DockviewGroupPanel | undefined
    _bufferOnDidLayoutChange: AsapEvent = ...
    _groups: Map<string, IValueDisposable<DockviewGroupPanel>> = ...
    _onDidAddGroup: DockviewEmitter<DockviewGroupPanel> = ...
    gridview: Gridview
    onDidActiveChange: DockviewEvent<DockviewGroupPanel | undefined> = ...
    onDidActiveGroupChange: DockviewEvent<DockviewGroupPanel | undefined> = ...
    onDidActivePanelChange: DockviewEvent<DockviewActivePanelChangeEvent> = ...
    onDidAddGroup: DockviewEvent<DockviewGroupPanel> = ...
    onDidAddPanel: DockviewEvent<IDockviewPanel> = ...
    onDidAddPanelToTabGroup: DockviewEvent<DockviewTabGroupPanelChangeEvent> = ...
    onDidAddPopoutGroup: DockviewEvent<PopoutGroup> = ...
    onDidCreateTabGroup: DockviewEvent<DockviewTabGroupChangeEvent> = ...
    onDidDestroyTabGroup: DockviewEvent<DockviewTabGroupChangeEvent> = ...
    onDidLayoutChange: DockviewEvent<void> = ...
    onDidLayoutFromJSON: DockviewEvent<void> = ...
    onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>> = ...
    onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChangeEvent> = ...
    onDidMovePanel: DockviewEvent<MovePanelEvent> = ...
    onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent> = ...
    onDidOpenPopoutWindowFail: DockviewEvent<void> = ...
    onDidOptionsChange: DockviewEvent<void> = ...
    onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent> = ...
    onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent> = ...
    onDidRemove: DockviewEvent<DockviewGroupPanel> = ...
    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel> = ...
    onDidRemovePanel: DockviewEvent<IDockviewPanel> = ...
    onDidRemovePanelFromTabGroup: DockviewEvent<DockviewTabGroupPanelChangeEvent> = ...
    onDidRemovePopoutGroup: DockviewEvent<PopoutGroup> = ...
    onDidTabGroupChange: DockviewEvent<DockviewTabGroupChangeEvent> = ...
    onDidTabGroupCollapsedChange: DockviewEvent<DockviewTabGroupChangeEvent> = ...
    onDidViewVisibilityChangeMicroTaskQueue: DockviewEvent<void> = ...
    onUnhandledDragOver: DockviewEvent<DockviewDndOverlayEvent> = ...
    onWillDragGroup: DockviewEvent<GroupDragEvent> = ...
    onWillDragPanel: DockviewEvent<TabDragEvent> = ...
    onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent> = ...

    Fires before / after a structural layout change — used to restore focus on close.

    overlayRenderContainer: OverlayRenderContainer
    popupService: PopupService
    rootDropTargetContainer: DropTargetAnchorContainer

    Accessors

    • get disableResizing(): boolean

      Returns boolean

    • set disableResizing(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isDisposed(): boolean

      Returns boolean

    • get popoutRestorationPromise(): Promise<void>

      Promise that resolves when all popout groups from the last fromJSON call are restored. Useful for tests that need to wait for delayed popout creation.

      Returns Promise<void>

    Methods

    • Build, fire, and return the verdict for an unhandled-drag-over event. Implemented on the component side so the service stays free of circular imports with the event class declared in dockviewComponent.

      Parameters

      • nativeEvent: PointerEvent | DragEvent
      • position: Position

      Returns boolean

    • Bracket a structural mutation with onWillMutateLayout / onDidMutateLayout. Re-entrant: nested calls (a compound operation such as a drag that relocates a panel) join the outermost transaction, so the events fire exactly once around the whole operation. kind reflects the outermost mutation.

      Type Parameters

      • T

      Parameters

      Returns T

    • Parameters

      • panel: IDockviewPanel
      • Optionaloptions: {
            removeEmptyGroup?: boolean;
            skipDispose?: boolean;
            skipSetActiveGroup?: boolean;
        }

      Returns void

    • Returns DropTargetTargetModel | undefined

    • Run func with the operation origin set to origin, restoring the previous value afterwards. Used by the DockviewApi boundary to tag programmatic operations as 'api', and by user-gesture handlers to tag 'user'. Only the outermost caller sets the origin — a nested call (or a call made while a mutation is already in flight) keeps whatever the enclosing operation established, so the trigger always wins.

      Type Parameters

      • T

      Parameters

      Returns T