Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. Class
+Collision Class
@@ -140,20 +118,15 @@ Coords objects. Class
-
+
Detects collisions between a DOM element against other DOM elements or +Coords objects.
Constructor
-
-
+
Collision
-
-Detects collisions between a DOM element against other DOM elements or
-Coords objects.
+
+
Collision
diff --git "a/docs/classes/Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide..html" b/docs/classes/Coords.html
similarity index 79%
rename from "docs/classes/Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide..html"
rename to docs/classes/Coords.html
index eace6a44b7..cfa96b9082 100644
--- "a/docs/classes/Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide..html"
+++ b/docs/classes/Coords.html
@@ -2,12 +2,7 @@
- Coords
-
-Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)
-to simulate DOM elements on the screen.
-Coords is used by Gridster to create a faux grid with any DOM element can
-collide.
+ Coords
@@ -47,25 +42,9 @@ collide.
-
-
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -110,12 +89,7 @@ collide.
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -125,7 +109,8 @@ collide.
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -161,12 +145,6 @@ collide. -
-
-
-
[avoid_overlapped_widgets]- -
-
-
+
+
[avoid_overlapped_widgets]+ Boolean + optional + + +++ +Avoid that widgets loaded + from the DOM can be overlapped. It is helpful if the positions were + bad stored in the database or if there was any conflict.
+ - @@ -426,24 +420,6 @@ collide. -
-
-
-
[avoid_overlapped_widgets]- Boolean - optional - - - - --- - -Avoid that widgets loaded - from the DOM can be overlapped. It is helpful if the positions were - bad stored in the database or if there was any conflict.
-
-
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -128,11 +112,10 @@ collide. /** - * @class Collision - * * Detects collisions between a DOM element against other DOM elements or * Coords objects. * + * @class Collision * @uses Coords * @param {HTMLElement} el The jQuery wrapped HTMLElement. * @param {HTMLElement|Array} colliders Can be a jQuery collection diff --git a/docs/files/src_jquery.coords.js.html b/docs/files/src_jquery.coords.js.html index a7fe8710dc..ef71a741f0 100644 --- a/docs/files/src_jquery.coords.js.html +++ b/docs/files/src_jquery.coords.js.html @@ -42,25 +42,9 @@
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -119,13 +103,12 @@ collide. ;(function($, window, document, undefined){ /** - * @class Coords - * * Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) * to simulate DOM elements on the screen. * Coords is used by Gridster to create a faux grid with any DOM element can * collide. * + * @class Coords * @param {HTMLElement|Object} obj The jQuery HTMLElement or a object with: left, * top, width and height properties. * @return {Object} Coords instance. diff --git a/docs/files/src_jquery.draggable.js.html b/docs/files/src_jquery.draggable.js.html index c87d7bac27..ada2dff3fb 100644 --- a/docs/files/src_jquery.draggable.js.html +++ b/docs/files/src_jquery.draggable.js.html @@ -42,25 +42,9 @@
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -133,8 +117,10 @@ collide. /** - * @class Draggable + * Basic drag implementation for DOM elements inside a container. + * Provide start/stop/drag callbacks. * + * @class Draggable * @param {HTMLElement} el The HTMLelement that contains all the widgets * to be dragged. * @param {Object} [options] An Object with all options you want to diff --git a/docs/files/src_jquery.gridster.js.html b/docs/files/src_jquery.gridster.js.html index 42645e3f95..4f6b54bcd0 100644 --- a/docs/files/src_jquery.gridster.js.html +++ b/docs/files/src_jquery.gridster.js.html @@ -42,25 +42,9 @@
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable @@ -169,7 +153,7 @@ collide. * `<head>` of the document. You can set this to false, and write * your own CSS targeting rows and cols via data-attributes like so: * `[data-col="1"] { left: 10px; }` - * @param {Boolean} [avoid_overlapped_widgets] Avoid that widgets loaded + * @param {Boolean} [options.avoid_overlapped_widgets] Avoid that widgets loaded * from the DOM can be overlapped. It is helpful if the positions were * bad stored in the database or if there was any conflict. * @param {Function} [options.serialize_params] Return the data you want diff --git a/docs/index.html b/docs/index.html index 2b30280325..b51bc488fc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -42,25 +42,9 @@
- Collision - -Detects collisions between a DOM element against other DOM elements or -Coords objects. +
- Collision -
- Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. +
- Coords
- Draggable diff --git a/index.html b/index.html index 296a890a0c..3ee9289fe4 100755 --- a/index.html +++ b/index.html @@ -22,7 +22,7 @@
-
Coords - -Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) -to simulate DOM elements on the screen. -Coords is used by Gridster to create a faux grid with any DOM element can -collide. Class
+Coords Class
@@ -135,24 +109,17 @@ collide. Class
-
+
Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height) +to simulate DOM elements on the screen. +Coords is used by Gridster to create a faux grid with any DOM element can +collide.
Constructor
-
-
+
Coords
-
-Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)
-to simulate DOM elements on the screen.
-Coords is used by Gridster to create a faux grid with any DOM element can
-collide.
+
+
Coords
diff --git a/docs/classes/Draggable.html b/docs/classes/Draggable.html
index 98d00f602e..f9d22f99fb 100644
--- a/docs/classes/Draggable.html
+++ b/docs/classes/Draggable.html
@@ -42,25 +42,9 @@
+
+
+
diff --git a/docs/data.json b/docs/data.json
index b050d5dd75..59202ebe88 100644
--- a/docs/data.json
+++ b/docs/data.json
@@ -5,7 +5,7 @@
"name": "src/jquery.collision.js",
"modules": {},
"classes": {
- "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.": 1
+ "Collision": 1
},
"fors": {},
"namespaces": {}
@@ -14,7 +14,7 @@
"name": "src/jquery.coords.js",
"modules": {},
"classes": {
- "Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.": 1
+ "Coords": 1
},
"fors": {},
"namespaces": {}
@@ -40,16 +40,19 @@
},
"modules": {},
"classes": {
- "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.": {
- "name": "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.",
- "shortname": "Collision\n\nDetects collisions between a DOM element against other DOM elements or\nCoords objects.",
+ "Collision": {
+ "name": "Collision",
+ "shortname": "Collision",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
- "extension_for": [],
+ "extension_for": [
+ "Gridster"
+ ],
"file": "src/jquery.collision.js",
"line": 19,
+ "description": "Detects collisions between a DOM element against other DOM elements or\nCoords objects.",
"uses": [
"Coords"
],
@@ -97,16 +100,19 @@
},
"is_constructor": 1
},
- "Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.": {
- "name": "Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.",
- "shortname": "Coords\n\nCreates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.",
+ "Coords": {
+ "name": "Coords",
+ "shortname": "Coords",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
- "extension_for": [],
+ "extension_for": [
+ "Collision"
+ ],
"file": "src/jquery.coords.js",
"line": 10,
+ "description": "Creates objects with coordinates (x1, y1, x2, y2, cx, cy, width, height)\nto simulate DOM elements on the screen.\nCoords is used by Gridster to create a faux grid with any DOM element can\ncollide.",
"params": [
{
"name": "obj",
@@ -132,6 +138,7 @@
],
"file": "src/jquery.draggable.js",
"line": 24,
+ "description": "Basic drag implementation for DOM elements inside a container.\nProvide start/stop/drag callbacks.",
"params": [
{
"name": "el",
@@ -269,6 +276,12 @@
"type": "Boolean",
"optional": true
},
+ {
+ "name": "avoid_overlapped_widgets",
+ "description": "Avoid that widgets loaded\n from the DOM can be overlapped. It is helpful if the positions were\n bad stored in the database or if there was any conflict.",
+ "type": "Boolean",
+ "optional": true
+ },
{
"name": "serialize_params",
"description": "Return the data you want\n for each widget in the serialization. Two arguments are passed:\n `$w`: the jQuery wrapped HTMLElement, and `wgd`: the grid\n coords object (`col`, `row`, `size_x`, `size_y`).",
@@ -288,12 +301,6 @@
"optional": true
}
]
- },
- {
- "name": "avoid_overlapped_widgets",
- "description": "Avoid that widgets loaded\n from the DOM can be overlapped. It is helpful if the positions were\n bad stored in the database or if there was any conflict.",
- "type": "Boolean",
- "optional": true
}
],
"is_constructor": 1
diff --git a/docs/files/src_jquery.collision.js.html b/docs/files/src_jquery.collision.js.html
index 6e0eeefb54..c15c3c627c 100644
--- a/docs/files/src_jquery.collision.js.html
+++ b/docs/files/src_jquery.collision.js.html
@@ -42,25 +42,9 @@
-
-
-
+
diff --git a/docs/classes/Gridster.html b/docs/classes/Gridster.html
index b6b876c6e6..351ad30790 100644
--- a/docs/classes/Gridster.html
+++ b/docs/classes/Gridster.html
@@ -42,25 +42,9 @@
Basic drag implementation for DOM elements inside a container. +Provide start/stop/drag callbacks.
-
-
-
-
-
-
-
-
-
-
-
-