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

documentation typos

Browse Source
This commit is contained in:
vieron
2012-07-18 19:08:36 +02:00
parent f4a9ae80d8
commit 6fe6f720da
6 changed files with 298 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
dist/jquery.gridster.js vendored
View File

@@ -509,7 +509,7 @@
/**
* Creates the grid coords object representing the widget a add it to the mapped array of positions
*
* @method serialize_changed
* @method register_widget
* @return {Array} Returns the instance of the Gridster class.
*/
fn.register_widget = function($el) {
@@ -1034,22 +1034,15 @@
};
fn.is_placeholder_in_col = function(col, row) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) >= 0;
};
/**
* Determines if the placeholder is currently over the row and col given.
* Determines if the placeholder is currently over the column given.
*
* @method is_placeholder_in
* @method is_placeholder_in_col
* @param {Number} col The column to check.
* @param {Number} row The row to check.
* @return {Boolean} Returns true or false.
*/
fn.is_placeholder_in = function(col, row) {
var c = this.cells_occupied_by_placeholder || [];
return $.inArray(col, c.cols) >= 0 && $.inArray(row, c.rows) >= 0;
fn.is_placeholder_in_col = function(col) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) >= 0;
};
@@ -1877,7 +1870,7 @@
* Iterate over the cells occupied by a widget executing a function for
* each one.
*
* @method for_each_column_occupied
* @method for_each_cell_occupied
* @param {Object} el_grid_data The grid coords object that represents the
* widget.
* @param {Function} callback The function to execute on each column
@@ -2103,7 +2096,7 @@
/**
* Injects the given CSS as string to the head of the document.
*
* @method generate_stylesheet
* @method add_style_tag
* @param {String} css The styles to apply.
* @return {Object} Returns the instance of the Gridster class.
*/

2
dist/jquery.gridster.min.js vendored
View File

File diff suppressed because one or more lines are too long

487
docs/classes/Gridster.html
View File

@@ -436,6 +436,13 @@
<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>
@@ -493,7 +500,7 @@
</li>
<li class="index-item method">
<a href="#method_for_each_column_occupied">for_each_column_occupied</a>
<a href="#method_for_each_cell_occupied">for_each_cell_occupied</a>
@@ -546,13 +553,6 @@
</li>
<li class="index-item method">
<a href="#method_generate_stylesheet">generate_stylesheet</a>
</li>
<li class="index-item method">
@@ -633,7 +633,7 @@
</li>
<li class="index-item method">
<a href="#method_is_placeholder_in">is_placeholder_in</a>
<a href="#method_is_placeholder_in_col">is_placeholder_in_col</a>
@@ -756,6 +756,13 @@
</li>
<li class="index-item method">
<a href="#method_register_widget">register_widget</a>
</li>
<li class="index-item method">
@@ -784,13 +791,6 @@
</li>
<li class="index-item method">
<a href="#method_serialize_changed">serialize_changed</a>
</li>
<li class="index-item method">
@@ -872,6 +872,110 @@
<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#l1818"><code>src&#x2F;jquery.gridster.js:1818</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>
@@ -1192,7 +1296,7 @@
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l922"><code>src&#x2F;jquery.gridster.js:922</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l915"><code>src&#x2F;jquery.gridster.js:915</code></a>
</p>
@@ -1310,7 +1414,7 @@
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1328"><code>src&#x2F;jquery.gridster.js:1328</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1321"><code>src&#x2F;jquery.gridster.js:1321</code></a>
</p>
@@ -1447,7 +1551,7 @@ upper row possible.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l970"><code>src&#x2F;jquery.gridster.js:970</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l963"><code>src&#x2F;jquery.gridster.js:963</code></a>
</p>
@@ -1565,7 +1669,7 @@ upper row possible.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1500"><code>src&#x2F;jquery.gridster.js:1500</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1493"><code>src&#x2F;jquery.gridster.js:1493</code></a>
</p>
@@ -1763,7 +1867,7 @@ into account the dimensions (<code>size_y</code> and <code>size_x</code> attrs.
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1463"><code>src&#x2F;jquery.gridster.js:1463</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1456"><code>src&#x2F;jquery.gridster.js:1456</code></a>
</p>
@@ -1798,8 +1902,8 @@ into account the dimensions (<code>size_y</code> and <code>size_x</code> attrs.
</div>
<div id="method_for_each_column_occupied" class="method item">
<h3 class="name"><code>for_each_column_occupied</code></h3>
<div id="method_for_each_cell_occupied" class="method item">
<h3 class="name"><code>for_each_cell_occupied</code></h3>
<div class="args">
@@ -1850,7 +1954,7 @@ into account the dimensions (<code>size_y</code> and <code>size_x</code> attrs.
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1598"><code>src&#x2F;jquery.gridster.js:1598</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1591"><code>src&#x2F;jquery.gridster.js:1591</code></a>
</p>
@@ -1978,7 +2082,7 @@ each one.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1619"><code>src&#x2F;jquery.gridster.js:1619</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1612"><code>src&#x2F;jquery.gridster.js:1612</code></a>
</p>
@@ -2106,7 +2210,7 @@ each one.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1638"><code>src&#x2F;jquery.gridster.js:1638</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1631"><code>src&#x2F;jquery.gridster.js:1631</code></a>
</p>
@@ -2239,7 +2343,7 @@ each one.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1704"><code>src&#x2F;jquery.gridster.js:1704</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1697"><code>src&#x2F;jquery.gridster.js:1697</code></a>
</p>
@@ -2386,7 +2490,7 @@ iteration. The value of <code>this</code> inside the function is the jQuery wrap
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1720"><code>src&#x2F;jquery.gridster.js:1720</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1713"><code>src&#x2F;jquery.gridster.js:1713</code></a>
</p>
@@ -2527,7 +2631,7 @@ iteration. The value of <code>this</code> inside the function is the jQuery wrap
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1848"><code>src&#x2F;jquery.gridster.js:1848</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1841"><code>src&#x2F;jquery.gridster.js:1841</code></a>
</p>
@@ -2637,7 +2741,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1898"><code>src&#x2F;jquery.gridster.js:1898</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1891"><code>src&#x2F;jquery.gridster.js:1891</code></a>
</p>
@@ -2725,7 +2829,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1781"><code>src&#x2F;jquery.gridster.js:1781</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1774"><code>src&#x2F;jquery.gridster.js:1774</code></a>
</p>
@@ -2795,110 +2899,6 @@ detect row or column that we want to go.</p>
</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>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#l1825"><code>src&#x2F;jquery.gridster.js:1825</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>
@@ -2948,7 +2948,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1570"><code>src&#x2F;jquery.gridster.js:1570</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1563"><code>src&#x2F;jquery.gridster.js:1563</code></a>
</p>
@@ -3042,7 +3042,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1736"><code>src&#x2F;jquery.gridster.js:1736</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1729"><code>src&#x2F;jquery.gridster.js:1729</code></a>
</p>
@@ -3123,7 +3123,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1535"><code>src&#x2F;jquery.gridster.js:1535</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1528"><code>src&#x2F;jquery.gridster.js:1528</code></a>
</p>
@@ -3228,7 +3228,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1553"><code>src&#x2F;jquery.gridster.js:1553</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1546"><code>src&#x2F;jquery.gridster.js:1546</code></a>
</p>
@@ -3345,7 +3345,7 @@ detect row or column that we want to go.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1021"><code>src&#x2F;jquery.gridster.js:1021</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1014"><code>src&#x2F;jquery.gridster.js:1014</code></a>
</p>
@@ -3473,7 +3473,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1884"><code>src&#x2F;jquery.gridster.js:1884</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1877"><code>src&#x2F;jquery.gridster.js:1877</code></a>
</p>
@@ -3544,7 +3544,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1099"><code>src&#x2F;jquery.gridster.js:1099</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1092"><code>src&#x2F;jquery.gridster.js:1092</code></a>
</p>
@@ -3615,7 +3615,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l859"><code>src&#x2F;jquery.gridster.js:859</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l852"><code>src&#x2F;jquery.gridster.js:852</code></a>
</p>
@@ -3702,7 +3702,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l778"><code>src&#x2F;jquery.gridster.js:778</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l771"><code>src&#x2F;jquery.gridster.js:771</code></a>
</p>
@@ -3827,7 +3827,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l797"><code>src&#x2F;jquery.gridster.js:797</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l790"><code>src&#x2F;jquery.gridster.js:790</code></a>
</p>
@@ -4025,8 +4025,8 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
</div>
<div id="method_is_placeholder_in" class="method item">
<h3 class="name"><code>is_placeholder_in</code></h3>
<div id="method_is_placeholder_in_col" class="method item">
<h3 class="name"><code>is_placeholder_in_col</code></h3>
<div class="args">
@@ -4038,12 +4038,6 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
</li>
<li class="arg">
<code>row</code>
</li>
</ul><span class="paren">)</span>
</div>
@@ -4077,7 +4071,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l764"><code>src&#x2F;jquery.gridster.js:764</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l759"><code>src&#x2F;jquery.gridster.js:759</code></a>
</p>
@@ -4088,7 +4082,7 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
</div>
<div class="description">
<p>Determines if the placeholder is currently over the row and col given.</p>
<p>Determines if the placeholder is currently over the column given.</p>
</div>
@@ -4112,21 +4106,6 @@ the</code>upper<em>rows<code>array. Iteration starts from row specified in</code
</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>
@@ -4456,7 +4435,7 @@ and col given.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l817"><code>src&#x2F;jquery.gridster.js:817</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l810"><code>src&#x2F;jquery.gridster.js:810</code></a>
</p>
@@ -4582,7 +4561,7 @@ else returns the jQuery HTMLElement
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l842"><code>src&#x2F;jquery.gridster.js:842</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l835"><code>src&#x2F;jquery.gridster.js:835</code></a>
</p>
@@ -4855,7 +4834,7 @@ params and if this is under the widget that is being dragged.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1283"><code>src&#x2F;jquery.gridster.js:1283</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1276"><code>src&#x2F;jquery.gridster.js:1276</code></a>
</p>
@@ -4974,7 +4953,7 @@ params and if this is under the widget that is being dragged.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1194"><code>src&#x2F;jquery.gridster.js:1194</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1187"><code>src&#x2F;jquery.gridster.js:1187</code></a>
</p>
@@ -5086,7 +5065,7 @@ if they can.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1237"><code>src&#x2F;jquery.gridster.js:1237</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1230"><code>src&#x2F;jquery.gridster.js:1230</code></a>
</p>
@@ -5680,7 +5659,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1132"><code>src&#x2F;jquery.gridster.js:1132</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1125"><code>src&#x2F;jquery.gridster.js:1125</code></a>
</p>
@@ -5784,7 +5763,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1144"><code>src&#x2F;jquery.gridster.js:1144</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1137"><code>src&#x2F;jquery.gridster.js:1137</code></a>
</p>
@@ -5997,7 +5976,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1156"><code>src&#x2F;jquery.gridster.js:1156</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1149"><code>src&#x2F;jquery.gridster.js:1149</code></a>
</p>
@@ -6101,7 +6080,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1174"><code>src&#x2F;jquery.gridster.js:1174</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1167"><code>src&#x2F;jquery.gridster.js:1167</code></a>
</p>
@@ -6156,6 +6135,77 @@ overlapped or stops being overlapped.</p>
</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#l231"><code>src&#x2F;jquery.gridster.js:231</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>
@@ -6501,77 +6551,6 @@ overlapped or stops being overlapped.</p>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l231"><code>src&#x2F;jquery.gridster.js:231</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_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">
@@ -6671,7 +6650,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1446"><code>src&#x2F;jquery.gridster.js:1446</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1439"><code>src&#x2F;jquery.gridster.js:1439</code></a>
</p>
@@ -6780,7 +6759,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1768"><code>src&#x2F;jquery.gridster.js:1768</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1761"><code>src&#x2F;jquery.gridster.js:1761</code></a>
</p>
@@ -6867,7 +6846,7 @@ overlapped or stops being overlapped.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l881"><code>src&#x2F;jquery.gridster.js:881</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l874"><code>src&#x2F;jquery.gridster.js:874</code></a>
</p>
@@ -7452,7 +7431,7 @@ the grid coords object passed in the <code>grid_data</code> param.</p>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1417"><code>src&#x2F;jquery.gridster.js:1417</code></a>
<a href="..&#x2F;files&#x2F;src_jquery.gridster.js.html#l1410"><code>src&#x2F;jquery.gridster.js:1410</code></a>
</p>

91
docs/data.json
View File

@@ -298,7 +298,7 @@
"line": 231,
"description": "Creates the grid coords object representing the widget a add it to the mapped array of positions",
"itemtype": "method",
"name": "serialize_changed",
"name": "register_widget",
"return": {
"description": "Returns the instance of the Gridster class.",
"type": "Array"
@@ -677,20 +677,15 @@
},
{
"file": "src/jquery.gridster.js",
"line": 764,
"description": "Determines if the placeholder is currently over the row and col given.",
"line": 759,
"description": "Determines if the placeholder is currently over the column given.",
"itemtype": "method",
"name": "is_placeholder_in",
"name": "is_placeholder_in_col",
"params": [
{
"name": "col",
"description": "The column to check.",
"type": "Number"
},
{
"name": "row",
"description": "The row to check.",
"type": "Number"
}
],
"return": {
@@ -701,7 +696,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 778,
"line": 771,
"description": "Determines if the cell represented by col and row params is empty.",
"itemtype": "method",
"name": "is_empty",
@@ -725,7 +720,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 797,
"line": 790,
"description": "Determines if the cell represented by col and row params is occupied.",
"itemtype": "method",
"name": "is_occupied",
@@ -749,7 +744,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 817,
"line": 810,
"description": "Determines if there is a widget in the cell represented by col/row params.",
"itemtype": "method",
"name": "is_widget",
@@ -773,7 +768,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 842,
"line": 835,
"description": "Determines if there is a widget in the cell represented by col/row\nparams and if this is under the widget that is being dragged.",
"itemtype": "method",
"name": "is_widget_under_player",
@@ -797,7 +792,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 859,
"line": 852,
"description": "Get widgets overlapping with the player.",
"itemtype": "method",
"name": "get_widgets_under_player",
@@ -809,7 +804,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 881,
"line": 874,
"description": "Put placeholder at the row and column specified.",
"itemtype": "method",
"name": "set_placeholder",
@@ -833,7 +828,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 922,
"line": 915,
"description": "Determines whether the player can move to a position above.",
"itemtype": "method",
"name": "can_go_player_up",
@@ -852,7 +847,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 970,
"line": 963,
"description": "Determines whether a widget can move to a position above.",
"itemtype": "method",
"name": "can_go_widget_up",
@@ -871,7 +866,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1021,
"line": 1014,
"description": "Search a valid row for the widget represented by `widget_grid_data' in\nthe `upper_rows` array. Iteration starts from row specified in `min_row`.",
"itemtype": "method",
"name": "get_valid_rows",
@@ -900,7 +895,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1099,
"line": 1092,
"description": "Get widgets overlapping with the player.",
"itemtype": "method",
"name": "get_widgets_overlapped",
@@ -912,7 +907,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1132,
"line": 1125,
"description": "This callback is executed when the player begins to collide with a column.",
"itemtype": "method",
"name": "on_start_overlapping_column",
@@ -931,7 +926,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1144,
"line": 1137,
"description": "A callback executed when the player begins to collide with a row.",
"itemtype": "method",
"name": "on_start_overlapping_row",
@@ -950,7 +945,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1156,
"line": 1149,
"description": "A callback executed when the the player ends to collide with a column.",
"itemtype": "method",
"name": "on_stop_overlapping_column",
@@ -969,7 +964,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1174,
"line": 1167,
"description": "This callback is executed when the player ends to collide with a row.",
"itemtype": "method",
"name": "on_stop_overlapping_row",
@@ -988,7 +983,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1194,
"line": 1187,
"description": "Move a widget to a specific row. The cell or cells must be empty.\nIf the widget has widgets below, all of these widgets will be moved also\nif they can.",
"itemtype": "method",
"name": "move_widget_to",
@@ -1007,7 +1002,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1237,
"line": 1230,
"description": "Move up the specified widget and all below it.",
"itemtype": "method",
"name": "move_widget_up",
@@ -1032,7 +1027,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1283,
"line": 1276,
"description": "Move down the specified widget and all below it.",
"itemtype": "method",
"name": "move_widget_down",
@@ -1056,7 +1051,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1328,
"line": 1321,
"description": "Check if the widget can move to the specified row, else returns the\nupper row possible.",
"itemtype": "method",
"name": "can_go_up_to_row",
@@ -1085,7 +1080,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1417,
"line": 1410,
"description": "Get widgets below a widget.",
"itemtype": "method",
"name": "widgets_below",
@@ -1104,7 +1099,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1446,
"line": 1439,
"description": "Update the array of mapped positions with the new player position.",
"itemtype": "method",
"name": "set_cells_player_occupies",
@@ -1128,7 +1123,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1463,
"line": 1456,
"description": "Remove from the array of mapped positions the reference to the player.",
"itemtype": "method",
"name": "empty_cells_player_occupies",
@@ -1140,7 +1135,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1500,
"line": 1493,
"description": "Check if it's possible to move a widget to a specific col/row. It takes\ninto account the dimensions (`size_y` and `size_x` attrs. of the grid coords\n object) the widget occupies.",
"itemtype": "method",
"name": "can_move_to",
@@ -1169,7 +1164,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1535,
"line": 1528,
"description": "Given the leftmost column returns all columns that are overlapping with the player.",
"itemtype": "method",
"name": "get_targeted_columns",
@@ -1189,7 +1184,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1553,
"line": 1546,
"description": "Given the upper row returns all rows that are overlapping with the player.",
"itemtype": "method",
"name": "get_targeted_rows",
@@ -1209,7 +1204,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1570,
"line": 1563,
"description": "Get all columns and rows that a widget occupies.",
"itemtype": "method",
"name": "get_cells_occupied",
@@ -1228,10 +1223,10 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1598,
"line": 1591,
"description": "Iterate over the cells occupied by a widget executing a function for\neach one.",
"itemtype": "method",
"name": "for_each_column_occupied",
"name": "for_each_cell_occupied",
"params": [
{
"name": "el_grid_data",
@@ -1252,7 +1247,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1619,
"line": 1612,
"description": "Iterate over the columns occupied by a widget executing a function for\neach one.",
"itemtype": "method",
"name": "for_each_column_occupied",
@@ -1276,7 +1271,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1638,
"line": 1631,
"description": "Iterate over the rows occupied by a widget executing a function for\neach one.",
"itemtype": "method",
"name": "for_each_row_occupied",
@@ -1300,7 +1295,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1704,
"line": 1697,
"description": "Iterate over each widget above the column and row specified.",
"itemtype": "method",
"name": "for_each_widget_above",
@@ -1329,7 +1324,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1720,
"line": 1713,
"description": "Iterate over each widget below the column and row specified.",
"itemtype": "method",
"name": "for_each_widget_below",
@@ -1358,7 +1353,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1736,
"line": 1729,
"description": "Returns the highest occupied cell in the grid.",
"itemtype": "method",
"name": "get_highest_occupied_cell",
@@ -1370,7 +1365,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1768,
"line": 1761,
"description": "Set the current height of the parent grid.",
"itemtype": "method",
"name": "set_dom_grid_height",
@@ -1382,7 +1377,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1781,
"line": 1774,
"description": "It generates the neccessary styles to position the widgets.",
"itemtype": "method",
"name": "generate_stylesheet",
@@ -1406,10 +1401,10 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1825,
"line": 1818,
"description": "Injects the given CSS as string to the head of the document.",
"itemtype": "method",
"name": "generate_stylesheet",
"name": "add_style_tag",
"params": [
{
"name": "css",
@@ -1425,7 +1420,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1848,
"line": 1841,
"description": "Generates a faux grid to collide with it when a widget is dragged and\ndetect row or column that we want to go.",
"itemtype": "method",
"name": "generate_faux_grid",
@@ -1449,7 +1444,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1884,
"line": 1877,
"description": "Get all widgets in the DOM and register them.",
"itemtype": "method",
"name": "get_widgets_from_DOM",
@@ -1461,7 +1456,7 @@
},
{
"file": "src/jquery.gridster.js",
"line": 1898,
"line": 1891,
"description": "Calculate columns and rows to be set based on the configuration\n parameters, grid dimensions, etc ...",
"itemtype": "method",
"name": "generate_grid_and_stylesheet",

21
docs/files/src_jquery.gridster.js.html
View File

@@ -324,7 +324,7 @@
&#x2F;**
* Creates the grid coords object representing the widget a add it to the mapped array of positions
*
* @method serialize_changed
* @method register_widget
* @return {Array} Returns the instance of the Gridster class.
*&#x2F;
fn.register_widget = function($el) {
@@ -849,22 +849,15 @@
};
fn.is_placeholder_in_col = function(col, row) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) &gt;= 0;
};
&#x2F;**
* Determines if the placeholder is currently over the row and col given.
* Determines if the placeholder is currently over the column given.
*
* @method is_placeholder_in
* @method is_placeholder_in_col
* @param {Number} col The column to check.
* @param {Number} row The row to check.
* @return {Boolean} Returns true or false.
*&#x2F;
fn.is_placeholder_in = function(col, row) {
var c = this.cells_occupied_by_placeholder || [];
return $.inArray(col, c.cols) &gt;= 0 &amp;&amp; $.inArray(row, c.rows) &gt;= 0;
fn.is_placeholder_in_col = function(col) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) &gt;= 0;
};
@@ -1692,7 +1685,7 @@
* Iterate over the cells occupied by a widget executing a function for
* each one.
*
* @method for_each_column_occupied
* @method for_each_cell_occupied
* @param {Object} el_grid_data The grid coords object that represents the
* widget.
* @param {Function} callback The function to execute on each column
@@ -1918,7 +1911,7 @@
&#x2F;**
* Injects the given CSS as string to the head of the document.
*
* @method generate_stylesheet
* @method add_style_tag
* @param {String} css The styles to apply.
* @return {Object} Returns the instance of the Gridster class.
*&#x2F;

21
src/jquery.gridster.js
View File

@@ -231,7 +231,7 @@
/**
* Creates the grid coords object representing the widget a add it to the mapped array of positions
*
* @method serialize_changed
* @method register_widget
* @return {Array} Returns the instance of the Gridster class.
*/
fn.register_widget = function($el) {
@@ -756,22 +756,15 @@
};
fn.is_placeholder_in_col = function(col, row) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) >= 0;
};
/**
* Determines if the placeholder is currently over the row and col given.
* Determines if the placeholder is currently over the column given.
*
* @method is_placeholder_in
* @method is_placeholder_in_col
* @param {Number} col The column to check.
* @param {Number} row The row to check.
* @return {Boolean} Returns true or false.
*/
fn.is_placeholder_in = function(col, row) {
var c = this.cells_occupied_by_placeholder || [];
return $.inArray(col, c.cols) >= 0 && $.inArray(row, c.rows) >= 0;
fn.is_placeholder_in_col = function(col) {
return $.inArray(col, this.cells_occupied_by_placeholder.cols) >= 0;
};
@@ -1599,7 +1592,7 @@
* Iterate over the cells occupied by a widget executing a function for
* each one.
*
* @method for_each_column_occupied
* @method for_each_cell_occupied
* @param {Object} el_grid_data The grid coords object that represents the
* widget.
* @param {Function} callback The function to execute on each column
@@ -1825,7 +1818,7 @@
/**
* Injects the given CSS as string to the head of the document.
*
* @method generate_stylesheet
* @method add_style_tag
* @param {String} css The styles to apply.
* @return {Object} Returns the instance of the Gridster class.
*/