Skip to main content

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
location
readonly location: DockviewGroupLocation
onDidActiveChange
readonly onDidActiveChange: Event<ActiveEvent>
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
exitMaximized
exitMaximized(): void
getParameters
getParameters<T extends Parameters = Parameters>(): T
getWindow
If you require the Window object
getWindow(): Window
isMaximized
isMaximized(): boolean
maximize
maximize(): void
moveTo
moveTo(options: {
group?: DockviewGroupPanel,
position?: 'right' | 'bottom' | 'top' | 'left' | 'center'
}): void
setActive
setActive(): void
setConstraints
setConstraints(value: GridConstraintChangeEvent2): void
setSize
setSize(event: SizeEvent): void
setVisible
setVisible(isVisible: boolean): void
updateParameters
updateParameters(parameters: Parameters): void