DockManager

Window docking manager.

Dock manager manages all the dock panels in a hierarchy, similar to visual studio. It owns an HTML Div element inside which all panels are docked. Initially, the dock manager takes up the central space and acts as the root node.

Samples: https://public.datagrok.ai/js/samples/ui/docking/docking Learn more: https://github.com/coderespawn/dock-spawn for details.

Constructors

new DockManager()

new DockManager(dart): DockManager

Parameters

Parameter	Type
dart	any

Returns

DockManager

Source

src/docking.ts:101

Properties

Property	Type
dart	any

Accessors

documentContainer

get documentContainer(): DockContainer

The document view is then central area of the dock layout hierarchy. This is where more important panels are placed (e.g. the text editor in an IDE, 3D view in a modeling package, etc.)

Returns

DockContainer

Source

src/docking.ts:118

---

element

get element(): HTMLDivElement

Returns

HTMLDivElement

Source

src/docking.ts:105

---

onClosed

get onClosed(): Observable<HTMLElement>

Returns

Observable<HTMLElement>

Source

src/docking.ts:157

---

rootNode

get rootNode(): DockNode

Returns

DockNode

Source

src/docking.ts:109

Methods

close()

close(object): void

Undocks the element.

Parameters

Parameter	Type	Description
object	HTMLElement | DockNode	Element to undock

Returns

void

Source

src/docking.ts:139

---

dock()

dock(element, dockType, refNode, title?, ratio?): DockNode

Docks the element relative to the reference node.

Parameters

Parameter	Type	Default value	Description
element	HTMLElement | Viewer<any>	undefined	Element to dock
dockType	"fill" | "left" | "right" | "up" | "down"	DG.DOCK_TYPE.LEFT	Dock type (left | right | top | down | fill).
refNode	null | DockNode	null	reference node
title?	string	undefined	Name of the resulting column. Default value is agg(colName).
ratio?	number	0.5	Ratio of the area to take (relative to the reference node).

Returns

DockNode

Source

src/docking.ts:131

---

findNode()

findNode(element): undefined | DockNode

Finds the node of an element.

Parameters

Parameter	Type	Description
element	HTMLElement	Element to find the node for.

Returns

undefined | DockNode

if node is found, undefined otherwise.

Source

src/docking.ts:153