Maximized Groups

This section described how to maxmimize groups.

Options

exitMaximizedGroup	exitMaximizedGroup(): void
hasMaximizedGroup	hasMaximizedGroup(): boolean
maximizeGroup	maximizeGroup(panel: IDockviewPanel): void

const api: DockviewApi;

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

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

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

// is there a maximized group
const result: boolean = 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.isMaxmized();

// exit only if this group is maximzied (if another group is maxmized this has no affect)
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.

Live Examples