Interface IDockviewGroupPanelModel

interface IDockviewGroupPanelModel {
    activePanel: undefined | IDockviewPanel;
    header: IHeader;
    id: string;
    isActive: boolean;
    isContentFocused: boolean;
    isPanelActive: ((panel) => boolean);
    locked: DockviewGroupPanelLocked;
    onDidActivePanelChange: DockviewEvent<DockviewGroupChangeEvent>;
    onDidAddPanel: DockviewEvent<DockviewGroupChangeEvent>;
    onDidDrop: DockviewEvent<DockviewDidDropEvent>;
    onDidRemovePanel: DockviewEvent<DockviewGroupChangeEvent>;
    onMove: DockviewEvent<GroupMoveEvent>;
    onWillDrop: DockviewEvent<DockviewWillDropEvent>;
    panels: IDockviewPanel[];
    removePanel: ((panelOrId) => IDockviewPanel);
    size: number;
    canDisplayOverlay(event, position, target): boolean;
    closeAllPanels(): void;
    closePanel(panel): void;
    containsPanel(panel): boolean;
    dispose(): void;
    focus(): void;
    indexOf(panel): number;
    init(params): void;
    initialize(): void;
    layout(width, height): void;
    moveToNext(options?): void;
    moveToPrevious(options?): void;
    openPanel(panel, options?): void;
    setActive(isActive): void;
    toJSON(): object;
    update(event): void;
}

Hierarchy (view full)

  • IPanel
    • IDockviewGroupPanelModel

Implemented by

Properties

activePanel header id isActive isContentFocused isPanelActive locked onDidActivePanelChange onDidAddPanel onDidDrop onDidRemovePanel onMove onWillDrop panels removePanel size

Methods

canDisplayOverlay closeAllPanels closePanel containsPanel dispose focus indexOf init initialize layout moveToNext moveToPrevious openPanel setActive toJSON update

Properties

Readonly activePanel

activePanel: undefined | IDockviewPanel

Readonly header

header: IHeader

Readonly id

id: string

Readonly isActive

isActive: boolean

Readonly isContentFocused

isContentFocused: boolean

isPanelActive

isPanelActive: ((panel) => boolean)

Type declaration

locked

locked: DockviewGroupPanelLocked

Readonly onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<DockviewGroupChangeEvent>

Readonly onDidAddPanel

onDidAddPanel: DockviewEvent<DockviewGroupChangeEvent>

Readonly onDidDrop

onDidDrop: DockviewEvent<DockviewDidDropEvent>

Readonly onDidRemovePanel

onDidRemovePanel: DockviewEvent<DockviewGroupChangeEvent>

Readonly onMove

onMove: DockviewEvent<GroupMoveEvent>

Readonly onWillDrop

onWillDrop: DockviewEvent<DockviewWillDropEvent>

Readonly panels

panels: IDockviewPanel[]

removePanel

removePanel: ((panelOrId) => IDockviewPanel)

Type declaration

Readonly size

size: number

Methods

canDisplayOverlay

closeAllPanels

closePanel

containsPanel

dispose

focus

indexOf

init

initialize

layout

moveToNext

moveToPrevious

openPanel

  • openPanel(panel, options?): void

  • Parameters

    • panel: IDockviewPanel
    • Optional options: {
          index?: number;
          skipFocus?: boolean;
          skipSetGroupActive?: boolean;
          skipSetPanelActive?: boolean;
      }
      • Optional index?: number
      • Optional skipFocus?: boolean
      • Optional skipSetGroupActive?: boolean
      • Optional skipSetPanelActive?: boolean

    Returns void

setActive

toJSON

update

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc