DockManager
Defined in: src/docking.ts:102
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):DockManager
Defined in: src/docking.ts:105
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
DockManager
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | src/docking.ts:103 |
Accessors
documentContainer
Get Signature
get documentContainer():
DockContainer
Defined in: src/docking.ts:122
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
element
Get Signature
get element():
HTMLDivElement
Defined in: src/docking.ts:109
Returns
HTMLDivElement
onClosed
Get Signature
get onClosed():
Observable<HTMLElement>
Defined in: src/docking.ts:161
Returns
Observable<HTMLElement>
rootNode
Get Signature
get rootNode():
DockNode
Defined in: src/docking.ts:113
Returns
Methods
close()
close(
object):void
Defined in: src/docking.ts:143
Undocks the element.
Parameters
| Parameter | Type | Description |
|---|---|---|
object | HTMLElement | DockNode | Element to undock |
Returns
void
dock()
dock(
element,dockType?,refNode?,title?,ratio?):DockNode
Defined in: src/docking.ts:135
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 |
refNode | DockNode | null | 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
findNode()
findNode(
element):DockNode|undefined
Defined in: src/docking.ts:157
Finds the node of an element.
Parameters
| Parameter | Type | Description |
|---|---|---|
element | HTMLElement | Element to find the node for. |
Returns
DockNode | undefined
if node is found, undefined otherwise.