Dockview
    Preparing search index...

    Interface IDockviewComponent

    interface IDockviewComponent {
        activeGroup: DockviewGroupPanel | undefined;
        activePanel: IDockviewPanel | undefined;
        doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void;
        element: HTMLElement;
        getGroupPanel: (id: string) => IDockviewPanel | undefined;
        groups: DockviewGroupPanel[];
        height: number;
        id: string;
        maximumHeight: number;
        maximumWidth: number;
        minimumHeight: number;
        minimumWidth: number;
        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>;
        onDidDrop: DockviewEvent<DockviewDidDropEvent>;
        onDidLayoutChange: DockviewEvent<void>;
        onDidLayoutFromJSON: DockviewEvent<void>;
        onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>;
        onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChangeEvent>;
        onDidMovePanel: DockviewEvent<MovePanelEvent>;
        onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
        onDidOpenPopoutWindowFail: DockviewEvent<void>;
        onDidPopoutGroupPositionChange: DockviewEvent<
            PopoutGroupChangePositionEvent,
        >;
        onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>;
        onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>;
        onDidRemovePanel: DockviewEvent<IDockviewPanel>;
        onDidRemovePanelFromTabGroup: DockviewEvent<
            DockviewTabGroupPanelChangeEvent,
        >;
        onDidRemovePopoutGroup: DockviewEvent<PopoutGroup>;
        onDidTabGroupChange: DockviewEvent<DockviewTabGroupChangeEvent>;
        onDidTabGroupCollapsedChange: DockviewEvent<DockviewTabGroupChangeEvent>;
        onUnhandledDragOver: DockviewEvent<DockviewDndOverlayEvent>;
        onWillDragGroup: DockviewEvent<GroupDragEvent>;
        onWillDragPanel: DockviewEvent<TabDragEvent>;
        onWillDrop: DockviewEvent<DockviewWillDropEvent>;
        onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
        onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>;
        options: DockviewComponentOptions;
        orientation: Orientation;
        panels: IDockviewPanel[];
        removeGroup: (group: DockviewGroupPanel) => void;
        size: number;
        tabGroupColorPalette: TabGroupColorPalette;
        totalPanels: number;
        width: number;
        addEdgeGroup(
            position: EdgeGroupPosition,
            options: EdgeGroupOptions,
        ): DockviewGroupPanelApi;
        addFloatingGroup(
            item: IDockviewPanel | DockviewGroupPanel,
            options?: FloatingGroupOptions,
        ): void;
        addGroup(options?: AddGroupOptions): DockviewGroupPanel;
        addPanel<T extends object = Parameters>(
            options: AddPanelOptions<T>,
        ): IDockviewPanel;
        addPopoutGroup(
            item: IDockviewPanel | DockviewGroupPanel,
            options?: DockviewPopoutGroupOptions,
        ): Promise<boolean>;
        adjacentGroupInDirection(
            group: DockviewGroupPanel,
            direction: GroupNavigationDirection,
        ): DockviewGroupPanel | undefined;
        clear(): void;
        closeAllGroups(): void;
        createWatermarkComponent(): IWatermarkRenderer;
        currentOrigin(): DockviewOrigin;
        dispose(): void;
        exitMaximizedGroup(): void;
        focus(): void;
        fromJSON(data: SerializedDockview): void;
        fromJSON(data: any, options?: { reuseExistingPanels: boolean }): void;
        getEdgeGroup(
            position: EdgeGroupPosition,
        ): DockviewGroupPanelApi | undefined;
        getPanel(id: string): DockviewGroupPanel | undefined;
        getPopouts(): PopoutGroup[];
        hasMaximizedGroup(): boolean;
        isEdgeGroupVisible(position: EdgeGroupPosition): boolean;
        isMaximizedGroup(panel: DockviewGroupPanel): boolean;
        isVisible(panel: DockviewGroupPanel): boolean;
        layout(width: number, height: number, force?: boolean): void;
        maximizeGroup(panel: DockviewGroupPanel): void;
        moveGroup(options: MoveGroupOptions): void;
        moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
        moveToNext(options?: MovementOptions): void;
        moveToPrevious(options?: MovementOptions): void;
        removeEdgeGroup(position: EdgeGroupPosition): void;
        removePanel(panel: IDockviewPanel): void;
        setActivePanel(panel: IDockviewPanel): void;
        setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
        setVisible(panel: DockviewGroupPanel, visible: boolean): void;
        toJSON(): SerializedDockview;
        updateOptions(options: DockviewOptions): void;
        withOrigin<T>(origin: DockviewOrigin, func: () => T): T;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    activeGroup activePanel doSetGroupActive element getGroupPanel groups height id maximumHeight maximumWidth minimumHeight minimumWidth onDidActiveGroupChange onDidActivePanelChange onDidAddGroup onDidAddPanel onDidAddPanelToTabGroup onDidAddPopoutGroup onDidCreateTabGroup onDidDestroyTabGroup onDidDrop onDidLayoutChange onDidLayoutFromJSON onDidMaximizedChange onDidMaximizedGroupChange onDidMovePanel onDidMutateLayout onDidOpenPopoutWindowFail onDidPopoutGroupPositionChange onDidPopoutGroupSizeChange onDidRemoveGroup onDidRemovePanel onDidRemovePanelFromTabGroup onDidRemovePopoutGroup onDidTabGroupChange onDidTabGroupCollapsedChange onUnhandledDragOver onWillDragGroup onWillDragPanel onWillDrop onWillMutateLayout onWillShowOverlay options orientation panels removeGroup size tabGroupColorPalette totalPanels width

    Methods

    addEdgeGroup addFloatingGroup addGroup addPanel addPopoutGroup adjacentGroupInDirection clear closeAllGroups createWatermarkComponent currentOrigin dispose exitMaximizedGroup focus fromJSON getEdgeGroup getPanel getPopouts hasMaximizedGroup isEdgeGroupVisible isMaximizedGroup isVisible layout maximizeGroup moveGroup moveGroupOrPanel moveToNext moveToPrevious removeEdgeGroup removePanel setActivePanel setEdgeGroupVisible setVisible toJSON updateOptions withOrigin

    Properties

    activeGroup: DockviewGroupPanel | undefined
    activePanel: IDockviewPanel | undefined
    doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void
    element: HTMLElement
    getGroupPanel: (id: string) => IDockviewPanel | undefined
    groups: DockviewGroupPanel[]
    height: number
    id: string
    maximumHeight: number
    maximumWidth: number
    minimumHeight: number
    minimumWidth: number
    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>
    onDidDrop: DockviewEvent<DockviewDidDropEvent>
    onDidLayoutChange: DockviewEvent<void>
    onDidLayoutFromJSON: DockviewEvent<void>
    onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>
    onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChangeEvent>
    onDidMovePanel: DockviewEvent<MovePanelEvent>
    onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>
    onDidOpenPopoutWindowFail: DockviewEvent<void>
    onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent>
    onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>
    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>
    onDidRemovePanel: DockviewEvent<IDockviewPanel>
    onDidRemovePanelFromTabGroup: DockviewEvent<DockviewTabGroupPanelChangeEvent>
    onDidRemovePopoutGroup: DockviewEvent<PopoutGroup>
    onDidTabGroupChange: DockviewEvent<DockviewTabGroupChangeEvent>
    onDidTabGroupCollapsedChange: DockviewEvent<DockviewTabGroupChangeEvent>
    onUnhandledDragOver: DockviewEvent<DockviewDndOverlayEvent>
    onWillDragGroup: DockviewEvent<GroupDragEvent>
    onWillDragPanel: DockviewEvent<TabDragEvent>
    onWillDrop: DockviewEvent<DockviewWillDropEvent>
    onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>
    onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>
    options: DockviewComponentOptions
    orientation: Orientation
    panels: IDockviewPanel[]
    removeGroup: (group: DockviewGroupPanel) => void
    size: number
    tabGroupColorPalette: TabGroupColorPalette
    totalPanels: number
    width: number

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods