mirror of
https://github.com/stylersnico/librenms.git
synced 2026-07-28 00:24:21 +02:00
updated doc and dist
This commit is contained in:
vieron
+85
-61
@@ -215,7 +215,7 @@
|
||||
"classitems": [
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 140,
|
||||
"line": 141,
|
||||
"description": "Add a new widget to the grid.",
|
||||
"itemtype": "method",
|
||||
"name": "add_widget",
|
||||
@@ -244,7 +244,31 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 171,
|
||||
"line": 172,
|
||||
"description": "Get the most left column below to add a new widget.",
|
||||
"itemtype": "method",
|
||||
"name": "next_position",
|
||||
"params": [
|
||||
{
|
||||
"name": "size_x",
|
||||
"description": "The nº of rows the widget occupies horizontally.",
|
||||
"type": "Number"
|
||||
},
|
||||
{
|
||||
"name": "size_y",
|
||||
"description": "The nº of columns the widget occupies vertically.",
|
||||
"type": "Number"
|
||||
}
|
||||
],
|
||||
"return": {
|
||||
"description": "Returns a grid coords object representing the future\n widget coords.",
|
||||
"type": "Object"
|
||||
},
|
||||
"class": "Gridster"
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 213,
|
||||
"description": "Remove a widget from the grid.",
|
||||
"itemtype": "method",
|
||||
"name": "remove_widget",
|
||||
@@ -263,7 +287,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 197,
|
||||
"line": 239,
|
||||
"description": "Returns a serialized array of the widgets in the grid.",
|
||||
"itemtype": "method",
|
||||
"name": "serialize",
|
||||
@@ -283,7 +307,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 219,
|
||||
"line": 261,
|
||||
"description": "Returns a serialized array of the widgets that have changed their position.",
|
||||
"itemtype": "method",
|
||||
"name": "serialize_changed",
|
||||
@@ -295,7 +319,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 231,
|
||||
"line": 273,
|
||||
"description": "Creates the grid coords object representing the widget a add it to the\nmapped array of positions.",
|
||||
"itemtype": "method",
|
||||
"name": "register_widget",
|
||||
@@ -307,7 +331,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 259,
|
||||
"line": 301,
|
||||
"description": "Update in the mapped array of positions the value of cells represented by\nthe grid coords object passed in the `grid_data` param.",
|
||||
"params": [
|
||||
{
|
||||
@@ -331,7 +355,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 280,
|
||||
"line": 322,
|
||||
"description": "Remove a widget from the mapped array of positions.",
|
||||
"itemtype": "method",
|
||||
"name": "remove_from_gridmap",
|
||||
@@ -350,7 +374,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 293,
|
||||
"line": 335,
|
||||
"description": "Add a widget to the mapped array of positions.",
|
||||
"itemtype": "method",
|
||||
"name": "add_to_gridmap",
|
||||
@@ -374,7 +398,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 315,
|
||||
"line": 357,
|
||||
"description": "Make widgets draggable. It Wraps the jQuery UI Draggable Plugin.",
|
||||
"itemtype": "method",
|
||||
"name": "draggable",
|
||||
@@ -386,7 +410,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 346,
|
||||
"line": 388,
|
||||
"description": "This function is executed when the player begins to be dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_drag",
|
||||
@@ -406,7 +430,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 395,
|
||||
"line": 437,
|
||||
"description": "This function is executed when the player is being dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_drag",
|
||||
@@ -426,7 +450,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 421,
|
||||
"line": 463,
|
||||
"description": "This function is executed when the player stops being dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_drag",
|
||||
@@ -446,7 +470,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 472,
|
||||
"line": 514,
|
||||
"description": "Executes the callbacks passed as arguments when a column begins to be\noverlapped or stops being overlapped.",
|
||||
"params": [
|
||||
{
|
||||
@@ -470,7 +494,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 512,
|
||||
"line": 554,
|
||||
"description": "Executes the callbacks passed as arguments when a row starts to be\noverlapped or stops being overlapped.",
|
||||
"params": [
|
||||
{
|
||||
@@ -494,7 +518,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 548,
|
||||
"line": 590,
|
||||
"description": "Sets the current position of the player",
|
||||
"params": [
|
||||
{
|
||||
@@ -518,7 +542,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 601,
|
||||
"line": 643,
|
||||
"description": "See which of the widgets in the $widgets param collection can go to\na upper row and which not.",
|
||||
"itemtype": "method",
|
||||
"name": "widgets_contraints",
|
||||
@@ -537,7 +561,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 637,
|
||||
"line": 679,
|
||||
"description": "Sorts an Array of grid coords objects (representing the grid coords of\neach widget) in ascending way.",
|
||||
"itemtype": "method",
|
||||
"name": "sort_by_row_asc",
|
||||
@@ -556,7 +580,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 657,
|
||||
"line": 699,
|
||||
"description": "Sorts an Array of grid coords objects (representing the grid coords of\neach widget) in descending way.",
|
||||
"itemtype": "method",
|
||||
"name": "sort_by_row_desc",
|
||||
@@ -575,7 +599,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 676,
|
||||
"line": 718,
|
||||
"description": "Sorts an Array of grid coords objects (representing the grid coords of\neach widget) in descending way.",
|
||||
"itemtype": "method",
|
||||
"name": "manage_movements",
|
||||
@@ -604,7 +628,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 722,
|
||||
"line": 764,
|
||||
"description": "Determines if there is a widget in the row and col given. Or if the\nHTMLElement passed as first argument is the player.",
|
||||
"itemtype": "method",
|
||||
"name": "is_player",
|
||||
@@ -629,7 +653,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 739,
|
||||
"line": 781,
|
||||
"description": "Determines if the widget that is being dragged is currently over the row\nand col given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_player_in",
|
||||
@@ -653,7 +677,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 754,
|
||||
"line": 796,
|
||||
"description": "Determines if the placeholder is currently over the row and col given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_placeholder_in",
|
||||
@@ -677,7 +701,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 768,
|
||||
"line": 810,
|
||||
"description": "Determines if the placeholder is currently over the column given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_placeholder_in_col",
|
||||
@@ -696,7 +720,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 780,
|
||||
"line": 822,
|
||||
"description": "Determines if the cell represented by col and row params is empty.",
|
||||
"itemtype": "method",
|
||||
"name": "is_empty",
|
||||
@@ -720,7 +744,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 799,
|
||||
"line": 841,
|
||||
"description": "Determines if the cell represented by col and row params is occupied.",
|
||||
"itemtype": "method",
|
||||
"name": "is_occupied",
|
||||
@@ -744,7 +768,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 819,
|
||||
"line": 861,
|
||||
"description": "Determines if there is a widget in the cell represented by col/row params.",
|
||||
"itemtype": "method",
|
||||
"name": "is_widget",
|
||||
@@ -768,7 +792,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 844,
|
||||
"line": 886,
|
||||
"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",
|
||||
@@ -792,7 +816,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 861,
|
||||
"line": 903,
|
||||
"description": "Get widgets overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_under_player",
|
||||
@@ -804,7 +828,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 883,
|
||||
"line": 925,
|
||||
"description": "Put placeholder at the row and column specified.",
|
||||
"itemtype": "method",
|
||||
"name": "set_placeholder",
|
||||
@@ -828,7 +852,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 925,
|
||||
"line": 967,
|
||||
"description": "Determines whether the player can move to a position above.",
|
||||
"itemtype": "method",
|
||||
"name": "can_go_player_up",
|
||||
@@ -847,7 +871,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 974,
|
||||
"line": 1016,
|
||||
"description": "Determines whether a widget can move to a position above.",
|
||||
"itemtype": "method",
|
||||
"name": "can_go_widget_up",
|
||||
@@ -866,7 +890,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1025,
|
||||
"line": 1067,
|
||||
"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",
|
||||
@@ -895,7 +919,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1103,
|
||||
"line": 1145,
|
||||
"description": "Get widgets overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_overlapped",
|
||||
@@ -907,7 +931,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1136,
|
||||
"line": 1178,
|
||||
"description": "This callback is executed when the player begins to collide with a column.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_overlapping_column",
|
||||
@@ -926,7 +950,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1148,
|
||||
"line": 1190,
|
||||
"description": "A callback executed when the player begins to collide with a row.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_overlapping_row",
|
||||
@@ -945,7 +969,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1160,
|
||||
"line": 1202,
|
||||
"description": "A callback executed when the the player ends to collide with a column.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_overlapping_column",
|
||||
@@ -964,7 +988,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1178,
|
||||
"line": 1220,
|
||||
"description": "This callback is executed when the player ends to collide with a row.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_overlapping_row",
|
||||
@@ -983,7 +1007,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1198,
|
||||
"line": 1240,
|
||||
"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",
|
||||
@@ -1002,7 +1026,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1241,
|
||||
"line": 1283,
|
||||
"description": "Move up the specified widget and all below it.",
|
||||
"itemtype": "method",
|
||||
"name": "move_widget_up",
|
||||
@@ -1027,7 +1051,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1287,
|
||||
"line": 1329,
|
||||
"description": "Move down the specified widget and all below it.",
|
||||
"itemtype": "method",
|
||||
"name": "move_widget_down",
|
||||
@@ -1051,7 +1075,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1332,
|
||||
"line": 1374,
|
||||
"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",
|
||||
@@ -1080,7 +1104,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1421,
|
||||
"line": 1463,
|
||||
"description": "Get widgets below a widget.",
|
||||
"itemtype": "method",
|
||||
"name": "widgets_below",
|
||||
@@ -1099,7 +1123,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1450,
|
||||
"line": 1492,
|
||||
"description": "Update the array of mapped positions with the new player position.",
|
||||
"itemtype": "method",
|
||||
"name": "set_cells_player_occupies",
|
||||
@@ -1123,7 +1147,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1467,
|
||||
"line": 1509,
|
||||
"description": "Remove from the array of mapped positions the reference to the player.",
|
||||
"itemtype": "method",
|
||||
"name": "empty_cells_player_occupies",
|
||||
@@ -1135,7 +1159,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1504,
|
||||
"line": 1546,
|
||||
"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",
|
||||
@@ -1164,7 +1188,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1539,
|
||||
"line": 1581,
|
||||
"description": "Given the leftmost column returns all columns that are overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_targeted_columns",
|
||||
@@ -1184,7 +1208,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1557,
|
||||
"line": 1599,
|
||||
"description": "Given the upper row returns all rows that are overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_targeted_rows",
|
||||
@@ -1204,7 +1228,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1574,
|
||||
"line": 1616,
|
||||
"description": "Get all columns and rows that a widget occupies.",
|
||||
"itemtype": "method",
|
||||
"name": "get_cells_occupied",
|
||||
@@ -1223,7 +1247,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1602,
|
||||
"line": 1644,
|
||||
"description": "Iterate over the cells occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_cell_occupied",
|
||||
@@ -1247,7 +1271,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1623,
|
||||
"line": 1665,
|
||||
"description": "Iterate over the columns occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_column_occupied",
|
||||
@@ -1271,7 +1295,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1642,
|
||||
"line": 1684,
|
||||
"description": "Iterate over the rows occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_row_occupied",
|
||||
@@ -1295,7 +1319,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1708,
|
||||
"line": 1750,
|
||||
"description": "Iterate over each widget above the column and row specified.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_widget_above",
|
||||
@@ -1324,7 +1348,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1724,
|
||||
"line": 1766,
|
||||
"description": "Iterate over each widget below the column and row specified.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_widget_below",
|
||||
@@ -1353,7 +1377,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1740,
|
||||
"line": 1782,
|
||||
"description": "Returns the highest occupied cell in the grid.",
|
||||
"itemtype": "method",
|
||||
"name": "get_highest_occupied_cell",
|
||||
@@ -1365,7 +1389,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1772,
|
||||
"line": 1814,
|
||||
"description": "Set the current height of the parent grid.",
|
||||
"itemtype": "method",
|
||||
"name": "set_dom_grid_height",
|
||||
@@ -1377,7 +1401,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1785,
|
||||
"line": 1827,
|
||||
"description": "It generates the neccessary styles to position the widgets.",
|
||||
"itemtype": "method",
|
||||
"name": "generate_stylesheet",
|
||||
@@ -1401,7 +1425,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1829,
|
||||
"line": 1871,
|
||||
"description": "Injects the given CSS as string to the head of the document.",
|
||||
"itemtype": "method",
|
||||
"name": "add_style_tag",
|
||||
@@ -1420,7 +1444,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1852,
|
||||
"line": 1894,
|
||||
"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",
|
||||
@@ -1444,7 +1468,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1888,
|
||||
"line": 1930,
|
||||
"description": "Recalculates the offsets for the faux grid. You need to use it when\nthe browser is resized.",
|
||||
"itemtype": "method",
|
||||
"name": "recalculate_faux_grid",
|
||||
@@ -1456,7 +1480,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1912,
|
||||
"line": 1954,
|
||||
"description": "Get all widgets in the DOM and register them.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_from_DOM",
|
||||
@@ -1468,7 +1492,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1926,
|
||||
"line": 1968,
|
||||
"description": "Calculate columns and rows to be set based on the configuration\n parameters, grid dimensions, etc ...",
|
||||
"itemtype": "method",
|
||||
"name": "generate_grid_and_stylesheet",
|
||||
|
||||
Reference in New Issue
Block a user