Dockview
    Preparing search index...

    Interface DockviewGroupPanelApi

    interface DockviewGroupPanelApi {
        component: string;
        height: number;
        id: string;
        isActive: boolean;
        isFocused: boolean;
        isVisible: boolean;
        location: DockviewGroupLocation;
        locked: DockviewGroupPanelLocked;
        onDidActiveChange: DockviewEvent<ActiveEvent>;
        onDidActivePanelChange: DockviewEvent<DockviewGroupActivePanelChangeEvent>;
        onDidCollapsedChange: DockviewEvent<DockviewGroupPanelCollapsedChangeEvent>;
        onDidConstraintsChange: DockviewEvent<GridConstraintChangeEvent>;
        onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>;
        onDidFocusChange: DockviewEvent<FocusEvent>;
        onDidHeaderDirectionChange: DockviewEvent<
            DockviewGroupPanelHeaderDirectionChangeEvent,
        >;
        onDidLocationChange: DockviewEvent<DockviewGroupPanelLocationChangeEvent>;
        onDidParametersChange: DockviewEvent<Parameters>;
        onDidPeekChange: DockviewEvent<DockviewGroupPanelPeekChangeEvent>;
        onDidVisibilityChange: DockviewEvent<VisibilityEvent>;
        onWillFocus: DockviewEvent<WillFocusEvent>;
        width: number;
        close(): void;
        collapse(): void;
        exitMaximized(): void;
        expand(): void;
        getHeaderPosition(): DockviewHeaderPosition;
        getParameters<T extends Parameters = Parameters>(): T;
        getWindow(): Window;
        isAutoHide(): boolean;
        isCollapsed(): boolean;
        isMaximized(): boolean;
        isPeeking(): boolean;
        maximize(): void;
        moveTo(options: DockviewGroupMoveParams): void;
        setActive(): void;
        setAutoHide(value: boolean | undefined): void;
        setConstraints(value: GridConstraintChangeEvent2): void;
        setHeaderPosition(position: DockviewHeaderPosition): void;
        setSize(event: SizeEvent): void;
        setVisible(isVisible: boolean): void;
        updateParameters(parameters: Parameters): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    component height id isActive isFocused isVisible location locked onDidActiveChange onDidActivePanelChange onDidCollapsedChange onDidConstraintsChange onDidDimensionsChange onDidFocusChange onDidHeaderDirectionChange onDidLocationChange onDidParametersChange onDidPeekChange onDidVisibilityChange onWillFocus width

    Methods

    close collapse exitMaximized expand getHeaderPosition getParameters getWindow isAutoHide isCollapsed isMaximized isPeeking maximize moveTo setActive setAutoHide setConstraints setHeaderPosition setSize setVisible updateParameters

    Properties

    component: string

    The id of the component renderer

    height: number

    The panel height in pixels

    id: string

    The id of the panel that would have been assigned when the panel was created

    isActive: boolean

    Whether the panel is the actively selected panel

    isFocused: boolean

    Whether the panel holds the current focus

    isVisible: boolean

    Whether the panel is visible

    location: DockviewGroupLocation
    locked: DockviewGroupPanelLocked

    Whether this group is locked against drop interactions.

    • true: panels cannot be dropped into the group (center / tabs), but the group can still be split from its edges.
    • 'no-drop-target': all drop zones are disabled for this group.
    onDidActiveChange: DockviewEvent<ActiveEvent>
    onDidActivePanelChange: DockviewEvent<DockviewGroupActivePanelChangeEvent>

    Fires when the active panel within this group changes. Scoped to the group, in contrast to the component-level DockviewApi.onDidActivePanelChange (which tracks the active panel across the whole dockview). Both carry an DockviewOrigin reporting whether the change came from a user gesture or an API call.

    onDidCollapsedChange: DockviewEvent<DockviewGroupPanelCollapsedChangeEvent>

    Fired when an edge group's collapsed state changes. Never fires for non-edge groups.

    onDidConstraintsChange: DockviewEvent<GridConstraintChangeEvent>
    onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>
    onDidFocusChange: DockviewEvent<FocusEvent>
    onDidHeaderDirectionChange: DockviewEvent<
        DockviewGroupPanelHeaderDirectionChangeEvent,
    >

    Fires when this group's header flips orientation between horizontal (top/bottom) and vertical (left/right), e.g. when headerPosition moves from top to left. Does not fire for position changes that keep the same axis (top↔bottom, left↔right) or for the initial set.

    onDidLocationChange: DockviewEvent<DockviewGroupPanelLocationChangeEvent>
    onDidParametersChange: DockviewEvent<Parameters>
    onDidPeekChange: DockviewEvent<DockviewGroupPanelPeekChangeEvent>

    Fired when an edge group's auto-hide peek state changes (the slid-out overlay shown/hidden while the group stays logically collapsed). Never fires for non-edge groups or without the auto-hide module.

    onDidVisibilityChange: DockviewEvent<VisibilityEvent>
    onWillFocus: DockviewEvent<WillFocusEvent>
    width: number

    The panel width in pixels

    Methods

    • The resolved auto-hide state of this edge group: the per-group override if one is set, otherwise the global autoHideEdgeGroups option for this edge. Always returns false for non-edge groups.

      Returns boolean

    • Returns true if this edge group is currently collapsed. Always returns false for non-edge groups.

      Returns boolean

    • Opt this edge group in/out of auto-hide (pinnable tool-window) behaviour at runtime, overriding the global autoHideEdgeGroups option. Pass undefined to clear the override and inherit the global. No-op for non-edge groups or without the auto-hide module.

      Parameters

      • value: boolean | undefined

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods