Interface IDockviewComponent

interface IDockviewComponent {
    activeGroup: undefined | DockviewGroupPanel;
    activePanel: undefined | IDockviewPanel;
    doSetGroupActive: ((group, skipFocus?) => void);
    element: HTMLElement;
    getGroupPanel: ((id) => undefined | IDockviewPanel);
    groups: DockviewGroupPanel[];
    height: number;
    id: string;
    maximumHeight: number;
    maximumWidth: number;
    minimumHeight: number;
    minimumWidth: number;
    onDidActiveGroupChange: DockviewEvent<undefined | DockviewGroupPanel>;
    onDidActivePanelChange: DockviewEvent<undefined | IDockviewPanel>;
    onDidAddGroup: DockviewEvent<DockviewGroupPanel>;
    onDidAddPanel: DockviewEvent<IDockviewPanel>;
    onDidDrop: DockviewEvent<DockviewDidDropEvent>;
    onDidLayoutChange: DockviewEvent<void>;
    onDidLayoutFromJSON: DockviewEvent<void>;
    onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>;
    onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChanged>;
    onDidMovePanel: DockviewEvent<MovePanelEvent>;
    onDidOpenPopoutWindowFail: DockviewEvent<void>;
    onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent>;
    onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>;
    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>;
    onDidRemovePanel: DockviewEvent<IDockviewPanel>;
    onUnhandledDragOverEvent: DockviewEvent<DockviewDndOverlayEvent>;
    onWillDragGroup: DockviewEvent<GroupDragEvent>;
    onWillDragPanel: DockviewEvent<TabDragEvent>;
    onWillDrop: DockviewEvent<DockviewWillDropEvent>;
    onWillShowOverlay: DockviewEvent<WillShowOverlayLocationEvent>;
    options: DockviewComponentOptions;
    orientation: Orientation;
    panels: IDockviewPanel[];
    removeGroup: ((group) => void);
    size: number;
    totalPanels: number;
    width: number;
    addFloatingGroup(item, options?): void;
    addGroup(options?): DockviewGroupPanel;
    addPanel<T>(options): IDockviewPanel;
    addPopoutGroup(item, options?): Promise<boolean>;
    clear(): void;
    closeAllGroups(): void;
    createWatermarkComponent(): IWatermarkRenderer;
    dispose(): void;
    exitMaximizedGroup(): void;
    focus(): void;
    fromJSON(data): void;
    getPanel(id): undefined | DockviewGroupPanel;
    hasMaximizedGroup(): boolean;
    isMaximizedGroup(panel): boolean;
    isVisible(panel): boolean;
    layout(width, height, force?): void;
    maximizeGroup(panel): void;
    moveGroup(options): void;
    moveGroupOrPanel(options): void;
    moveToNext(options?): void;
    moveToPrevious(options?): void;
    removePanel(panel): void;
    setActivePanel(panel): void;
    setVisible(panel, visible): void;
    toJSON(): SerializedDockview;
    updateOptions(options): void;
}

Hierarchy (view full)

Implemented by

Properties

activeGroup activePanel doSetGroupActive element getGroupPanel groups height id maximumHeight maximumWidth minimumHeight minimumWidth onDidActiveGroupChange onDidActivePanelChange onDidAddGroup onDidAddPanel onDidDrop onDidLayoutChange onDidLayoutFromJSON onDidMaximizedChange onDidMaximizedGroupChange onDidMovePanel onDidOpenPopoutWindowFail onDidPopoutGroupPositionChange onDidPopoutGroupSizeChange onDidRemoveGroup onDidRemovePanel onUnhandledDragOverEvent onWillDragGroup onWillDragPanel onWillDrop onWillShowOverlay options orientation panels removeGroup size totalPanels width

Methods

addFloatingGroup addGroup addPanel addPopoutGroup clear closeAllGroups createWatermarkComponent dispose exitMaximizedGroup focus fromJSON getPanel hasMaximizedGroup isMaximizedGroup isVisible layout maximizeGroup moveGroup moveGroupOrPanel moveToNext moveToPrevious removePanel setActivePanel setVisible toJSON updateOptions

Properties

Readonly activeGroup

activeGroup: undefined | DockviewGroupPanel

Readonly activePanel

activePanel: undefined | IDockviewPanel

doSetGroupActive

doSetGroupActive: ((group, skipFocus?) => void)

Type declaration

    • (group, skipFocus?): void

    • Parameters

      Returns void

Readonly element

element: HTMLElement

getGroupPanel

getGroupPanel: ((id) => undefined | IDockviewPanel)

Type declaration

Readonly groups

groups: DockviewGroupPanel[]

Readonly height

height: number

Readonly id

id: string

Readonly maximumHeight

maximumHeight: number

Readonly maximumWidth

maximumWidth: number

Readonly minimumHeight

minimumHeight: number

Readonly minimumWidth

minimumWidth: number

Readonly onDidActiveGroupChange

onDidActiveGroupChange: DockviewEvent<undefined | DockviewGroupPanel>

Readonly onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<undefined | IDockviewPanel>

Readonly onDidAddGroup

onDidAddGroup: DockviewEvent<DockviewGroupPanel>

Readonly onDidAddPanel

onDidAddPanel: DockviewEvent<IDockviewPanel>

Readonly onDidDrop

onDidDrop: DockviewEvent<DockviewDidDropEvent>

Readonly onDidLayoutChange

onDidLayoutChange: DockviewEvent<void>

Readonly onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void>

Readonly onDidMaximizedChange

onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>>

Readonly onDidMaximizedGroupChange

onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChanged>

Readonly onDidMovePanel

onDidMovePanel: DockviewEvent<MovePanelEvent>

Readonly onDidOpenPopoutWindowFail

onDidOpenPopoutWindowFail: DockviewEvent<void>

Readonly onDidPopoutGroupPositionChange

onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent>

Readonly onDidPopoutGroupSizeChange

onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent>

Readonly onDidRemoveGroup

onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>

Readonly onDidRemovePanel

onDidRemovePanel: DockviewEvent<IDockviewPanel>

Readonly onUnhandledDragOverEvent

onUnhandledDragOverEvent: DockviewEvent<DockviewDndOverlayEvent>

Readonly onWillDragGroup

onWillDragGroup: DockviewEvent<GroupDragEvent>

Readonly onWillDragPanel

onWillDragPanel: DockviewEvent<TabDragEvent>

Readonly onWillDrop

onWillDrop: DockviewEvent<DockviewWillDropEvent>

Readonly onWillShowOverlay

onWillShowOverlay: DockviewEvent<WillShowOverlayLocationEvent>

Readonly options

options: DockviewComponentOptions

Readonly orientation

orientation: Orientation

Readonly panels

panels: IDockviewPanel[]

removeGroup

removeGroup: ((group) => void)

Type declaration

Readonly size

size: number

Readonly totalPanels

totalPanels: number

Readonly width

width: number

Methods

addFloatingGroup

addGroup

addPanel

addPopoutGroup

  • addPopoutGroup(item, options?): Promise<boolean>

  • Parameters

    • item: IDockviewPanel | DockviewGroupPanel
    • Optional options: {
          onDidOpen?: ((event) => void);
          onWillClose?: ((event) => void);
          popoutUrl?: string;
          position?: Box;
      }
      • Optional onDidOpen?: ((event) => void)
          • (event): void

          • Parameters

            • event: {
                  id: string;
                  window: Window;
              }
              • id: string
              • window: Window

            Returns void

      • Optional onWillClose?: ((event) => void)
          • (event): void

          • Parameters

            • event: {
                  id: string;
                  window: Window;
              }
              • id: string
              • window: Window

            Returns void

      • Optional popoutUrl?: string
      • Optional position?: Box

    Returns Promise<boolean>

clear

closeAllGroups

createWatermarkComponent

dispose

exitMaximizedGroup

focus

fromJSON

getPanel

hasMaximizedGroup

isMaximizedGroup

isVisible

layout

maximizeGroup

moveGroup

moveGroupOrPanel

moveToNext

moveToPrevious

removePanel

setActivePanel

setVisible

toJSON

updateOptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc