|
Name
|
Type
|
Default
|
|
width
|
Number/String
|
auto
|
Sets the docking's width.
Code examples
Initialize a jqxDocking with the width property specified.
$('#docking').jqxDocking({width:"200px"});
|
|
height
|
Number/String
|
auto
|
Sets the docking's height.
Code examples
Initialize a jqxDocking with the height property specified.
$('#docking').jqxDocking({height:"400px"});
|
|
disabled
|
Boolean
|
false
|
Gets or sets whether the docking is disabled.
Code examples
Initialize a jqxDocking with the disabled property specified.
$('#docking').jqxDocking({ disabled:true });
|
|
orientation
|
String
|
horizontal
|
Gets or sets docking's orientation. This property is setting whether the panels are going to be side by side or below each other.
Code examples
Initialize a jqxDocking with the orientation property specified.
$('#docking').jqxDocking({ orientation: 'vertical' });
|
|
mode
|
String
|
default
|
Gets or sets docking's mode. There are three modes - default, docked, floating. In the default mode the user can
drop every window inside any docking panel or outside the docking panels. In the docked mode the user can drop every window just
into the docking panels and in the floating mode the user can drop any window just outside of the docking panels.
Code examples
Initialize a jqxDocking with the mode property specified.
$('#docking').jqxDocking({ mode: 'docked' });
|
|
floatingWindowOpacity
|
Number
|
0.3
|
Gets or sets the opacity of the window which is currently dragged by the user.
Code examples
Initialize a jqxDocking with the floatingWindowOpacity property specified.
$('#docking').jqxDocking({ floatingWindowOpacity: 0.5 });
|
|
panelsRoundedCorners
|
Boolean
|
true
|
Gets or sets whether the panels of the docking are going to be with rounded corners.
Code examples
Initialize a jqxDocking with the panelsRoundedCorners property specified.
$('#docking').jqxDocking({ panelsRoundedCorners: false });
|
|
windowsMode
|
Object
|
null
|
Gets or sets specific mode for each window. The value of the property is object with keys - window's ids and values - specific modes.
Code examples
Initialize a jqxDocking with the windowsMode property specified.
$('#docking').jqxDocking({ windowsMode: { 'window0': 'default', 'window1': 'docked' } });
|
|
cookies
|
Boolean
|
false
|
Enables or disables the cookies. If the cookies are enabled then the docking layout is going to be saved and kept every time the page is being reloaded.
Code examples
Initialize a jqxDocking with the cookies property specified.
$('#docking').jqxDocking({ cookies: true });
|
|
cookieOptions
|
Object
|
{}
|
Sets or gets the cookie options.
Code examples
Initialize a jqxDocking with the cookieOptions property specified.
$('#docking').jqxDocking({ cookieOptions: { domain: 'jqwidgets.com', expires: 90 } });
|
|
windowsOffset
|
Number
|
5
|
Sets or gets the offset between the windows.
Code examples
Initialize a jqxDocking with the windowsOffset property specified.
$('#docking').jqxDocking({ windowsOffset: 3 });
|
|
|
|
dragStart
|
Event
|
|
This event is triggered when the user start to drag any window.
Code examples
Bind to the dragStart event by type: jqxDocking.
$('#docking').bind('dragStart', function (event) { // Some code here. });
|
|
dragEnd
|
Event
|
|
This event is triggered when the user drop any window.
Code examples
Bind to the dragEnd event by type: jqxDocking.
$('#docking').bind('dragEnd', function (event) { // Some code here. });
|
|
|
|
move
|
Method
|
|
Moving window to specific position into specific panel. This method have three parameters. The first one is id of the window
we want to move, the second one is number of the panel where we want to move our window and the last one is the position into this panel.
Code example
Invoke the move method.
$('#docking').jqxDocking('move', 'windowId', 0, 1);
|
|
exportLayout
|
Method
|
|
Exporting docking's layout into a JSON string.
Code example
Invoke the exportLayout method.
$('#docking').jqxDocking('exportLayout');
|
|
importLayout
|
Method
|
|
Importing the docking layout from a JSON string.
Code example
Invoke the importLayout method.
$('#docking').jqxDocking('importLayout', '{"panel0": {"window2":{"collapsed":false}},"floating":{"window1":{"x":"150px","y":"70px",
"width":"381px","height":"auto","collapsed":false}},"orientation": "horizontal"}');
|
|
disable
|
Method
|
|
Disabling the jqxDocking.
Code example
Invoke the disable method.
$('#docking').jqxDocking('disable');
|
|
enable
|
Method
|
|
Enabling the docking
Code example
Invoke the enable method.
$('#docking').jqxDocking('enable');
|
|
setWindowMode
|
Method
|
|
Setting mode to a specific window. This method accepts two arguments - window id and mode type.
Code example
Invoke the setWindowMode method.
$('#docking').jqxDocking('setWindowMode', 'windowId','default');
|
|
hideCloseButton
|
Method
|
|
Hiding the close button of a specific window.
Code example
Invoke the hideCloseButton method.
$('#docking').jqxDocking('hideCloseButton', 'windowId');
|
|
showCloseButton
|
Method
|
|
Showing the close button of a specific window.
Code example
Invoke the showCloseButton method.
$('#docking').jqxDocking('showCloseButton', 'windowId');
|
|
hideCollapseButton
|
Method
|
|
Hiding the collapse button of a specific window.
Code example
Invoke the hideCollapseButton method.
$('#docking').jqxDocking('hideCollapseButton', 'windowId');
|
|
showCollapseButton
|
Method
|
|
Showing the collapse button of a specific window.
Code example
Invoke the showCollapseButton method.
$('#docking').jqxDocking('showCollapseButton', 'windowId');
|
|
expandWindow
|
Method
|
|
Expanding a specific window.
Code example
Invoke the expandWindow method.
$('#docking').jqxDocking('expandWindow', 'windowId');
|
|
collapseWindow
|
Method
|
|
Collapsing a specific window.
Code example
Invoke the collapseWindow method.
$('#docking').jqxDocking('collapseWindow', 'windowId');
|
|
setWindowPosition
|
Method
|
|
Moving window in floating mode to a specific position.
Code example
Invoke the setWindowPosition method.
$('#docking').jqxDocking('setWindowPosition', 'windowId', 300, 531);
|
|
hideAllCloseButtons
|
Method
|
|
Hiding the close buttons of all windows.
Code example
Invoke the hideAllCloseButtons method.
$('#docking').jqxDocking('hideAllCloseButtons');
|
|
hideAllCollapseButtons
|
Method
|
|
Hiding the collapse buttons of all windows.
Code example
Invoke the hideAllCollapseButtons method.
$('#docking').jqxDocking('hideAllCollapseButtons');
|
|
showAllCloseButtons
|
Method
|
|
Showing the close buttons of all windows.
Code example
Invoke the showAllCloseButtons method.
$('#docking').jqxDocking('showAllCloseButtons');
|
|
showAllCollapseButtons
|
Method
|
|
Showing the collapse buttons of all windows.
Code example
Invoke the showAllCollapseButtons method.
$('#docking').jqxDocking('showAllCollapseButtons');
|
|
pinWindow
|
Method
|
|
Pinning a specific window
Code example
Invoke the pinWindow method.
$('#docking').jqxDocking('pinWindow', 'windowId');
|
|
unpinWindow
|
Method
|
|
Unpinning a specific window
Code example
Invoke the unpinWindow method.
$('#docking').jqxDocking('unpinWindow', 'windowId');
|
|
enableWindowResize
|
Method
|
|
Enabling the resize of a specific window which is not docked into a panel.
Code example
Invoke the enableWindowResize method.
$('#docking').jqxDocking('enableWindowResize', 'windowId');
|
|
disableWindowResize
|
Method
|
|
Disabling the resize of a specific window.
Code example
Invoke the disableWindowResize method.
$('#docking').jqxDocking('disableWindowResize', 'windowId');
|
|
addWindow
|
Method
|
|
Adding new window to the docking. This method accepts four arguments. The first one is id of the window we wish to add to the docking. The second argument
is window's mode (default, docked, floating) the third argument is the panel's number and the last one is the position into the panel.
The last three arguments are optional.
Code example
Invoke the addWindow method.
$('#docking').jqxDocking('addWindow', 'windowId', 'default', 0, 1);
|
|
closeWindow
|
Method
|
|
Closing specific window.
Code example
Invoke the closeWindow method.
$('#docking').jqxDocking('closeWindow', 'windowId');
|