Constructor
new EdgeDocker(options)
- Description:
- Source:
Parameters:
Members
(static, readonly) MODE
- Description:
- The supported modes of EdgeDocker
- Source:
Properties:
| Name |
Type |
Description |
MAXIMIZED |
|
|
MINIMIZED |
|
|
LEFT |
|
|
RIGHT |
|
|
BOTTOM |
|
|
FLOAT |
|
|
EMBEDDED |
|
|
The supported modes of EdgeDocker
Methods
getComponentArea() → {HTMLElement}
- Description:
- Fetch the component area where DOM elements can be added to this EdgeDocker
- Source:
Returns:
-
Type
-
HTMLElement
loadMode(fallback)
- Description:
- Load the saved mode, or use fallback if no saved mode
- Source:
Parameters:
| Name |
Type |
Description |
fallback |
EdgeDocker.MODE
|
The mode to use if none is saved. |
saveMode()
- Description:
- Source:
setBounds(x, y, width, height, doSaveopt)
- Description:
- Sets the bounds of this EdgeDocker
- Source:
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
x |
Number
|
|
|
|
y |
Number
|
|
|
|
width |
Number
|
|
|
|
height |
Number
|
|
|
|
doSave |
boolean
|
<optional>
|
true
|
Determines if the bounds should be saved or not |
setMode(mode, doLoadopt)
- Description:
- Sets the current dock mode of this EdgeDocker
- Source:
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
mode |
EdgeDocker.MODE
|
|
|
|
doLoad |
boolean
|
<optional>
|
true
|
Determines if this setMode should load bounds from storage or not. |
setPosition(x, y)
- Description:
- Sets the position of this EdgeDocker, Ignored if not in FLOAT mode
- Source:
Parameters:
| Name |
Type |
Description |
x |
Number
|
|
y |
Number
|
|
Type Definitions
config
- Source:
Properties:
| Name |
Type |
Attributes |
Default |
Description |
parent |
Element
|
<optional>
|
html
|
The parent to attach the docker too. |
mode |
EdgeDocker.MODE
|
<optional>
|
RIGHT
|
The edge to attach too. |
Type: