Dockview
    Preparing search index...

    Interface IDockviewComponent

    interface IDockviewComponent {
        activeGroup: DockviewGroupPanel | undefined;
        activePanel: IDockviewPanel | undefined;
        canRedo: boolean;
        canUndo: boolean;
        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>;
        onDidChangeHistory: DockviewEvent<LayoutHistoryChangeEvent>;
        onDidCreateTabGroup: DockviewEvent<DockviewTabGroupChangeEvent>;
        onDidDestroyTabGroup: DockviewEvent<DockviewTabGroupChangeEvent>;
        onDidDrop: DockviewEvent<DockviewDidDropEvent>;
        onDidEdgeGroupAutoHideChange: DockviewEvent<DockviewGroupPanel>;
        onDidLayoutChange: DockviewEvent<void>;
        onDidLayoutFromJSON: DockviewEvent<void>;
        onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>;
        onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChangeEvent>;
        onDidMovePanel: DockviewEvent<MovePanelEvent>;
        onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
        onDidOpenPopoutWindowFail: DockviewEvent<void>;
        onDidPanelPinnedChange: DockviewEvent<DockviewPanelPinnedChangeEvent>;
        onDidPopoutGroupPositionChange: DockviewEvent<
            PopoutGroupChangePositionEvent,
        >;
        onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>;
        onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>;
        onDidRemovePanel: DockviewEvent<IDockviewPanel>;
        onDidRemovePanelFromTabGroup: DockviewEvent<
            DockviewTabGroupPanelChangeEvent,
        >;
        onDidRemovePopoutGroup: DockviewEvent<PopoutGroup>;
        onDidSnapFloat: DockviewEvent<SmartGuidesSnapEvent>;
        onDidSnapTogether: DockviewEvent<SmartGuidesSnapTogetherEvent>;
        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;
        overlayRoot: HTMLElement;
        panels: IDockviewPanel[];
        popoutRestorationPromise: Promise<void>;
        removeGroup: (group: DockviewGroupPanel) => void;
        size: number;
        smartGuidesEnabled: boolean;
        tabGroupColorPalette: TabGroupColorPalette;
        totalPanels: number;
        width: number;
        activateNext(options?: MovementOptions): void;
        activatePrevious(options?: MovementOptions): void;
        addEdgeGroup(
            position: EdgeGroupPosition,
            options: AddEdgeGroupOptions,
        ): 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;
        autoHideEdgeGroup(position: EdgeGroupPosition): void;
        clear(): void;
        clearHistory(): 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;
        getEdgeGroupExpandedSize(position: EdgeGroupPosition): number;
        getEdgeGroupPanel(
            position: EdgeGroupPosition,
        ): DockviewGroupPanel | undefined;
        getPanel(id: string): DockviewGroupPanel | undefined;
        getPopouts(): PopoutGroup[];
        hasMaximizedGroup(): boolean;
        isEdgeGroupAutoHide(group: DockviewGroupPanel): 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;
        peekEdgeGroup(position: EdgeGroupPosition, peek: boolean): void;
        pinEdgeGroup(position: EdgeGroupPosition): void;
        redo(): void;
        removeEdgeGroup(position: EdgeGroupPosition): void;
        removePanel(panel: IDockviewPanel): void;
        revealEdgeGroupWithData(
            position: EdgeGroupPosition,
            data: { groupId: string; panelId?: string | null },
            options?: { autoHide?: boolean },
        ): void;
        setActivePanel(panel: IDockviewPanel): void;
        setEdgeGroupAutoHide(
            group: DockviewGroupPanel,
            value: boolean | undefined,
        ): void;
        setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
        setPanelPinned(panel: DockviewPanel, pinned: boolean): void;
        setSmartGuidesEnabled(enabled: boolean): void;
        setVisible(panel: DockviewGroupPanel, visible: boolean): void;
        toJSON(): SerializedDockview;
        undo(): void;
        updateOptions(options: DockviewOptions): void;
        updateSmartGuidesOptions(options: Partial<SmartGuidesOptions>): void;
        withOrigin<T>(origin: DockviewOrigin, func: () => T): T;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

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

    Methods

    activateNext activatePrevious addEdgeGroup addFloatingGroup addGroup addPanel addPopoutGroup adjacentGroupInDirection autoHideEdgeGroup clear clearHistory closeAllGroups createWatermarkComponent currentOrigin dispose exitMaximizedGroup focus fromJSON getEdgeGroup getEdgeGroupExpandedSize getEdgeGroupPanel getPanel getPopouts hasMaximizedGroup isEdgeGroupAutoHide isEdgeGroupVisible isMaximizedGroup isVisible layout maximizeGroup moveGroup moveGroupOrPanel peekEdgeGroup pinEdgeGroup redo removeEdgeGroup removePanel revealEdgeGroupWithData setActivePanel setEdgeGroupAutoHide setEdgeGroupVisible setPanelPinned setSmartGuidesEnabled setVisible toJSON undo updateOptions updateSmartGuidesOptions withOrigin

    Properties

    activeGroup: DockviewGroupPanel | undefined
    activePanel: IDockviewPanel | undefined
    canRedo: boolean
    canUndo: boolean
    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>
    onDidChangeHistory: DockviewEvent<LayoutHistoryChangeEvent>
    onDidCreateTabGroup: DockviewEvent<DockviewTabGroupChangeEvent>
    onDidDestroyTabGroup: DockviewEvent<DockviewTabGroupChangeEvent>
    onDidDrop: DockviewEvent<DockviewDidDropEvent>
    onDidEdgeGroupAutoHideChange: DockviewEvent<DockviewGroupPanel>
    onDidLayoutChange: DockviewEvent<void>
    onDidLayoutFromJSON: DockviewEvent<void>
    onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>
    onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChangeEvent>
    onDidMovePanel: DockviewEvent<MovePanelEvent>
    onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>
    onDidOpenPopoutWindowFail: DockviewEvent<void>
    onDidPanelPinnedChange: DockviewEvent<DockviewPanelPinnedChangeEvent>
    onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent>
    onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>
    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>
    onDidRemovePanel: DockviewEvent<IDockviewPanel>
    onDidRemovePanelFromTabGroup: DockviewEvent<DockviewTabGroupPanelChangeEvent>
    onDidRemovePopoutGroup: DockviewEvent<PopoutGroup>
    onDidSnapFloat: DockviewEvent<SmartGuidesSnapEvent>
    onDidSnapTogether: DockviewEvent<SmartGuidesSnapTogetherEvent>
    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
    overlayRoot: HTMLElement
    panels: IDockviewPanel[]
    popoutRestorationPromise: Promise<void>
    removeGroup: (group: DockviewGroupPanel) => void
    size: number
    smartGuidesEnabled: boolean
    tabGroupColorPalette: TabGroupColorPalette
    totalPanels: number
    width: number

    Methods

    • Parameters

      • position: EdgeGroupPosition
      • data: { groupId: string; panelId?: string | null }
      • Optionaloptions: { autoHide?: boolean }

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    activeGroupactivePanelcanRedocanUndodoSetGroupActiveelementgetGroupPanelgroupsheightidmaximumHeightmaximumWidthminimumHeightminimumWidthonDidActiveGroupChangeonDidActivePanelChangeonDidAddGrouponDidAddPanelonDidAddPanelToTabGrouponDidAddPopoutGrouponDidChangeHistoryonDidCreateTabGrouponDidDestroyTabGrouponDidDroponDidEdgeGroupAutoHideChangeonDidLayoutChangeonDidLayoutFromJSONonDidMaximizedChangeonDidMaximizedGroupChangeonDidMovePanelonDidMutateLayoutonDidOpenPopoutWindowFailonDidPanelPinnedChangeonDidPopoutGroupPositionChangeonDidPopoutGroupSizeChangeonDidRemoveGrouponDidRemovePanelonDidRemovePanelFromTabGrouponDidRemovePopoutGrouponDidSnapFloatonDidSnapTogetheronDidTabGroupChangeonDidTabGroupCollapsedChangeonUnhandledDragOveronWillDragGrouponWillDragPanelonWillDroponWillMutateLayoutonWillShowOverlayoptionsorientationoverlayRootpanelspopoutRestorationPromiseremoveGroupsizesmartGuidesEnabledtabGroupColorPalettetotalPanelswidth
    Methods