Group API

Use the group API sparingly. As you move panels, groups change and if you don't track this correctly you may encounter unexpected behaviours. You should be able to achieve most things directly through the panel API.

component	The id of the component renderer readonly component: string
height	The panel height in pixels readonly height: number
id	The id of the panel that would have been assigned when the panel was created readonly id: string
isActive	Whether the panel is the actively selected panel readonly isActive: boolean
isFocused	Whether the panel holds the current focus readonly isFocused: boolean
isVisible	Whether the panel is visible readonly isVisible: boolean
onDidActiveChange	readonly onDidActiveChange: Event<ActiveEvent>
onDidDimensionsChange	readonly onDidDimensionsChange: Event<PanelDimensionChangeEvent>
onDidFocusChange	readonly onDidFocusChange: Event<FocusEvent>
onDidParametersChange	readonly onDidParametersChange: Event<Parameters>
onDidVisibilityChange	readonly onDidVisibilityChange: Event<VisibilityEvent>
onWillFocus	readonly onWillFocus: Event<WillFocusEvent>
width	The panel width in pixels readonly width: number
getParameters	getParameters(): T
setActive	setActive(): void
setVisible	setVisible(isVisible: boolean): void
updateParameters	updateParameters(parameters: Parameters): void
component	The id of the component renderer readonly component: string
height	The panel height in pixels readonly height: number
id	The id of the panel that would have been assigned when the panel was created readonly id: string
isActive	Whether the panel is the actively selected panel readonly isActive: boolean
isFocused	Whether the panel holds the current focus readonly isFocused: boolean
isVisible	Whether the panel is visible readonly isVisible: boolean
onDidActiveChange	readonly onDidActiveChange: Event<ActiveEvent>
onDidConstraintsChange	readonly onDidConstraintsChange: Event<GridConstraintChangeEvent>
onDidDimensionsChange	readonly onDidDimensionsChange: Event<PanelDimensionChangeEvent>
onDidFocusChange	readonly onDidFocusChange: Event<FocusEvent>
onDidParametersChange	readonly onDidParametersChange: Event<Parameters>
onDidVisibilityChange	readonly onDidVisibilityChange: Event<VisibilityEvent>
onWillFocus	readonly onWillFocus: Event<WillFocusEvent>
width	The panel width in pixels readonly width: number
getParameters	getParameters(): T
setActive	setActive(): void
setConstraints	setConstraints(value: GridConstraintChangeEvent2): void
setSize	setSize(event: SizeEvent): void
setVisible	setVisible(isVisible: boolean): void
updateParameters	updateParameters(parameters: Parameters): void
component	The id of the component renderer readonly component: string
height	The panel height in pixels readonly height: number
id	The id of the panel that would have been assigned when the panel was created readonly id: string
isActive	Whether the panel is the actively selected panel readonly isActive: boolean
isFocused	Whether the panel holds the current focus readonly isFocused: boolean
isVisible	Whether the panel is visible readonly isVisible: boolean
location	readonly location: DockviewGroupLocation
locked	Whether this group is locked against drop interactions. - true: panels cannot be dropped into the group (center / tabs), but the group can still be split from its edges. - 'no-drop-target': all drop zones are disabled for this group. locked: DockviewGroupPanelLocked
onDidActiveChange	readonly onDidActiveChange: Event<ActiveEvent>
onDidActivePanelChange	Fires when the active panel *within this group* changes. Scoped to the group, in contrast to the component-level DockviewApi.onDidActivePanelChange (which tracks the active panel across the whole dockview). Both carry an DockviewOrigin reporting whether the change came from a user gesture or an API call. readonly onDidActivePanelChange: Event<DockviewGroupActivePanelChangeEvent>
onDidCollapsedChange	Fired when an edge group's collapsed state changes. Never fires for non-edge groups. readonly onDidCollapsedChange: Event<DockviewGroupPanelCollapsedChangeEvent>
onDidConstraintsChange	readonly onDidConstraintsChange: Event<GridConstraintChangeEvent>
onDidDimensionsChange	readonly onDidDimensionsChange: Event<PanelDimensionChangeEvent>
onDidFocusChange	readonly onDidFocusChange: Event<FocusEvent>
onDidLocationChange	readonly onDidLocationChange: Event<DockviewGroupPanelFloatingChangeEvent>
onDidParametersChange	readonly onDidParametersChange: Event<Parameters>
onDidVisibilityChange	readonly onDidVisibilityChange: Event<VisibilityEvent>
onWillFocus	readonly onWillFocus: Event<WillFocusEvent>
width	The panel width in pixels readonly width: number
close	close(): void
collapse	Collapse this group (edge groups only). No-op for non-edge groups. collapse(): void
exitMaximized	exitMaximized(): void
expand	Expand this group (edge groups only). No-op for non-edge groups. expand(): void
getHeaderPosition	getHeaderPosition(): DockviewHeaderPosition
getParameters	getParameters(): T
getWindow	If you require the Window object getWindow(): Window
isCollapsed	Returns true if this edge group is currently collapsed. Always returns false for non-edge groups. isCollapsed(): boolean
isMaximized	isMaximized(): boolean
maximize	maximize(): void
moveTo	moveTo(options: DockviewGroupMoveParams): void
setActive	setActive(): void
setConstraints	setConstraints(value: GridConstraintChangeEvent2): void
setHeaderPosition	setHeaderPosition(position: DockviewHeaderPosition): void
setSize	setSize(event: SizeEvent): void
setVisible	setVisible(isVisible: boolean): void
updateParameters	updateParameters(parameters: Parameters): void