jqwidgets-framework

<!DOCTYPE html> <html lang="en"> <head> <link rel="stylesheet" href="../../../../styles/jqx.apireference.css" type="text/css" /> <script type="text/javascript" src="../../../../scripts/jquery-1.11.1.min.js"></script> <script type="text/javascript" src="../../../../scripts/documentation.js"></script> <meta name="keywords" content="jQuery, Panel, Responsive Panel, Responsive, Help Documentation, jQuery Responsive Panel, JavaScript Responsive Panel, jQuery Mobile Responsive Panel" /> <meta name="description" content="This page represents the help documentation of the jqxResponsivePanel widget." /> <title>jqxResponsivePanel API Reference </title> <script type="text/javascript"> $(document).ready(function () { $(".documentation-option-type-click").click(function (event) { $(event.target).parents('tr').next().find(".property-content").toggle(); }); }); </script> </head> <body> <div id="properties"> <h2 class="documentation-top-header">Properties </h2> <table class="documentation-table"> <tr> <th>Name </th> <th>Type </th> <th>Default </th> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span12'>animationDirection</span> </td> <td> <span>String</span> </td> <td>'left' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the direction of the animation. You can use this property when "animationType" is set to 'slide'. </p> <b>Possible Values:</b> <br /> <pre><code>'left'</code></pre> <pre><code>'right'</code></pre> <pre><code>'top'</code></pre> <pre><code>'bottom'</code></pre> <h4>Code examples </h4> <p> Set the <code>animationDirection</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ animationDirection: 'top' }); </code></pre> <p> Get the <code>animationDirection</code> property. </p> <pre><code>var opacity = $('#jqxResponsivePanel').jqxResponsivePanel('animationDirection');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/1efhfx45/">animationDirection is set to 'top'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span14'>animationHideDelay</span> </td> <td> <span>Boolean</span> </td> <td>'fast' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the speed of the animation when the panel hides. The delay represents the time of starting until the final hiding. </p> <h4>Code examples </h4> <p> Set the <code>animationHideDelay</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ animationHideDelay: 'slow' }); </code></pre> <p> Get the <code>animationHideDelay</code> property. </p> <pre><code>var animationHideDelay = $('#jqxResponsivePanel').jqxResponsivePanel('animationHideDelay');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/cou33rs7/">animationHideDelay is set to 800</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span13'>animationShowDelay</span> </td> <td> <span>Number/String</span> </td> <td>'fast' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the speed of the animation when the panel shows. The delay represents the time of it's starting until the final positioning. </p> <h4>Code examples </h4> <p> Set the <code>animationShowDelay</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ animationShowDelay: 'slow' }); </code></pre> <p> Get the <code>animationShowDelay</code> property. </p> <pre><code>var hoverOpacity = $('#jqxResponsivePanel').jqxResponsivePanel('animationShowDelay');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/mh4fxzcw/">animationShowDelay is set to 800</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span11'>animationType</span> </td> <td> <span>String</span> </td> <td>'fade' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets the type of animation using for show/hide the panel. </p> <b>Possible Values:</b> <br /> <pre><code>'fade'</code></pre> <pre><code>'slide'</code></pre> <pre><code>'none'</code></pre> <h4>Code examples </h4> <p> Set the <code>animationType</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ animationType: 'slide' }); </code></pre> <p> Get the <code>animationType</code> property. </p> <pre><code>var animationType = $('#jqxResponsivePanel').jqxResponsivePanel('animationType');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/owz0v1hz/">animationType is set to 'slide'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span15'>autoClose</span> </td> <td> <span>Boolean </span> </td> <td>true </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> When is set to true, after click outside of the responsive panel it closes. </p> <h4>Code examples </h4> <p> Set the <code>autoClose</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ autoClose: false }); </code></pre> <p> Get the <code>autoClose</code> property. </p> <pre><code>var autoClose = $('#jqxResponsivePanel').jqxResponsivePanel('autoClose');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/a6ykwoah/">autoClose is set to false</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span2'>collapseBreakpoint</span> </td> <td> <span>Number</span> </td> <td>1000 </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> If is set, changes the browser's width, where the panel shows/hides. </p> <h4>Code examples </h4> <p> Set the <code>collapseBreakpoint</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ collapseBreakpoint: 1000 });</code></pre> <p> Get the <code>collapseBreakpoint</code> property. </p> <pre><code>var collapseBreakpoint = $('#jqxResponsivePanel').jqxResponsivePanel('collapseBreakpoint');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/1s5jL46d/">collapseBreakpoint is set to 600</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span17'>collapseWidth</span> </td> <td> <span>Number</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the width of the panel when it is collapsed. </p> <h4>Code examples </h4> <p> Set the <code>collapseWidth</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ collapseWidth: 1000 });</code></pre> <p> Get the <code>collapseWidth</code> property. </p> <pre><code>var collapseWidth = $('#jqxResponsivePanel').jqxResponsivePanel('collapseWidth');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/x56nbegb/">collapseWidth is set to 600</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span5'>height</span> </td> <td> <span>Number/String</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the responsive panel's height. </p> <h4>Code examples </h4> <p> Set the <code>height</code> property. </p> <pre><code>$("#jqxResponsivePanel").jqxResponsivePanel({ height: 400 });</code></pre> <p> Get the <code>height</code> property. </p> <pre><code>var height = $('#jqxResponsivePanel').jqxResponsivePanel('height');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/jz646z10/">height is set to 400</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span16'>initContent</span> </td> <td> <span>function</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Initializes the responsive panel content. </p> <h4>Code examples </h4> <p> Set the <code>initContent</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ initContent: function () { $('#jqxButton').jqxButton({ width: 80 }); } });</code></pre> <p> Get the <code>initContent</code> property. </p> <pre><code>var initContent = $('#jqxResponsivePanel').jqxResponsivePanel('initContent');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/f0q2uLt9/">initContent is set to a custom function</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span63'>theme</span> </td> <td> <span>String</span> </td> <td>'' </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets the widget's theme. </p> jQWidgets uses a pair of css files - jqx.base.css and jqx.[theme name].css. The base stylesheet creates the styles related to the widget's layout like margin, padding, border-width, position. The second css file applies the widget's colors and backgrounds. The jqx.base.css should be included before the second CSS file. In order to set a theme, you need to do the following: <ul> <li>Include the theme's CSS file after jqx.base.css.<br /> The following code example adds the 'energyblue' theme. <pre><code> <pre><code><link rel="stylesheet" href="../../../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../../../jqwidgets/styles/jqx.energyblue.css" type="text/css" /> </code></pre> </code></pre> </li> <li>Set the widget's theme property to 'energyblue' when you initialize it. </li> </ul> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/5jbLs7zw/">theme is set to 'energyblue'</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span3'>toggleButton</span> </td> <td> <span>String/Object</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the element, where toggleButton is rendered. </p> <h4>Code examples </h4> <p> Set the <code>toggleButton</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ toggleButton: $('#toggleResponsivePanel') }); </code></pre> <p> Get the <code>toggleButton</code> property. </p> <pre><code>var toggleButton = $('#jqxResponsivePanel').jqxResponsivePanel('toggleButton');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/vtyz8vm9/">toggleButton is set to $('#responsivePanelButton')</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span4'>toggleButtonSize</span> </td> <td> <span>Number/String</span> </td> <td>30 </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets the size of toggleButton. </p> <h4>Code examples </h4> <p> Set the <code>toggleButtonSize</code> property. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel({ toggleButtonSize: 40 }); </code></pre> <p> Get the <code>toggleButtonSize</code> property. </p> <pre><code>var toggleButtonSize = $('#jqxResponsivePanel').jqxResponsivePanel('toggleButtonSize');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/2tf9zffd/">toggleButtonSize is set to 40</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span1'>width</span> </td> <td> <span>Number/String</span> </td> <td>null </td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Sets or gets the responsive panel's width. </p> <h4>Code examples </h4> <p> Set the <code>width</code> property. </p> <pre><code>$("#jqxResponsivePanel").jqxResponsivePanel({ width: 200 });</code></pre> <p> Get the <code>width</code> property. </p> <pre><code>var width = $('#jqxResponsivePanel').jqxResponsivePanel('width');</code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/xgvsab3j/">width is set to 300</a> </div> </div> </td> </tr> <tr> <td colspan='3' style='width: 100%'> <h2 class="documentation-top-header">Events </h2> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span8'>close</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the responsive panel finishes it's closing. </p> <h4>Code examples </h4> <p> Bind to the <code>close</code> event by type: jqxResponsivePanel. </p> <pre><code>$('#jqxResponsivePanel').on('close', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/du41t2dq/">Bind to the close event by type: jqxResponsivePanel.</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span27'>collapse</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the the browser's width becomes smaller than the value of <strong>collapseBreakpoint</strong>. </p> <h4>Code examples </h4> <p> Bind to the <code>collapse</code> event by type: jqxResponsivePanel. </p> <pre><code>$('#jqxResponsivePanel').on('collapse', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/tvf6LjLt/">Bind to the collapse event by type: jqxResponsivePanel.</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span25'>expand</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the the browser's width becomes greather than the value of <strong>collapseBreakpoint</strong>. </p> <h4>Code examples </h4> <p> Bind to the <code>expand</code> event by type: jqxResponsivePanel. </p> <pre><code>$('#jqxResponsivePanel').on('expand', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/xkdasbga/">Bind to the expand event by type: jqxResponsivePanel.</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span26'>open</span> </td> <td> <span>Event</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> This event is triggered when the responsive panel finishes it's opening. </p> <h4>Code examples </h4> <p> Bind to the <code>open</code> event by type: jqxResponsivePanel. </p> <pre><code>$('#jqxResponsivePanel').on('open', function () { // Some code here. }); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/e01gm73s/">Bind to the open event by type: jqxResponsivePanel.</a> </div> </div> </td> </tr> <tr> <td colspan='3' style='width: 100%'> <h2 class="documentation-top-header">Methods </h2> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span28'>close</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Closes the responsive panel. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples </h4> <p> Invoke the <code>close</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('close'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/q1hg97yo/">closes the widget</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span9'>destroy</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Destroy the widget. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples </h4> <p> Invoke the <code>destroy</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('destroy'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/L1fvj0vn/">destroy the widget</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span18'>isCollapsed</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Returns <em>true</em> or <em>false</em> when the panel is collapsed or expanded. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>Boolean</em> </div> <h4>Code examples</h4> <p> Invoke the <code>isCollapsed</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('isCollapsed'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/h67c49gc/">checks if the panel is collapsed</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span19'>isOpened</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Returns <em>true</em> or <em>false</em> when the panel is opened or closed. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>Boolean</em> </div> <h4>Code examples</h4> <p> Invoke the <code>isOpened</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('isOpened'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/h67c49gc/">checks if the panel is opened</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span10'>open</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Open the responsive panel. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples </h4> <p> Invoke the <code>open</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('open'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/409gmjkp/">opens the widget</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span6'>refresh</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Refreshes the widget. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples </h4> <p> Invoke the <code>refresh</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('refresh'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/8t6bvthz/">refresh the widget</a> </div> </div> </td> </tr> <tr> <td class="documentation-option-type-click"> <span id='Span7'>render</span> </td> <td> <span>Method</span> </td> <td></td> </tr> <tr> <td colspan='3' style='width: 100%'> <div class="documentation-option-description property-content" style="display: none;"> <p> Render the widget. </p> <div class="methodArgs"> <table class="arguments"> <tbody> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> <tr> <td><em>None</em></td> <td></td> <td></td> </tr> </tbody> </table> <strong>Return Value</strong><br /> <em>None</em> </div> <h4>Code examples </h4> <p> Invoke the <code>render</code> method. </p> <pre><code>$('#jqxResponsivePanel').jqxResponsivePanel('render'); </code></pre> <div style="padding-bottom: 5px;"> <em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/y3anywaj/">render the widget</a> </div> </div> </td> </tr> </table> <br /> </div> </body> </html>