mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
e610465a2782f551215e06e5ac8f1c477f04dbde
librenms-librenms/docs/classes/Gridster.html
vieron e610465a27 updated docs and dist
2012-07-19 16:10:38 +02:00

7842 lines
171 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Gridster</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.5.1&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<!-- <h1><img src="..&#x2F;assets/css/logo.png" title=""></h1> -->
<h1><img src="http://ducksboard.com/wp-content/themes/blog-theme-ducksboard/images/ducksboard.png" title=""></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: </em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/Collision.html">Collision</a></li>
<li><a href="..&#x2F;classes/Coords.html">Coords</a></li>
<li><a href="..&#x2F;classes/Gridster.html">Gridster</a></li>
</ul>
<ul id="api-modules" class="apis modules">
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Gridster Class</h1>
<div class="box meta">
<div class="uses">
Uses
<ul class="inline commas">
<li><a href="Coords.html">Coords</a></li>
<li><a href="Collision.html">Collision</a></li>
</ul>
</div>
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l70"><code>src&#x2F;jquery.gridster.js:70</code></a>
</div>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Gridster" class="method item">
<h3 class="name"><code>Gridster</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l70"><code>src&#x2F;jquery.gridster.js:70</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The HTMLelement that contains all the widgets.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An Object with all options you want to
overwrite:</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[widget_selector]</code>
<span class="type">HTMLElement | String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Define who will
be the draggable widgets. Can be a CSS Selector String or a
collection of HTMLElements</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[widget_margins]</code>
<span class="type">Array</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Margin between widgets.
The first index for the horizontal margin (left, right) and
the second for the vertical margin (top, bottom).</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[widget_base_dimensions]</code>
<span class="type">Array</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Base widget dimensions
in pixels. The first index for the width and the second for the
height.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[extra_cols]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Add more columns in addition to
those that have been calculated.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[extra_rows]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Add more rows in addition to
those that have been calculated.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[min_cols]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The minimum required columns.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[min_rows]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The minimum required rows.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[autogenerate_stylesheet]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>If true, all the
CSS required to position all widgets in their respective columns
and rows will be generated automatically and injected to the
<code>&lt;head&gt;</code> of the document. You can set this to false, and write
your own CSS targeting rows and cols via data-attributes like so:
<code>[data-col="1"] { left: 10px; }</code></p>
</div>
</li>
<li class="param">
<code class="param-name optional">[serialize_params]</code>
<span class="type">Function</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Return the data you want
for each widget in the serialization. Two arguments are passed:
<code>$w</code>: the jQuery wrapped HTMLElement, and <code>wgd</code>: the grid
coords object (<code>col</code>, <code>row</code>, <code>size_x</code>, <code>size_y</code>).</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[collision]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An Object with all options for
Collision class you want to overwrite. See Collision docs for
more info.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[draggable]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An Object with all options for
jQuery UI Draggable you want to overwrite. See
http://jqueryui.com/demos/draggable/ for more info.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_add_style_tag">add_style_tag</a>
</li>
<li class="index-item method">
<a href="#method_add_to_gridmap">add_to_gridmap</a>
</li>
<li class="index-item method">
<a href="#method_add_widget">add_widget</a>
</li>
<li class="index-item method">
<a href="#method_can_go_player_up">can_go_player_up</a>
</li>
<li class="index-item method">
<a href="#method_can_go_up_to_row">can_go_up_to_row</a>
</li>
<li class="index-item method">
<a href="#method_can_go_widget_up">can_go_widget_up</a>
</li>
<li class="index-item method">
<a href="#method_can_move_to">can_move_to</a>
</li>
<li class="index-item method">
<a href="#method_draggable">draggable</a>
</li>
<li class="index-item method">
<a href="#method_empty_cells_player_occupies">empty_cells_player_occupies</a>
</li>
<li class="index-item method">
<a href="#method_for_each_cell_occupied">for_each_cell_occupied</a>
</li>
<li class="index-item method">
<a href="#method_for_each_column_occupied">for_each_column_occupied</a>
</li>
<li class="index-item method">
<a href="#method_for_each_row_occupied">for_each_row_occupied</a>
</li>
<li class="index-item method">
<a href="#method_for_each_widget_above">for_each_widget_above</a>
</li>
<li class="index-item method">
<a href="#method_for_each_widget_below">for_each_widget_below</a>
</li>
<li class="index-item method">
<a href="#method_generate_faux_grid">generate_faux_grid</a>
</li>
<li class="index-item method">
<a href="#method_generate_grid_and_stylesheet">generate_grid_and_stylesheet</a>
</li>
<li class="index-item method">
<a href="#method_generate_stylesheet">generate_stylesheet</a>
</li>
<li class="index-item method">
<a href="#method_get_cells_occupied">get_cells_occupied</a>
</li>
<li class="index-item method">
<a href="#method_get_highest_occupied_cell">get_highest_occupied_cell</a>
</li>
<li class="index-item method">
<a href="#method_get_targeted_columns">get_targeted_columns</a>
</li>
<li class="index-item method">
<a href="#method_get_targeted_rows">get_targeted_rows</a>
</li>
<li class="index-item method">
<a href="#method_get_valid_rows">get_valid_rows</a>
</li>
<li class="index-item method">
<a href="#method_get_widgets_from_DOM">get_widgets_from_DOM</a>
</li>
<li class="index-item method">
<a href="#method_get_widgets_overlapped">get_widgets_overlapped</a>
</li>
<li class="index-item method">
<a href="#method_get_widgets_under_player">get_widgets_under_player</a>
</li>
<li class="index-item method">
<a href="#method_is_empty">is_empty</a>
</li>
<li class="index-item method">
<a href="#method_is_occupied">is_occupied</a>
</li>
<li class="index-item method">
<a href="#method_is_placeholder_in">is_placeholder_in</a>
</li>
<li class="index-item method">
<a href="#method_is_placeholder_in_col">is_placeholder_in_col</a>
</li>
<li class="index-item method">
<a href="#method_is_player">is_player</a>
</li>
<li class="index-item method">
<a href="#method_is_player_in">is_player_in</a>
</li>
<li class="index-item method">
<a href="#method_is_widget">is_widget</a>
</li>
<li class="index-item method">
<a href="#method_is_widget_under_player">is_widget_under_player</a>
</li>
<li class="index-item method">
<a href="#method_manage_movements">manage_movements</a>
</li>
<li class="index-item method">
<a href="#method_move_widget_down">move_widget_down</a>
</li>
<li class="index-item method">
<a href="#method_move_widget_to">move_widget_to</a>
</li>
<li class="index-item method">
<a href="#method_move_widget_up">move_widget_up</a>
</li>
<li class="index-item method">
<a href="#method_next_position">next_position</a>
</li>
<li class="index-item method">
<a href="#method_on_drag">on_drag</a>
</li>
<li class="index-item method">
<a href="#method_on_overlapped_column_change">on_overlapped_column_change</a>
</li>
<li class="index-item method">
<a href="#method_on_overlapped_row_change">on_overlapped_row_change</a>
</li>
<li class="index-item method">
<a href="#method_on_start_drag">on_start_drag</a>
</li>
<li class="index-item method">
<a href="#method_on_start_overlapping_column">on_start_overlapping_column</a>
</li>
<li class="index-item method">
<a href="#method_on_start_overlapping_row">on_start_overlapping_row</a>
</li>
<li class="index-item method">
<a href="#method_on_stop_drag">on_stop_drag</a>
</li>
<li class="index-item method">
<a href="#method_on_stop_overlapping_column">on_stop_overlapping_column</a>
</li>
<li class="index-item method">
<a href="#method_on_stop_overlapping_row">on_stop_overlapping_row</a>
</li>
<li class="index-item method">
<a href="#method_recalculate_faux_grid">recalculate_faux_grid</a>
</li>
<li class="index-item method">
<a href="#method_register_widget">register_widget</a>
</li>
<li class="index-item method">
<a href="#method_remove_from_gridmap">remove_from_gridmap</a>
</li>
<li class="index-item method">
<a href="#method_remove_widget">remove_widget</a>
</li>
<li class="index-item method">
<a href="#method_serialize">serialize</a>
</li>
<li class="index-item method">
<a href="#method_serialize_changed">serialize_changed</a>
</li>
<li class="index-item method">
<a href="#method_set_cells_player_occupies">set_cells_player_occupies</a>
</li>
<li class="index-item method">
<a href="#method_set_dom_grid_height">set_dom_grid_height</a>
</li>
<li class="index-item method">
<a href="#method_set_placeholder">set_placeholder</a>
</li>
<li class="index-item method">
<a href="#method_set_player">set_player</a>
</li>
<li class="index-item method">
<a href="#method_sort_by_row_asc">sort_by_row_asc</a>
</li>
<li class="index-item method">
<a href="#method_sort_by_row_desc">sort_by_row_desc</a>
</li>
<li class="index-item method">
<a href="#method_update_widget_position">update_widget_position</a>
</li>
<li class="index-item method">
<a href="#method_widgets_below">widgets_below</a>
</li>
<li class="index-item method">
<a href="#method_widgets_contraints">widgets_contraints</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_add_style_tag" class="method item">
<h3 class="name"><code>add_style_tag</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>css</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1870"><code>src&#x2F;jquery.gridster.js:1870</code></a>
</p>
</div>
<div class="description">
<p>Injects the given CSS as string to the head of the document.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">css</code>
<span class="type">String</span>
<div class="param-description">
<p>The styles to apply.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_add_to_gridmap" class="method item">
<h3 class="name"><code>add_to_gridmap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>grid_data</code>
</li>
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l334"><code>src&#x2F;jquery.gridster.js:334</code></a>
</p>
</div>
<div class="description">
<p>Add a widget to the mapped array of positions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object representing the cells
to update in the mapped array.</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">HTMLElement | Boolean</span>
<div class="param-description">
<p>The value to set in the specified
position .</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_add_widget" class="method item">
<h3 class="name"><code>add_widget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
<li class="arg">
<code>size_x</code>
</li>
<li class="arg">
<code>size_y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElement</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l140"><code>src&#x2F;jquery.gridster.js:140</code></a>
</p>
</div>
<div class="description">
<p>Add a new widget to the grid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">String</span>
<div class="param-description">
<p>The string representing the HTML of the widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">size_x</code>
<span class="type">Number</span>
<div class="param-description">
<p>The nº of rows the widget occupies horizontally.</p>
</div>
</li>
<li class="param">
<code class="param-name">size_y</code>
<span class="type">Number</span>
<div class="param-description">
<p>The nº of columns the widget occupies vertically.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElement</span>:
Returns the jQuery wrapped HTMLElement representing
the widget that was just created.
</div>
</div>
</div>
<div id="method_can_go_player_up" class="method item">
<h3 class="name"><code>can_go_player_up</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widget_grid_data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number | Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l966"><code>src&#x2F;jquery.gridster.js:966</code></a>
</p>
</div>
<div class="description">
<p>Determines whether the player can move to a position above.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widget_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The actual grid coords object of the
player.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number | Boolean</span>:
If the player can be moved to an upper row
returns the row number, else returns false.
</div>
</div>
</div>
<div id="method_can_go_up_to_row" class="method item">
<h3 class="name"><code>can_go_up_to_row</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widget_grid_data</code>
</li>
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean | Number</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1373"><code>src&#x2F;jquery.gridster.js:1373</code></a>
</p>
</div>
<div class="description">
<p>Check if the widget can move to the specified row, else returns the
upper row possible.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widget_grid_data</code>
<span class="type">Number</span>
<div class="param-description">
<p>The current grid coords object of the
widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The target column.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The target row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean | Number</span>:
Returns the row number if the widget can move
to the target position, else returns false.
</div>
</div>
</div>
<div id="method_can_go_widget_up" class="method item">
<h3 class="name"><code>can_go_widget_up</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widget_grid_data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number | Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1015"><code>src&#x2F;jquery.gridster.js:1015</code></a>
</p>
</div>
<div class="description">
<p>Determines whether a widget can move to a position above.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widget_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The actual grid coords object of the
widget we want to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number | Boolean</span>:
If the widget can be moved to an upper row
returns the row number, else returns false.
</div>
</div>
</div>
<div id="method_can_move_to" class="method item">
<h3 class="name"><code>can_move_to</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widget_grid_data</code>
</li>
<li class="arg">
<code>The</code>
</li>
<li class="arg">
<code>The</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1545"><code>src&#x2F;jquery.gridster.js:1545</code></a>
</p>
</div>
<div class="description">
<p>Check if it's possible to move a widget to a specific col/row. It takes
into account the dimensions (<code>size_y</code> and <code>size_x</code> attrs. of the grid coords
object) the widget occupies.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widget_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object that represents
the widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">The</code>
<span class="type">Object</span>
<div class="param-description">
<p>col target col.</p>
</div>
</li>
<li class="param">
<code class="param-name">The</code>
<span class="type">Object</span>
<div class="param-description">
<p>row target row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true if all cells are empty, else return false.
</div>
</div>
</div>
<div id="method_draggable" class="method item">
<h3 class="name"><code>draggable</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l356"><code>src&#x2F;jquery.gridster.js:356</code></a>
</p>
</div>
<div class="description">
<p>Make widgets draggable. It Wraps the jQuery UI Draggable Plugin.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_empty_cells_player_occupies" class="method item">
<h3 class="name"><code>empty_cells_player_occupies</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1508"><code>src&#x2F;jquery.gridster.js:1508</code></a>
</p>
</div>
<div class="description">
<p>Remove from the array of mapped positions the reference to the player.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_for_each_cell_occupied" class="method item">
<h3 class="name"><code>for_each_cell_occupied</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el_grid_data</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1643"><code>src&#x2F;jquery.gridster.js:1643</code></a>
</p>
</div>
<div class="description">
<p>Iterate over the cells occupied by a widget executing a function for
each one.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object that represents the
widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The function to execute on each column
iteration. Column and row are passed as arguments.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_for_each_column_occupied" class="method item">
<h3 class="name"><code>for_each_column_occupied</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el_grid_data</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1664"><code>src&#x2F;jquery.gridster.js:1664</code></a>
</p>
</div>
<div class="description">
<p>Iterate over the columns occupied by a widget executing a function for
each one.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object that represents
the widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The function to execute on each column
iteration. The column number is passed as first argument.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_for_each_row_occupied" class="method item">
<h3 class="name"><code>for_each_row_occupied</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el_grid_data</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1683"><code>src&#x2F;jquery.gridster.js:1683</code></a>
</p>
</div>
<div class="description">
<p>Iterate over the rows occupied by a widget executing a function for
each one.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object that represents
the widget.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The function to execute on each column iteration. The row number is passed as first argument.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_for_each_widget_above" class="method item">
<h3 class="name"><code>for_each_widget_above</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1749"><code>src&#x2F;jquery.gridster.js:1749</code></a>
</p>
</div>
<div class="description">
<p>Iterate over each widget above the column and row specified.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to start iterating.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to start iterating.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The function to execute on each widget
iteration. The value of <code>this</code> inside the function is the jQuery wrapped HTMLElement.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_for_each_widget_below" class="method item">
<h3 class="name"><code>for_each_widget_below</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1765"><code>src&#x2F;jquery.gridster.js:1765</code></a>
</p>
</div>
<div class="description">
<p>Iterate over each widget below the column and row specified.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to start iterating.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to start iterating.</p>
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>The function to execute on each widget
iteration. The value of <code>this</code> inside the function is the jQuery wrapped HTMLElement.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_generate_faux_grid" class="method item">
<h3 class="name"><code>generate_faux_grid</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>rows</code>
</li>
<li class="arg">
<code>cols</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1893"><code>src&#x2F;jquery.gridster.js:1893</code></a>
</p>
</div>
<div class="description">
<p>Generates a faux grid to collide with it when a widget is dragged and
detect row or column that we want to go.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">rows</code>
<span class="type">Number</span>
<div class="param-description">
<p>Number of columns.</p>
</div>
</li>
<li class="param">
<code class="param-name">cols</code>
<span class="type">Number</span>
<div class="param-description">
<p>Number of rows.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_generate_grid_and_stylesheet" class="method item">
<h3 class="name"><code>generate_grid_and_stylesheet</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1967"><code>src&#x2F;jquery.gridster.js:1967</code></a>
</p>
</div>
<div class="description">
<p>Calculate columns and rows to be set based on the configuration
parameters, grid dimensions, etc ...</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_generate_stylesheet" class="method item">
<h3 class="name"><code>generate_stylesheet</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>rows</code>
</li>
<li class="arg">
<code>cols</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1826"><code>src&#x2F;jquery.gridster.js:1826</code></a>
</p>
</div>
<div class="description">
<p>It generates the neccessary styles to position the widgets.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">rows</code>
<span class="type">Number</span>
<div class="param-description">
<p>Number of columns.</p>
</div>
</li>
<li class="param">
<code class="param-name">cols</code>
<span class="type">Number</span>
<div class="param-description">
<p>Number of rows.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_get_cells_occupied" class="method item">
<h3 class="name"><code>get_cells_occupied</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el_grid_data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1615"><code>src&#x2F;jquery.gridster.js:1615</code></a>
</p>
</div>
<div class="description">
<p>Get all columns and rows that a widget occupies.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object of the widget.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns an object like <code>{ cols: [], rows: []}</code>.
</div>
</div>
</div>
<div id="method_get_highest_occupied_cell" class="method item">
<h3 class="name"><code>get_highest_occupied_cell</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1781"><code>src&#x2F;jquery.gridster.js:1781</code></a>
</p>
</div>
<div class="description">
<p>Returns the highest occupied cell in the grid.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns an object with <code>col</code> and <code>row</code> numbers.
</div>
</div>
</div>
<div id="method_get_targeted_columns" class="method item">
<h3 class="name"><code>get_targeted_columns</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[from_col]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1580"><code>src&#x2F;jquery.gridster.js:1580</code></a>
</p>
</div>
<div class="description">
<p>Given the leftmost column returns all columns that are overlapping with the player.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[from_col]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The leftmost column.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns an array with column numbers.
</div>
</div>
</div>
<div id="method_get_targeted_rows" class="method item">
<h3 class="name"><code>get_targeted_rows</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[from_row]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1598"><code>src&#x2F;jquery.gridster.js:1598</code></a>
</p>
</div>
<div class="description">
<p>Given the upper row returns all rows that are overlapping with the player.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[from_row]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The upper row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns an array with row numbers.
</div>
</div>
</div>
<div id="method_get_valid_rows" class="method item">
<h3 class="name"><code>get_valid_rows</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widget_grid_data</code>
</li>
<li class="arg">
<code>upper_rows</code>
</li>
<li class="arg">
<code>min_row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number | Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1066"><code>src&#x2F;jquery.gridster.js:1066</code></a>
</p>
</div>
<div class="description">
<p>Search a valid row for the widget represented by <code>widget_grid_data' in
the</code>upper<em>rows<code>array. Iteration starts from row specified in</code>min</em>row`.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widget_grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The actual grid coords object of the
player.</p>
</div>
</li>
<li class="param">
<code class="param-name">upper_rows</code>
<span class="type">Array</span>
<div class="param-description">
<p>An array with columns as index and arrays
of valid rows as values.</p>
</div>
</li>
<li class="param">
<code class="param-name">min_row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The upper row from which the iteration will start.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number | Boolean</span>:
Returns the upper row valid from the <code>upper_rows</code>
for the widget in question.
</div>
</div>
</div>
<div id="method_get_widgets_from_DOM" class="method item">
<h3 class="name"><code>get_widgets_from_DOM</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1953"><code>src&#x2F;jquery.gridster.js:1953</code></a>
</p>
</div>
<div class="description">
<p>Get all widgets in the DOM and register them.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_get_widgets_overlapped" class="method item">
<h3 class="name"><code>get_widgets_overlapped</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1144"><code>src&#x2F;jquery.gridster.js:1144</code></a>
</p>
</div>
<div class="description">
<p>Get widgets overlapping with the player.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
Returns a jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_get_widgets_under_player" class="method item">
<h3 class="name"><code>get_widgets_under_player</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">HTMLElement</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l902"><code>src&#x2F;jquery.gridster.js:902</code></a>
</p>
</div>
<div class="description">
<p>Get widgets overlapping with the player.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElement</span>:
Returns a jQuery collection of HTMLElements
</div>
</div>
</div>
<div id="method_is_empty" class="method item">
<h3 class="name"><code>is_empty</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l821"><code>src&#x2F;jquery.gridster.js:821</code></a>
</p>
</div>
<div class="description">
<p>Determines if the cell represented by col and row params is empty.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_occupied" class="method item">
<h3 class="name"><code>is_occupied</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l840"><code>src&#x2F;jquery.gridster.js:840</code></a>
</p>
</div>
<div class="description">
<p>Determines if the cell represented by col and row params is occupied.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_placeholder_in" class="method item">
<h3 class="name"><code>is_placeholder_in</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l795"><code>src&#x2F;jquery.gridster.js:795</code></a>
</p>
</div>
<div class="description">
<p>Determines if the placeholder is currently over the row and col given.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_placeholder_in_col" class="method item">
<h3 class="name"><code>is_placeholder_in_col</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l809"><code>src&#x2F;jquery.gridster.js:809</code></a>
</p>
</div>
<div class="description">
<p>Determines if the placeholder is currently over the column given.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_player" class="method item">
<h3 class="name"><code>is_player</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col_or_el</code>
</li>
<li class="arg">
<code class="optional">[row]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l763"><code>src&#x2F;jquery.gridster.js:763</code></a>
</p>
</div>
<div class="description">
<p>Determines if there is a widget in the row and col given. Or if the
HTMLElement passed as first argument is the player.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col_or_el</code>
<span class="type">Number | HTMLElement</span>
<div class="param-description">
<p>A jQuery wrapped collection of
HTMLElements.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[row]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The column to which we want to move the widgets.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_player_in" class="method item">
<h3 class="name"><code>is_player_in</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l780"><code>src&#x2F;jquery.gridster.js:780</code></a>
</p>
</div>
<div class="description">
<p>Determines if the widget that is being dragged is currently over the row
and col given.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_is_widget" class="method item">
<h3 class="name"><code>is_widget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean | HTMLElement</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l860"><code>src&#x2F;jquery.gridster.js:860</code></a>
</p>
</div>
<div class="description">
<p>Determines if there is a widget in the cell represented by col/row params.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean | HTMLElement</span>:
Returns false if there is no widget,
else returns the jQuery HTMLElement
</div>
</div>
</div>
<div id="method_is_widget_under_player" class="method item">
<h3 class="name"><code>is_widget_under_player</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l885"><code>src&#x2F;jquery.gridster.js:885</code></a>
</p>
</div>
<div class="description">
<p>Determines if there is a widget in the cell represented by col/row
params and if this is under the widget that is being dragged.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to check.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
Returns true or false.
</div>
</div>
</div>
<div id="method_manage_movements" class="method item">
<h3 class="name"><code>manage_movements</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$widgets</code>
</li>
<li class="arg">
<code>to_col</code>
</li>
<li class="arg">
<code>to_row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l717"><code>src&#x2F;jquery.gridster.js:717</code></a>
</p>
</div>
<div class="description">
<p>Sorts an Array of grid coords objects (representing the grid coords of
each widget) in descending way.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$widgets</code>
<span class="type">HTMLElements</span>
<div class="param-description">
<p>A jQuery collection of HTMLElements
representing the widgets you want to move.</p>
</div>
</li>
<li class="param">
<code class="param-name">to_col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to which we want to move the widgets.</p>
</div>
</li>
<li class="param">
<code class="param-name">to_row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to which we want to move the widgets.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_move_widget_down" class="method item">
<h3 class="name"><code>move_widget_down</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$widget</code>
</li>
<li class="arg">
<code>The</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1328"><code>src&#x2F;jquery.gridster.js:1328</code></a>
</p>
</div>
<div class="description">
<p>Move down the specified widget and all below it.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$widget</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The jQuery object representing the widget you want to move.</p>
</div>
</li>
<li class="param">
<code class="param-name">The</code>
<span class="type">Number</span>
<div class="param-description">
<p>number of cells that the widget has to move.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_move_widget_to" class="method item">
<h3 class="name"><code>move_widget_to</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$widget</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1239"><code>src&#x2F;jquery.gridster.js:1239</code></a>
</p>
</div>
<div class="description">
<p>Move a widget to a specific row. The cell or cells must be empty.
If the widget has widgets below, all of these widgets will be moved also
if they can.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$widget</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The jQuery wrapped HTMLElement of the widget is going to be moved.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_move_widget_up" class="method item">
<h3 class="name"><code>move_widget_up</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$widget</code>
</li>
<li class="arg">
<code class="optional">[y_units]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1282"><code>src&#x2F;jquery.gridster.js:1282</code></a>
</p>
</div>
<div class="description">
<p>Move up the specified widget and all below it.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$widget</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The widget you want to move.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[y_units]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The number of cells that the widget has to move.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_next_position" class="method item">
<h3 class="name"><code>next_position</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>size_x</code>
</li>
<li class="arg">
<code>size_y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l171"><code>src&#x2F;jquery.gridster.js:171</code></a>
</p>
</div>
<div class="description">
<p>Get the most left column below to add a new widget.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">size_x</code>
<span class="type">Number</span>
<div class="param-description">
<p>The nº of rows the widget occupies horizontally.</p>
</div>
</li>
<li class="param">
<code class="param-name">size_y</code>
<span class="type">Number</span>
<div class="param-description">
<p>The nº of columns the widget occupies vertically.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns a grid coords object representing the future
widget coords.
</div>
</div>
</div>
<div id="method_on_drag" class="method item">
<h3 class="name"><code>on_drag</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
<li class="arg">
<code>A</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l436"><code>src&#x2F;jquery.gridster.js:436</code></a>
</p>
</div>
<div class="description">
<p>This function is executed when the player is being dragged.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</code>
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Event.html" class="crosslink external" target="_blank">Event</a></span>
<div class="param-description">
<p>original browser event</p>
</div>
</li>
<li class="param">
<code class="param-name">A</code>
<span class="type">Object</span>
<div class="param-description">
<p>prepared ui object.
See http://jqueryui.com/demos/draggable/ for more info.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_on_overlapped_column_change" class="method item">
<h3 class="name"><code>on_overlapped_column_change</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>start_callback</code>
</li>
<li class="arg">
<code>stop_callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l513"><code>src&#x2F;jquery.gridster.js:513</code></a>
</p>
</div>
<div class="description">
<p>Executes the callbacks passed as arguments when a column begins to be
overlapped or stops being overlapped.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">start_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a new column
begins to be overlapped. The column is passed as first argument.</p>
</div>
</li>
<li class="param">
<code class="param-name">stop_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a column stops
being overlapped. The column is passed as first argument.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_on_overlapped_row_change" class="method item">
<h3 class="name"><code>on_overlapped_row_change</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>start_callback</code>
</li>
<li class="arg">
<code>stop_callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l553"><code>src&#x2F;jquery.gridster.js:553</code></a>
</p>
</div>
<div class="description">
<p>Executes the callbacks passed as arguments when a row starts to be
overlapped or stops being overlapped.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">start_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a new row begins
to be overlapped. The row is passed as first argument.</p>
</div>
</li>
<li class="param">
<code class="param-name">stop_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a row stops being
overlapped. The row is passed as first argument.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_on_start_drag" class="method item">
<h3 class="name"><code>on_start_drag</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
<li class="arg">
<code>A</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l387"><code>src&#x2F;jquery.gridster.js:387</code></a>
</p>
</div>
<div class="description">
<p>This function is executed when the player begins to be dragged.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</code>
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Event.html" class="crosslink external" target="_blank">Event</a></span>
<div class="param-description">
<p>original browser event</p>
</div>
</li>
<li class="param">
<code class="param-name">A</code>
<span class="type">Object</span>
<div class="param-description">
<p>prepared ui object.
See http://jqueryui.com/demos/draggable/ for more info.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_on_start_overlapping_column" class="method item">
<h3 class="name"><code>on_start_overlapping_column</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1177"><code>src&#x2F;jquery.gridster.js:1177</code></a>
</p>
</div>
<div class="description">
<p>This callback is executed when the player begins to collide with a column.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The collided column.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
Returns a jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_on_start_overlapping_row" class="method item">
<h3 class="name"><code>on_start_overlapping_row</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1189"><code>src&#x2F;jquery.gridster.js:1189</code></a>
</p>
</div>
<div class="description">
<p>A callback executed when the player begins to collide with a row.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The collided row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
Returns a jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_on_stop_drag" class="method item">
<h3 class="name"><code>on_stop_drag</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
<li class="arg">
<code>A</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l462"><code>src&#x2F;jquery.gridster.js:462</code></a>
</p>
</div>
<div class="description">
<p>This function is executed when the player stops being dragged.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</code>
<span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Event.html" class="crosslink external" target="_blank">Event</a></span>
<div class="param-description">
<p>original browser event</p>
</div>
</li>
<li class="param">
<code class="param-name">A</code>
<span class="type">Object</span>
<div class="param-description">
<p>prepared ui object.
See http://jqueryui.com/demos/draggable/ for more info.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_on_stop_overlapping_column" class="method item">
<h3 class="name"><code>on_stop_overlapping_column</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1201"><code>src&#x2F;jquery.gridster.js:1201</code></a>
</p>
</div>
<div class="description">
<p>A callback executed when the the player ends to collide with a column.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The collided row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
Returns a jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_on_stop_overlapping_row" class="method item">
<h3 class="name"><code>on_stop_overlapping_row</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1219"><code>src&#x2F;jquery.gridster.js:1219</code></a>
</p>
</div>
<div class="description">
<p>This callback is executed when the player ends to collide with a row.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The collided row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
Returns a jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_recalculate_faux_grid" class="method item">
<h3 class="name"><code>recalculate_faux_grid</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1929"><code>src&#x2F;jquery.gridster.js:1929</code></a>
</p>
</div>
<div class="description">
<p>Recalculates the offsets for the faux grid. You need to use it when
the browser is resized.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_register_widget" class="method item">
<h3 class="name"><code>register_widget</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l272"><code>src&#x2F;jquery.gridster.js:272</code></a>
</p>
</div>
<div class="description">
<p>Creates the grid coords object representing the widget a add it to the
mapped array of positions.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_remove_from_gridmap" class="method item">
<h3 class="name"><code>remove_from_gridmap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>grid_data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l321"><code>src&#x2F;jquery.gridster.js:321</code></a>
</p>
</div>
<div class="description">
<p>Remove a widget from the mapped array of positions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object representing the cells
to update in the mapped array.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_remove_widget" class="method item">
<h3 class="name"><code>remove_widget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>el</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l212"><code>src&#x2F;jquery.gridster.js:212</code></a>
</p>
</div>
<div class="description">
<p>Remove a widget from the grid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">el</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The jQuery wrapped HTMLElement you want to remove.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_serialize" class="method item">
<h3 class="name"><code>serialize</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[$widgets]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l238"><code>src&#x2F;jquery.gridster.js:238</code></a>
</p>
</div>
<div class="description">
<p>Returns a serialized array of the widgets in the grid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[$widgets]</code>
<span class="type">HTMLElement</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The collection of jQuery wrapped
HTMLElements you want to serialize. If no argument is passed all widgets
will be serialized.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns an Array of Objects with the data specified in
the serialize_params option.
</div>
</div>
</div>
<div id="method_serialize_changed" class="method item">
<h3 class="name"><code>serialize_changed</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l260"><code>src&#x2F;jquery.gridster.js:260</code></a>
</p>
</div>
<div class="description">
<p>Returns a serialized array of the widgets that have changed their position.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns an Array of Objects with the data specified in
the serialize_params option.
</div>
</div>
</div>
<div id="method_set_cells_player_occupies" class="method item">
<h3 class="name"><code>set_cells_player_occupies</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>col</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1491"><code>src&#x2F;jquery.gridster.js:1491</code></a>
</p>
</div>
<div class="description">
<p>Update the array of mapped positions with the new player position.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The new player col.</p>
</div>
</li>
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The new player row.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_set_dom_grid_height" class="method item">
<h3 class="name"><code>set_dom_grid_height</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1813"><code>src&#x2F;jquery.gridster.js:1813</code></a>
</p>
</div>
<div class="description">
<p>Set the current height of the parent grid.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
Returns the instance of the Gridster class.
</div>
</div>
</div>
<div id="method_set_placeholder" class="method item">
<h3 class="name"><code>set_placeholder</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>col</code>
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l924"><code>src&#x2F;jquery.gridster.js:924</code></a>
</p>
</div>
<div class="description">
<p>Put placeholder at the row and column specified.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">col</code>
<span class="type">Number</span>
<div class="param-description">
<p>The column to which we want to move the
placeholder.</p>
</div>
</li>
<li class="param">
<code class="param-name">row</code>
<span class="type">Number</span>
<div class="param-description">
<p>The row to which we want to move the
placeholder.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_set_player" class="method item">
<h3 class="name"><code>set_player</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>start_callback</code>
</li>
<li class="arg">
<code>stop_callback</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l589"><code>src&#x2F;jquery.gridster.js:589</code></a>
</p>
</div>
<div class="description">
<p>Sets the current position of the player</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">start_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a new row begins
to be overlapped. The row is passed as first argument.</p>
</div>
</li>
<li class="param">
<code class="param-name">stop_callback</code>
<span class="type">Function</span>
<div class="param-description">
<p>Function executed when a row stops being
overlapped. The row is passed as first argument.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_sort_by_row_asc" class="method item">
<h3 class="name"><code>sort_by_row_asc</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widgets</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l678"><code>src&#x2F;jquery.gridster.js:678</code></a>
</p>
</div>
<div class="description">
<p>Sorts an Array of grid coords objects (representing the grid coords of
each widget) in ascending way.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widgets</code>
<span class="type">Array</span>
<div class="param-description">
<p>Array of grid coords objects</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns the array sorted.
</div>
</div>
</div>
<div id="method_sort_by_row_desc" class="method item">
<h3 class="name"><code>sort_by_row_desc</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widgets</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l698"><code>src&#x2F;jquery.gridster.js:698</code></a>
</p>
</div>
<div class="description">
<p>Sorts an Array of grid coords objects (representing the grid coords of
each widget) in descending way.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widgets</code>
<span class="type">Array</span>
<div class="param-description">
<p>Array of grid coords objects</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns the array sorted.
</div>
</div>
</div>
<div id="method_update_widget_position" class="method item">
<h3 class="name"><code>update_widget_position</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>grid_data</code>
</li>
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Class</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l300"><code>src&#x2F;jquery.gridster.js:300</code></a>
</p>
</div>
<div class="description">
<p>Update in the mapped array of positions the value of cells represented by
the grid coords object passed in the <code>grid_data</code> param.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">grid_data</code>
<span class="type">Object</span>
<div class="param-description">
<p>The grid coords object representing the cells
to update in the mapped array.</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">HTMLElement | Boolean</span>
<div class="param-description">
<p>Pass <code>false</code> or the jQuery wrapped
HTMLElement, depends if you want to delete an existing position or add
a new one.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Class</span>:
Returns the instance of the Gridster Class.
</div>
</div>
</div>
<div id="method_widgets_below" class="method item">
<h3 class="name"><code>widgets_below</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$el</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTMLElements</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1462"><code>src&#x2F;jquery.gridster.js:1462</code></a>
</p>
</div>
<div class="description">
<p>Get widgets below a widget.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$el</code>
<span class="type">HTMLElement</span>
<div class="param-description">
<p>The jQuery wrapped HTMLElement.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTMLElements</span>:
A jQuery collection of HTMLElements.
</div>
</div>
</div>
<div id="method_widgets_contraints" class="method item">
<h3 class="name"><code>widgets_contraints</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>$widgets</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l642"><code>src&#x2F;jquery.gridster.js:642</code></a>
</p>
</div>
<div class="description">
<p>See which of the widgets in the $widgets param collection can go to
a upper row and which not.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">$widgets</code>
<span class="type">HTMLElements</span>
<div class="param-description">
<p>A jQuery wrapped collection of
HTMLElements.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
Returns a literal Object with two keys: <code>can_go_up</code> &amp;
<code>can_not_go_up</code>. Each contains a set of HTMLElements.
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink