Class DockviewGroupPanelModel

Hierarchy (View Summary)

DockviewCompositeDisposable
- DockviewGroupPanelModel

Implements

IDockviewGroupPanelModel

Index

Constructors

Accessors

activePanel contentContainerId contentDropTarget dropTargetContainer element hasWatermark header headerPosition isActive isContentFocused isDisposed isEmpty location locked panels renderContainer size tabGroups tabsListElement

Constructors

constructor

new DockviewGroupPanelModel(
    container: HTMLElement,
    accessor: DockviewComponent,
    id: string,
    options: GroupOptions,
    groupPanel: DockviewGroupPanel,
): DockviewGroupPanelModel
Parameters
- container: HTMLElement
- accessor: DockviewComponent
- id: string
- options: GroupOptions
- groupPanel: DockviewGroupPanel
Returns DockviewGroupPanelModel
Overrides DockviewCompositeDisposable.constructor
- Defined in dockview/dockviewGroupPanelModel.ts:585

Properties

id

id: string

`Readonly`onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<DockviewGroupActivePanelChangeEvent> = ...

`Readonly`onDidAddPanel

onDidAddPanel: DockviewEvent<DockviewGroupChangeEvent> = ...

`Readonly`onDidAddPanelToTabGroup

onDidAddPanelToTabGroup: DockviewEvent<{ panelId: string; tabGroup: ITabGroup }> = ...

`Readonly`onDidChange

onDidChange: DockviewEvent<IViewSize | undefined> = ...

`Readonly`onDidCreateTabGroup

onDidCreateTabGroup: DockviewEvent<{ tabGroup: ITabGroup }> = ...

`Readonly`onDidDestroyTabGroup

onDidDestroyTabGroup: DockviewEvent<{ tabGroup: ITabGroup }> = ...

`Readonly`onDidDrop

onDidDrop: DockviewEvent<DockviewDidDropEvent> = ...

`Readonly`onDidPanelParametersChange

onDidPanelParametersChange: DockviewEvent<Parameters> = ...

`Readonly`onDidPanelTitleChange

onDidPanelTitleChange: DockviewEvent<TitleEvent> = ...

`Readonly`onDidRemovePanel

onDidRemovePanel: DockviewEvent<DockviewGroupChangeEvent> = ...

`Readonly`onDidRemovePanelFromTabGroup

onDidRemovePanelFromTabGroup: DockviewEvent<
{ panelId: string; tabGroup: ITabGroup },
> = ...

`Readonly`onDidTabGroupChange

onDidTabGroupChange: DockviewEvent<{ tabGroup: ITabGroup }> = ...

`Readonly`onDidTabGroupCollapsedChange

onDidTabGroupCollapsedChange: DockviewEvent<{ tabGroup: ITabGroup }> = ...

`Readonly`onGroupDragStart

onGroupDragStart: DockviewEvent<GroupDragEvent> = ...

`Readonly`onMove

onMove: DockviewEvent<GroupMoveEvent> = ...

Accessors

activePanel

get activePanel(): IDockviewPanel | undefined
Returns IDockviewPanel | undefined
Implementation of IDockviewGroupPanelModel.activePanel
- Defined in dockview/dockviewGroupPanelModel.ts:409

contentContainerId

get contentContainerId(): string
DOM id of the content container (the group's tabpanel), referenced by each tab's aria-controls.

Returns string
- Defined in dockview/dockviewGroupPanelModel.ts:414

contentDropTarget

get contentDropTarget(): Droptarget
The group's content drop target; lets keyboard docking preview a drop here.

Returns Droptarget
- Defined in dockview/dockviewGroupPanelModel.ts:419

dropTargetContainer

get dropTargetContainer(): DropTargetAnchorContainer | null
Returns DropTargetAnchorContainer | null
- Defined in dockview/dockviewGroupPanelModel.ts:1333
set dropTargetContainer(value: DropTargetAnchorContainer | null): void
Parameters
- value: DropTargetAnchorContainer | null
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1329

element

get element(): HTMLElement
Returns HTMLElement
- Defined in dockview/dockviewGroupPanelModel.ts:405

hasWatermark

get hasWatermark(): boolean
Returns boolean
- Defined in dockview/dockviewGroupPanelModel.ts:453

get header(): IHeader
Returns IHeader
Implementation of IDockviewGroupPanelModel.header
- Defined in dockview/dockviewGroupPanelModel.ts:459

headerPosition

get headerPosition(): DockviewHeaderPosition
Returns DockviewHeaderPosition
Implementation of IDockviewGroupPanelModel.headerPosition
- Defined in dockview/dockviewGroupPanelModel.ts:486
set headerPosition(value: DockviewHeaderPosition): void
Parameters
- value: DockviewHeaderPosition
Returns void
Implementation of IDockviewGroupPanelModel.headerPosition
- Defined in dockview/dockviewGroupPanelModel.ts:490

isActive

get isActive(): boolean
Returns boolean
Implementation of IDockviewGroupPanelModel.isActive
- Defined in dockview/dockviewGroupPanelModel.ts:437

isContentFocused

get isContentFocused(): boolean
Returns boolean
Implementation of IDockviewGroupPanelModel.isContentFocused
- Defined in dockview/dockviewGroupPanelModel.ts:476

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from CompositeDisposable.isDisposed
- Defined in lifecycle.ts:30

isEmpty

get isEmpty(): boolean
Returns boolean
- Defined in dockview/dockviewGroupPanelModel.ts:449

location

get location(): DockviewGroupLocation
Returns DockviewGroupLocation
- Defined in dockview/dockviewGroupPanelModel.ts:535
set location(value: DockviewGroupLocation): void
Parameters
- value: DockviewGroupLocation
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:539

locked

get locked(): DockviewGroupPanelLocked
Returns DockviewGroupPanelLocked
Implementation of IDockviewGroupPanelModel.locked
- Defined in dockview/dockviewGroupPanelModel.ts:423
set locked(value: DockviewGroupPanelLocked): void
Parameters
- value: DockviewGroupPanelLocked
Returns void
Implementation of IDockviewGroupPanelModel.locked
- Defined in dockview/dockviewGroupPanelModel.ts:427

panels

get panels(): IDockviewPanel[]
Returns IDockviewPanel[]
Implementation of IDockviewGroupPanelModel.panels
- Defined in dockview/dockviewGroupPanelModel.ts:441

renderContainer

get renderContainer(): OverlayRenderContainer
Returns OverlayRenderContainer
- Defined in dockview/dockviewGroupPanelModel.ts:1322
set renderContainer(value: OverlayRenderContainer | null): void
Parameters
- value: OverlayRenderContainer | null
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1293

size

get size(): number
Returns number
Implementation of IDockviewGroupPanelModel.size
- Defined in dockview/dockviewGroupPanelModel.ts:445

tabGroups

get tabGroups(): readonly ITabGroup[]
Returns readonly ITabGroup[]
- Defined in dockview/dockviewGroupPanelModel.ts:401

tabsListElement

get tabsListElement(): HTMLElement
The scrollable tab list element (.dv-tabs-container), exposed for the multi-row wrap controller to measure rows / toggle the wrap class.

Returns HTMLElement
Implementation of IDockviewGroupPanelModel.tabsListElement
- Defined in dockview/dockviewGroupPanelModel.ts:465

Methods

addDisposables

addDisposables(...args: DockviewIDisposable[]): void
Parameters
- ...args: DockviewIDisposable[]
Returns void
Inherited from DockviewCompositeDisposable.addDisposables
- Defined in lifecycle.ts:38

addPanelToTabGroup

addPanelToTabGroup(tabGroupId: string, panelId: string, index?: number): void
Parameters
- tabGroupId: string
- panelId: string
- Optionalindex: number
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:885

attachHeaderAction

attachHeaderAction(
slot: "left" | "right" | "prefix",
element: HTMLElement | undefined,
): void
Parameters
- slot: "left" | "right" | "prefix"
- element: HTMLElement | undefined
Returns void
Implementation of IDockviewGroupPanelModel.attachHeaderAction
- Defined in dockview/dockviewGroupPanelModel.ts:1380

canDisplayContentOverlay

canDisplayContentOverlay(
event: DragEvent | PointerEvent,
position: Position,
): boolean
Whether a content drop at position is allowed: the locked rules, the shift-to-not-drop gesture, the same-component shortcut, then the canDisplayOverlay veto. The single source of truth for the content drop target (content.ts) and the compass cell gating (canDropOnGroup).
Parameters
- event: DragEvent | PointerEvent
- position: Position
Returns boolean
- Defined in dockview/dockviewGroupPanelModel.ts:1904

canDisplayOverlay

canDisplayOverlay(
    event: DragEvent | PointerEvent,
    position: Position,
    target: DockviewGroupDropLocation,
): boolean
Parameters
- event: DragEvent | PointerEvent
- position: Position
- target: DockviewGroupDropLocation
Returns boolean
Implementation of IDockviewGroupPanelModel.canDisplayOverlay
- Defined in dockview/dockviewGroupPanelModel.ts:1880

closeAllPanels

closeAllPanels(): void
Returns void
Implementation of IDockviewGroupPanelModel.closeAllPanels
- Defined in dockview/dockviewGroupPanelModel.ts:1563

closePanel

closePanel(panel: IDockviewPanel): void
Parameters
- panel: IDockviewPanel
Returns void
Implementation of IDockviewGroupPanelModel.closePanel
- Defined in dockview/dockviewGroupPanelModel.ts:1575

containsPanel

containsPanel(panel: IDockviewPanel): boolean
Parameters
- panel: IDockviewPanel
Returns boolean
Implementation of IDockviewGroupPanelModel.containsPanel
- Defined in dockview/dockviewGroupPanelModel.ts:1479

createTabGroup

createTabGroup(options?: CreateTabGroupOptions): ITabGroup
Parameters
- Optionaloptions: CreateTabGroupOptions
Returns ITabGroup
- Defined in dockview/dockviewGroupPanelModel.ts:823

dispose

dispose(): void
Returns void
Implementation of IDockviewGroupPanelModel.dispose
Overrides DockviewCompositeDisposable.dispose
- Defined in dockview/dockviewGroupPanelModel.ts:2057

dissolveTabGroup

dissolveTabGroup(tabGroupId: string): void
Parameters
- tabGroupId: string
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:866

focus

focus(): void
Returns void
Implementation of IDockviewGroupPanelModel.focus
- Defined in dockview/dockviewGroupPanelModel.ts:1491

focusActiveTab

focusActiveTab(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1289

focusContent

focusContent(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1285

getPanelForTab

getPanelForTab(element: Element): IDockviewPanel | undefined
The panel whose tab owns element (the tab itself or a descendant of it), or undefined when the target isn't a tab. The robust inverse of a tab→panel lookup, with no positional/DOM-order assumptions.
Parameters
- element: Element
Returns IDockviewPanel | undefined
- Defined in dockview/dockviewGroupPanelModel.ts:472

getTabGroupForPanel

getTabGroupForPanel(panelId: string): ITabGroup | undefined
Parameters
- panelId: string
Returns ITabGroup | undefined
- Defined in dockview/dockviewGroupPanelModel.ts:1146

getTabGroups

getTabGroups(): readonly ITabGroup[]
Returns readonly ITabGroup[]
- Defined in dockview/dockviewGroupPanelModel.ts:1125

indexOf

indexOf(panel: IDockviewPanel): number
Parameters
- panel: IDockviewPanel
Returns number
Implementation of IDockviewGroupPanelModel.indexOf
- Defined in dockview/dockviewGroupPanelModel.ts:1401

init

init(_params: PanelInitParameters): void
Parameters
- _params: PanelInitParameters
Returns void
Implementation of IDockviewGroupPanelModel.init
- Defined in dockview/dockviewGroupPanelModel.ts:1483

initialize

initialize(): void
Returns void
Implementation of IDockviewGroupPanelModel.initialize
- Defined in dockview/dockviewGroupPanelModel.ts:1357

isPanelActive

isPanelActive(panel: IDockviewPanel): boolean
Parameters
- panel: IDockviewPanel
Returns boolean
Implementation of IDockviewGroupPanelModel.isPanelActive
- Defined in dockview/dockviewGroupPanelModel.ts:1591

layout

layout(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Implementation of IDockviewGroupPanelModel.layout
- Defined in dockview/dockviewGroupPanelModel.ts:1624

movePanelBetweenGroups

movePanelBetweenGroups(
    sourcePanelId: string,
    targetTabGroupId: string,
    targetIndex?: number,
): void
Move a panel from one tab group to another.
Parameters
- sourcePanelId: string
- targetTabGroupId: string
- OptionaltargetIndex: number
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:948

movePanelWithinGroup

movePanelWithinGroup(
    tabGroupId: string,
    panelId: string,
    newIndex: number,
): void
Move a panel to a new index within its tab group. Updates both the group's panelIds order and the flat _panels array.
Parameters
- tabGroupId: string
- panelId: string
- newIndex: number
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:926

moveTabGroup

moveTabGroup(tabGroupId: string, targetIndex: number): void
Move an entire tab group to a new position in the tab bar. The group's internal panel order is preserved.
Parameters
- tabGroupId: string
- targetIndex: number
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:987

moveToNext

moveToNext(options?: { panel?: IDockviewPanel; suppressRoll?: boolean }): void
Parameters
- Optionaloptions: { panel?: IDockviewPanel; suppressRoll?: boolean }
Returns void
Implementation of IDockviewGroupPanelModel.moveToNext
- Defined in dockview/dockviewGroupPanelModel.ts:1431

moveToPrevious

moveToPrevious(
options?: { panel?: IDockviewPanel; suppressRoll?: boolean },
): void
Parameters
- Optionaloptions: { panel?: IDockviewPanel; suppressRoll?: boolean }
Returns void
Implementation of IDockviewGroupPanelModel.moveToPrevious
- Defined in dockview/dockviewGroupPanelModel.ts:1453

openPanel

openPanel(
    panel: IDockviewPanel,
    options?: {
        index?: number;
        skipSetActive?: boolean;
        skipSetGroupActive?: boolean;
    },
): void
Parameters
- panel: IDockviewPanel
- options: { index?: number; skipSetActive?: boolean; skipSetGroupActive?: boolean } = {}
Returns void
Implementation of IDockviewGroupPanelModel.openPanel
- Defined in dockview/dockviewGroupPanelModel.ts:1495

refreshTabGroupAccent

refreshTabGroupAccent(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1133

refreshWatermark

refreshWatermark(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1137

relayout

relayout(): void
Re-run the group's layout with its current dimensions. Used to propagate a header-size change (e.g. a header that grew/shrank without the group box changing) down to the content + active panel.

Returns void
Implementation of IDockviewGroupPanelModel.relayout
- Defined in dockview/dockviewGroupPanelModel.ts:1643

removeDisposable

removeDisposable(disposable: DockviewIDisposable): void
Parameters
- disposable: DockviewIDisposable
Returns void
Inherited from DockviewCompositeDisposable.removeDisposable
- Defined in lifecycle.ts:41

removePanel

removePanel(
groupItemOrId: string | IDockviewPanel,
options?: { skipSetActive?: boolean; skipSetActiveGroup?: boolean },
): IDockviewPanel
Parameters
- groupItemOrId: string | IDockviewPanel
- Optionaloptions: { skipSetActive?: boolean; skipSetActiveGroup?: boolean }
Returns IDockviewPanel
Implementation of IDockviewGroupPanelModel.removePanel
- Defined in dockview/dockviewGroupPanelModel.ts:1542

removePanelFromTabGroup

removePanelFromTabGroup(panelId: string): void
Parameters
- panelId: string
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1107

rerender

rerender(panel: IDockviewPanel): void
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1397

restoreTabGroups

restoreTabGroups(serializedGroups: SerializedTabGroup[]): void
Restore tab groups from serialized data (used by fromJSON)
Parameters
- serializedGroups: SerializedTabGroup[]
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1244

setActive

setActive(isGroupActive: boolean, force?: boolean): void
Parameters
- isGroupActive: boolean
- force: boolean = false
Returns void
Implementation of IDockviewGroupPanelModel.setActive
- Defined in dockview/dockviewGroupPanelModel.ts:1599

toJSON

toJSON(): GroupPanelViewState
Returns GroupPanelViewState
Implementation of IDockviewGroupPanelModel.toJSON
- Defined in dockview/dockviewGroupPanelModel.ts:1405

update

update(_params: PanelUpdateEvent): void
Parameters
- _params: PanelUpdateEvent
Returns void
Implementation of IDockviewGroupPanelModel.update
- Defined in dockview/dockviewGroupPanelModel.ts:1487

updateActions

updateActions(element: HTMLElement | undefined): void
Parameters
- element: HTMLElement | undefined
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1595

updateDragAndDropState

updateDragAndDropState(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:2053

updateHeaderActions

updateHeaderActions(): void
Returns void
Implementation of IDockviewGroupPanelModel.updateHeaderActions
- Defined in dockview/dockviewGroupPanelModel.ts:1376

updateTabGroups

updateTabGroups(): void
Returns void
- Defined in dockview/dockviewGroupPanelModel.ts:1129

Class DockviewGroupPanelModel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DockviewGroupPanelModel

Properties

id

ReadonlyonDidActivePanelChange

ReadonlyonDidAddPanel

ReadonlyonDidAddPanelToTabGroup

ReadonlyonDidChange

ReadonlyonDidCreateTabGroup

ReadonlyonDidDestroyTabGroup

ReadonlyonDidDrop

ReadonlyonDidPanelParametersChange

ReadonlyonDidPanelTitleChange

ReadonlyonDidRemovePanel

ReadonlyonDidRemovePanelFromTabGroup

ReadonlyonDidTabGroupChange

ReadonlyonDidTabGroupCollapsedChange

ReadonlyonGroupDragStart

ReadonlyonMove

ReadonlyonTabDragStart

ReadonlyonUnhandledDragOver

ReadonlyonWillDrop

ReadonlyonWillShowOverlay

Accessors

activePanel

Returns IDockviewPanel | undefined

contentContainerId

Returns string

contentDropTarget

Returns Droptarget

dropTargetContainer

Returns DropTargetAnchorContainer | null

Parameters

Returns void

element

Returns HTMLElement

hasWatermark

Returns boolean

header

Returns IHeader

headerPosition

Returns DockviewHeaderPosition

Parameters

Returns void

isActive

Returns boolean

isContentFocused

Returns boolean

isDisposed

Returns boolean

isEmpty

Returns boolean

location

Returns DockviewGroupLocation

Parameters

Returns void

locked

Returns DockviewGroupPanelLocked

Parameters

Returns void

panels

Returns IDockviewPanel[]

renderContainer

Returns OverlayRenderContainer

Parameters

Returns void

size

Returns number

tabGroups

Returns readonly ITabGroup[]

`Readonly`onDidActivePanelChange

`Readonly`onDidAddPanel

`Readonly`onDidAddPanelToTabGroup

`Readonly`onDidChange

`Readonly`onDidCreateTabGroup

`Readonly`onDidDestroyTabGroup

`Readonly`onDidDrop

`Readonly`onDidPanelParametersChange

`Readonly`onDidPanelTitleChange

`Readonly`onDidRemovePanel

`Readonly`onDidRemovePanelFromTabGroup

`Readonly`onDidTabGroupChange

`Readonly`onDidTabGroupCollapsedChange

`Readonly`onGroupDragStart

`Readonly`onMove

`Readonly`onTabDragStart

`Readonly`onUnhandledDragOver

`Readonly`onWillDrop

`Readonly`onWillShowOverlay