WorkspaceContainer

Official

Workspace container.

Import:

import { WorkspaceContainer } from 'obsidian';

Signature:

export class WorkspaceContainer extends WorkspaceSplit

Extends: WorkspaceSplit

Constructor

new WorkspaceContainer(workspace: Workspace, direction: string, id?: string | undefined)

Constructor.

To get the constructor instance, use getWorkspaceSplitConstructor from obsidian-typings/implementations.

Property	Type	Description
direction	'horizontal' \| 'vertical'	The layout direction of the split. (Inherited from WorkspaceSplit)
doc	Document
isResizing	boolean	Whether a resize drag is currently in progress. (Inherited from WorkspaceSplit)
originalSizes	null \| number[]	The child sizes captured at the start of a resize, or `null` when not resizing. (Inherited from WorkspaceSplit)
parent	WorkspaceParent	The parent of the split. (Inherited from WorkspaceSplit)
resizeStartPos	null \| Point	The pointer position captured at the start of a resize, or `null` when not resizing. (Inherited from WorkspaceSplit)
win	Window

Method	Returns	Description
finishResize()	void	Finishes the current resize, persisting the new child sizes. (Inherited from WorkspaceSplit)
focus()	void	Focuses the container's window (restoring it first if minimized, on desktop).
getElSize(el)	number \| undefined	Gets the size of an element along the split's direction. (Inherited from WorkspaceSplit)
onChildResizeStart(child, event)	void	Handles the start of a resize initiated by a child. (Inherited from WorkspaceSplit)
onFocus()	void	Handles the container's window gaining focus, updating the active leaf.
onProximityResize(event)	void	Handles a proximity-based resize pointer event. (Inherited from WorkspaceSplit)
resizeItemsByDiff(items, diff, sign)	number	Resizes the given items by a pixel difference. (Inherited from WorkspaceSplit)
setDirection(direction)	void	Sets the layout direction of the split. (Inherited from WorkspaceSplit)
setElSize(el, size)	void	Sets the size of an element along the split's direction. (Inherited from WorkspaceSplit)
unsetElSize(el)	void	Clears the explicit size of an element. (Inherited from WorkspaceSplit)

Links to this page: