mirror of
https://github.com/stylersnico/librenms.git
synced 2026-07-28 00:24:21 +02:00
updated docs and diet
This commit is contained in:
+53
-53
@@ -410,7 +410,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 392,
|
||||
"line": 395,
|
||||
"description": "This function is executed when the player begins to be dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_drag",
|
||||
@@ -430,7 +430,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 441,
|
||||
"line": 444,
|
||||
"description": "This function is executed when the player is being dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_drag",
|
||||
@@ -450,7 +450,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 467,
|
||||
"line": 470,
|
||||
"description": "This function is executed when the player stops being dragged.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_drag",
|
||||
@@ -470,7 +470,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 518,
|
||||
"line": 521,
|
||||
"description": "Executes the callbacks passed as arguments when a column begins to be\noverlapped or stops being overlapped.",
|
||||
"params": [
|
||||
{
|
||||
@@ -494,7 +494,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 558,
|
||||
"line": 561,
|
||||
"description": "Executes the callbacks passed as arguments when a row starts to be\noverlapped or stops being overlapped.",
|
||||
"params": [
|
||||
{
|
||||
@@ -518,7 +518,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 594,
|
||||
"line": 597,
|
||||
"description": "Sets the current position of the player",
|
||||
"params": [
|
||||
{
|
||||
@@ -542,7 +542,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 647,
|
||||
"line": 650,
|
||||
"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",
|
||||
@@ -561,7 +561,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 683,
|
||||
"line": 686,
|
||||
"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",
|
||||
@@ -580,7 +580,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 703,
|
||||
"line": 706,
|
||||
"description": "Sorts an Array of grid coords objects by column (representing the grid\ncoords of each widget) in ascending way.",
|
||||
"itemtype": "method",
|
||||
"name": "sort_by_row_asc",
|
||||
@@ -599,7 +599,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 723,
|
||||
"line": 726,
|
||||
"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",
|
||||
@@ -618,7 +618,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 742,
|
||||
"line": 745,
|
||||
"description": "Sorts an Array of grid coords objects (representing the grid coords of\neach widget) in descending way.",
|
||||
"itemtype": "method",
|
||||
"name": "manage_movements",
|
||||
@@ -647,7 +647,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 788,
|
||||
"line": 791,
|
||||
"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",
|
||||
@@ -672,7 +672,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 805,
|
||||
"line": 808,
|
||||
"description": "Determines if the widget that is being dragged is currently over the row\nand col given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_player_in",
|
||||
@@ -696,7 +696,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 820,
|
||||
"line": 823,
|
||||
"description": "Determines if the placeholder is currently over the row and col given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_placeholder_in",
|
||||
@@ -720,7 +720,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 834,
|
||||
"line": 837,
|
||||
"description": "Determines if the placeholder is currently over the column given.",
|
||||
"itemtype": "method",
|
||||
"name": "is_placeholder_in_col",
|
||||
@@ -739,7 +739,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 846,
|
||||
"line": 850,
|
||||
"description": "Determines if the cell represented by col and row params is empty.",
|
||||
"itemtype": "method",
|
||||
"name": "is_empty",
|
||||
@@ -763,7 +763,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 865,
|
||||
"line": 869,
|
||||
"description": "Determines if the cell represented by col and row params is occupied.",
|
||||
"itemtype": "method",
|
||||
"name": "is_occupied",
|
||||
@@ -787,7 +787,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 885,
|
||||
"line": 889,
|
||||
"description": "Determines if there is a widget in the cell represented by col/row params.",
|
||||
"itemtype": "method",
|
||||
"name": "is_widget",
|
||||
@@ -811,7 +811,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 910,
|
||||
"line": 914,
|
||||
"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",
|
||||
@@ -835,7 +835,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 927,
|
||||
"line": 931,
|
||||
"description": "Get widgets overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_under_player",
|
||||
@@ -847,7 +847,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 949,
|
||||
"line": 953,
|
||||
"description": "Put placeholder at the row and column specified.",
|
||||
"itemtype": "method",
|
||||
"name": "set_placeholder",
|
||||
@@ -871,7 +871,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 991,
|
||||
"line": 995,
|
||||
"description": "Determines whether the player can move to a position above.",
|
||||
"itemtype": "method",
|
||||
"name": "can_go_player_up",
|
||||
@@ -890,7 +890,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1040,
|
||||
"line": 1044,
|
||||
"description": "Determines whether a widget can move to a position above.",
|
||||
"itemtype": "method",
|
||||
"name": "can_go_widget_up",
|
||||
@@ -909,7 +909,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1091,
|
||||
"line": 1095,
|
||||
"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",
|
||||
@@ -938,7 +938,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1169,
|
||||
"line": 1173,
|
||||
"description": "Get widgets overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_overlapped",
|
||||
@@ -950,7 +950,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1202,
|
||||
"line": 1206,
|
||||
"description": "This callback is executed when the player begins to collide with a column.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_overlapping_column",
|
||||
@@ -969,7 +969,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1214,
|
||||
"line": 1218,
|
||||
"description": "A callback executed when the player begins to collide with a row.",
|
||||
"itemtype": "method",
|
||||
"name": "on_start_overlapping_row",
|
||||
@@ -988,7 +988,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1226,
|
||||
"line": 1230,
|
||||
"description": "A callback executed when the the player ends to collide with a column.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_overlapping_column",
|
||||
@@ -1007,7 +1007,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1244,
|
||||
"line": 1248,
|
||||
"description": "This callback is executed when the player ends to collide with a row.",
|
||||
"itemtype": "method",
|
||||
"name": "on_stop_overlapping_row",
|
||||
@@ -1026,7 +1026,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1264,
|
||||
"line": 1268,
|
||||
"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",
|
||||
@@ -1045,7 +1045,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1307,
|
||||
"line": 1311,
|
||||
"description": "Move up the specified widget and all below it.",
|
||||
"itemtype": "method",
|
||||
"name": "move_widget_up",
|
||||
@@ -1070,7 +1070,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1353,
|
||||
"line": 1357,
|
||||
"description": "Move down the specified widget and all below it.",
|
||||
"itemtype": "method",
|
||||
"name": "move_widget_down",
|
||||
@@ -1094,7 +1094,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1398,
|
||||
"line": 1402,
|
||||
"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",
|
||||
@@ -1123,7 +1123,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1487,
|
||||
"line": 1491,
|
||||
"description": "Get widgets below a widget.",
|
||||
"itemtype": "method",
|
||||
"name": "widgets_below",
|
||||
@@ -1142,7 +1142,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1516,
|
||||
"line": 1520,
|
||||
"description": "Update the array of mapped positions with the new player position.",
|
||||
"itemtype": "method",
|
||||
"name": "set_cells_player_occupies",
|
||||
@@ -1166,7 +1166,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1533,
|
||||
"line": 1537,
|
||||
"description": "Remove from the array of mapped positions the reference to the player.",
|
||||
"itemtype": "method",
|
||||
"name": "empty_cells_player_occupies",
|
||||
@@ -1178,7 +1178,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1570,
|
||||
"line": 1574,
|
||||
"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",
|
||||
@@ -1207,7 +1207,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1605,
|
||||
"line": 1608,
|
||||
"description": "Given the leftmost column returns all columns that are overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_targeted_columns",
|
||||
@@ -1227,7 +1227,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1623,
|
||||
"line": 1626,
|
||||
"description": "Given the upper row returns all rows that are overlapping with the player.",
|
||||
"itemtype": "method",
|
||||
"name": "get_targeted_rows",
|
||||
@@ -1247,7 +1247,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1640,
|
||||
"line": 1643,
|
||||
"description": "Get all columns and rows that a widget occupies.",
|
||||
"itemtype": "method",
|
||||
"name": "get_cells_occupied",
|
||||
@@ -1266,7 +1266,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1668,
|
||||
"line": 1671,
|
||||
"description": "Iterate over the cells occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_cell_occupied",
|
||||
@@ -1290,7 +1290,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1689,
|
||||
"line": 1692,
|
||||
"description": "Iterate over the columns occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_column_occupied",
|
||||
@@ -1314,7 +1314,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1708,
|
||||
"line": 1711,
|
||||
"description": "Iterate over the rows occupied by a widget executing a function for\neach one.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_row_occupied",
|
||||
@@ -1338,7 +1338,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1774,
|
||||
"line": 1777,
|
||||
"description": "Iterate over each widget above the column and row specified.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_widget_above",
|
||||
@@ -1367,7 +1367,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1790,
|
||||
"line": 1793,
|
||||
"description": "Iterate over each widget below the column and row specified.",
|
||||
"itemtype": "method",
|
||||
"name": "for_each_widget_below",
|
||||
@@ -1396,7 +1396,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1806,
|
||||
"line": 1809,
|
||||
"description": "Returns the highest occupied cell in the grid.",
|
||||
"itemtype": "method",
|
||||
"name": "get_highest_occupied_cell",
|
||||
@@ -1408,7 +1408,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1838,
|
||||
"line": 1841,
|
||||
"description": "Set the current height of the parent grid.",
|
||||
"itemtype": "method",
|
||||
"name": "set_dom_grid_height",
|
||||
@@ -1420,7 +1420,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1852,
|
||||
"line": 1855,
|
||||
"description": "It generates the neccessary styles to position the widgets.",
|
||||
"itemtype": "method",
|
||||
"name": "generate_stylesheet",
|
||||
@@ -1444,7 +1444,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1896,
|
||||
"line": 1899,
|
||||
"description": "Injects the given CSS as string to the head of the document.",
|
||||
"itemtype": "method",
|
||||
"name": "add_style_tag",
|
||||
@@ -1463,7 +1463,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1919,
|
||||
"line": 1922,
|
||||
"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",
|
||||
@@ -1487,7 +1487,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1955,
|
||||
"line": 1958,
|
||||
"description": "Recalculates the offsets for the faux grid. You need to use it when\nthe browser is resized.",
|
||||
"itemtype": "method",
|
||||
"name": "recalculate_faux_grid",
|
||||
@@ -1499,7 +1499,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1979,
|
||||
"line": 1982,
|
||||
"description": "Get all widgets in the DOM and register them.",
|
||||
"itemtype": "method",
|
||||
"name": "get_widgets_from_DOM",
|
||||
@@ -1511,7 +1511,7 @@
|
||||
},
|
||||
{
|
||||
"file": "src/jquery.gridster.js",
|
||||
"line": 1993,
|
||||
"line": 1996,
|
||||
"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