Documentation

Getting Started

The jqxDockPanel widget represents a container for other widgets or elements. It arranges its inner elements depending on the value of the 'dock' attribute. The possible 'dock' attribute values are: 'left, right, top and bottom'.
Every UI widget from jQWidgets toolkit needs its JavaScript files to be included in order to work properly.

The first step is to create html page and add links to the javascript files and css dependencies to your project. The jqxDockPanel widget requires the following files:

<head>
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/jquery-1.11.1.min.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxdockpanel.js"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-2FX5PV9DNT"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-2FX5PV9DNT');</script></head>

The next step is to create a DIV element within the body of the html document and add the elements that will be inside the dock panel.

<div id='jqxDockPanel'>
    <div id='first' dock='left' style='background: #486974;'>
        First Div</div>
    <div id='second' dock='top' style='height: 100px; background: #368ba7;'>
        Second Div</div>
    <div id='third' dock='right' style='background: #df7169;'>
        Third Div</div>
    <div id='fourth' style='background: #a73654;'>
        Fourth Div</div>
</div>

The last step is to initialize the widget by adding the following script to the html document:

<script type="text/javascript">
    $(document).ready(function () {
        $("#jqxdockpanel").jqxDockPanel({ width: 300, height: 300});
    });
</script>

To call a function(method), you need to pass the method name and parameters(if any) in the jqxDockPanel’s constructor.

$("#jqxdockpanel").jqxDockPanel(‘render’);

To set a property(option), you need to pass the property name and value(s) in the jqxDockPanel's constructor.

$("#jqxdockpanel").jqxDockPanel({ disabled: true });

To get a property(option), you need to pass the property name to the jqxDockPanel's constructor.

var disabled = $("#jqxdockpanel").jqxDockPanel('disabled');

To bind to an event of a UI widget, you can use basic jQuery syntax. Let’s suppose that you want to know when the dockpanel's layout is changed. The example code below demonstrates how to bind to the ‘layout’ event of jqxDockPanel.

$("#jqxdockpanel").on('layout', function () {});

Basic Sample

<!DOCTYPE html>
<html lang="en">
<head>
    <title id='Description'>jQuery DockPanel Sample.</title>
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/jquery-1.11.1.min.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxdockpanel.js"></script>
    <script type="text/javascript">
        $(document).ready(function () {
   
            // Create jqxDockPanel
            $("#jqxdockpanel").jqxDockPanel({ width: 300, height: 210 });
        });
    </script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-2FX5PV9DNT"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-2FX5PV9DNT');</script></head>
<body class='default'>
    <div id='jqxdockpanel'>
        <div id='first' dock='left' style='background: #486974;'>
            First Div</div>
        <div id='second' dock='top' style='height: 100px; background: #368ba7;'>
            Second Div</div>
        <div id='third' dock='right' style='background: #df7169;'>
            Third Div</div>
        <div id='fourth' style='background: #a73654;'>
            Fourth Div</div>
    </div>
   
</body>
</html>

Documentation

Getting Started

Basic Sample

The result of the above code is: