Maximized groups

Maximizing a group temporarily expands it to fill the entire Dockview viewport, hiding the other groups until you restore it, handy for focusing on a single panel without changing the underlying layout.

Options

onDidMaximizedGroupChange	onDidMaximizedGroupChange: Event<DockviewMaximizedGroupChangeEvent>
exitMaximizedGroup	exitMaximizedGroup(): void
hasMaximizedGroup	hasMaximizedGroup(): boolean
maximizeGroup	maximizeGroup(panel: IDockviewPanel): void

const api: DockviewApi;

// maximize a specified group
api.maximizeGroup(group);

// check whether a specific group is maximized
const result: boolean = api.isMaximizedGroup(group);

// if there is any maximized group exit the maximized state
api.exitMaximizedGroup();

// is there a maximized group
const result: boolean = api.hasMaximizedGroup();

Panel API

exitMaximized	exitMaximized(): void
isMaximized	isMaximized(): boolean
maximize	maximize(): void

const api: DockviewPanelApi;

// maximize the group
api.maximize();

// is this group maximized (if another group is maximized this method will still return false)
const result: boolean = api.isMaximized();

// exit only if this group is maximized (if another group is maximized this has no effect)
api.exitMaximized();

api.<maximize|isMaximized|exitMaximized> is equivalent to api.group.api.<maximize|isMaximized|exitMaximized>. The methods exist on the panel api object for convenience.

See also

• Floating groups: float a group above the grid
• Popout windows: move a group into a separate browser window