Class: DockManager
dg.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
constructor
• new DockManager(dart)
Parameters
| Name | Type |
|---|---|
dart | any |
Defined in
Properties
dart
• dart: any
Defined in
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
Defined in
element
• get element(): HTMLDivElement
Returns
HTMLDivElement
Defined in
rootNode
• get rootNode(): DockNode
Returns
Defined in
Methods
close
▸ close(object): void
Undocks the element.
Parameters
| Name | Type | Description |
|---|---|---|
object | HTMLElement | DockNode | Element to undock |
Returns
void
Defined in
dock
▸ dock(element, dockType?, refNode?, title?, ratio?): DockNode
Docks the element relative to the reference node.
Parameters
| Name | 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
Defined in
findNode
▸ findNode(element): undefined | DockNode
Finds the node of an element.
Parameters
| Name | Type | Description |
|---|---|---|
element | HTMLElement | Element to find the node for. |
Returns
undefined | DockNode
if node is found, undefined otherwise.