Dockview
    Preparing search index...

    Interface DockviewPanelApi

    interface DockviewPanelApi {
        component: string;
        group: DockviewGroupPanel;
        height: number;
        id: string;
        isActive: boolean;
        isFocused: boolean;
        isGroupActive: boolean;
        isPinned: boolean;
        isVisible: boolean;
        location: DockviewGroupLocation;
        onDidActiveChange: DockviewEvent<ActiveEvent>;
        onDidActiveGroupChange: DockviewEvent<ActiveGroupEvent>;
        onDidChangePinned: DockviewEvent<PinnedChangeEvent>;
        onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>;
        onDidFocusChange: DockviewEvent<FocusEvent>;
        onDidGroupChange: DockviewEvent<GroupChangedEvent>;
        onDidLocationChange: DockviewEvent<DockviewGroupPanelLocationChangeEvent>;
        onDidParametersChange: DockviewEvent<Parameters>;
        onDidRendererChange: DockviewEvent<RendererChangedEvent>;
        onDidTitleChange: DockviewEvent<TitleEvent>;
        onDidVisibilityChange: DockviewEvent<VisibilityEvent>;
        onWillFocus: DockviewEvent<WillFocusEvent>;
        renderer: DockviewPanelRenderer;
        tabComponent: string | undefined;
        title: string | undefined;
        width: number;
        close(): void;
        exitMaximized(): void;
        getParameters<T extends Parameters = Parameters>(): T;
        getWindow(): Window;
        isMaximized(): boolean;
        maximize(): void;
        moveTo(options: DockviewGroupMoveParams): void;
        setActive(): void;
        setConstraints(value: GridConstraintChangeEvent2): void;
        setPinned(pinned: boolean): void;
        setRenderer(renderer: DockviewPanelRenderer): void;
        setSize(event: SizeEvent): void;
        setTitle(title: string): void;
        updateParameters(parameters: Parameters): void;
    }

    Hierarchy

    Index

    Properties

    component group height id isActive isFocused isGroupActive isPinned isVisible location onDidActiveChange onDidActiveGroupChange onDidChangePinned onDidDimensionsChange onDidFocusChange onDidGroupChange onDidLocationChange onDidParametersChange onDidRendererChange onDidTitleChange onDidVisibilityChange onWillFocus renderer tabComponent title width

    Methods

    close exitMaximized getParameters getWindow isMaximized maximize moveTo setActive setConstraints setPinned setRenderer setSize setTitle updateParameters

    Properties

    component: string

    The id of the component renderer

    group: DockviewGroupPanel
    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

    isGroupActive: boolean
    isPinned: boolean

    Whether this panel's tab is pinned. Pinned tabs render before unpinned tabs, never overflow, and resist cross-boundary reorder. Owned by the PinnedTabs module. Reads false until a panel is pinned, which requires pinnedTabs.enabled (both setPinned and restore are gated on it), so a component with pinning disabled always reports false.

    isVisible: boolean

    Whether the panel is visible

    location: DockviewGroupLocation
    onDidActiveChange: DockviewEvent<ActiveEvent>
    onDidActiveGroupChange: DockviewEvent<ActiveGroupEvent>
    onDidChangePinned: DockviewEvent<PinnedChangeEvent>
    onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>
    onDidFocusChange: DockviewEvent<FocusEvent>
    onDidGroupChange: DockviewEvent<GroupChangedEvent>
    onDidLocationChange: DockviewEvent<DockviewGroupPanelLocationChangeEvent>
    onDidParametersChange: DockviewEvent<Parameters>
    onDidRendererChange: DockviewEvent<RendererChangedEvent>
    onDidTitleChange: DockviewEvent<TitleEvent>
    onDidVisibilityChange: DockviewEvent<VisibilityEvent>
    onWillFocus: DockviewEvent<WillFocusEvent>
    renderer: DockviewPanelRenderer
    tabComponent: string | undefined

    The id of the tab component renderer

    Undefined if no custom tab renderer is provided

    title: string | undefined
    width: number

    The panel width in pixels

    Methods

    • Pin or unpin this panel's tab. No-op (warns once) when the PinnedTabs module is not registered, and dormant unless pinnedTabs.enabled is set.

      Parameters

      • pinned: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods