Changeset 9302 for src/django_gheat/website/static/heatmap_extensions.js

Timestamp:

Jun 27, 2011, 4:00:01 PM (13 years ago)

Author:

dennisw

Message:

Added/changed/clarified some comments in code.

File:

• src/django_gheat/website/static/heatmap_extensions.js (modified) (15 diffs)

src/django_gheat/website/static/heatmap_extensions.js

@@ -1 @@
-// Uses zoomlevel and mouseposition to call the nodelist.py view. View returns nodes in json format which is read and printed in document element.
+/**
+ * Uses zoomleven and mouseposition to call nodelist.py view.
+ * View returns nodes in json format, values are printed in doc element.
+ */
 function getNodeList(zoomlevel, mousepos){
   $.getJSON("/website/nodelist/" + zoomlevel + "," + mousepos.lat + "," + mousepos.lon, 
@@ -13 +16 @@
 }
 
-// Right way to get url parameters?: http://stackoverflow.com/questions/1403888/get-url-parameter-with-jquery/1404100#1404100
+/**
+ * Right way to get url parameters?
+ * http://stackoverflow.com/questions/1403888/get-url-parameter-with-jquery/1404100#1404100
+ */
 function getURLParameter(name) {
   return decodeURI(
@@ -25 +31 @@
   var nodelist = new Array();
 
-  // add colour picker
+  /**
+   * Adds colourpicker for layer colour.
+   * Function set in: 'colourpicker.js'
+   */
   $("#colour").colorPicker();
 
-  // add date picker for start date
+  /**
+   * Adds datepicker for start & end date
+   * Function set in: 'jquery-ui-1.8.13.custom.min.js'
+   */
   $("#start_date").datepicker({
     dateFormat: "dd/mm/yy",
@@ -35 +47 @@
     }
   });
-
-  // add date picker for end date
   $("#end_date").datepicker({
     dateFormat: "dd/mm/yy",
   });
 
-  // add slider for signal strength filter
+  /**
+   * Adds slider for signal strength layer.
+   * Function set in: 'jquery-ui-1.8.13.custom.min.js'
+   */
   $("#slider").slider({
     range: true,
@@ -61 +74 @@
   });
 
-  // toggle layer visibility
+  /**
+   * Toggles layer visibility on checkbox use from layerswitcher.
+   */
   $("#togglelayer").live('click', function(){
     status = $(this).attr("checked");
@@ -69 +84 @@
   }); 
 
-  // toggle layer visibility per category
+  /**
+   * Toggles layer visibility per category on checkbox use from layerswitcher.
+   */
   $("#togglecat").live("click", function(){
     if($(this).attr("checked")){
@@ -87 +104 @@
   });
 
-  // remove layer
+  /**
+   * Removes layer from map and layerswitcher.
+   */
   $("#rmvlayer").live("click", function(){
     layername = $(this).closest('span').attr('id');
@@ -95 +114 @@
   });
 
-  // menu toggle
+  /**
+   * Toggles text shown on website.
+   * 'info' shows info text.
+   * 'filter' page shows text on filters & filter options.
+   */
   $("#menu_filter").click(function(){
     $("#filter").slideToggle("fast");
@@ -105 +128 @@
   });
 
-  // switcher toggle
+  /**
+   * Toggles layerswitcher visibility.
+   * On 'off', toggler shows a '+'.
+   * On 'on', toggler shows a '-'.
+   */
   $("#layer_switcher_toggle").click(function(){
     $("#layer_switcher").toggle();
@@ -116 +143 @@
   });
 
-  // Fastest?: http://stackoverflow.com/questions/170986/what-is-the-best-way-to-add-options-to-a-select-from-an-array-with-jquery
+  /**
+   * Fastest?
+   * http://stackoverflow.com/questions/170986/what-is-the-best-way-to-add-options-to-a-select-from-an-array-with-jquery
+   */
   $.getJSON("/website/filters/",
     function(json) {
@@ -123 +153 @@
         userlist.push(json.gebruiker);
         $.each(json.meetrondje, function(m, meetrondje){
+          console.log(meetrondje.datum);
           $("#select_dataset").append($("<option/>").attr({"class":json.gebruiker, "value":meetrondje.naam}).text(meetrondje.naam));
           $.each(meetrondje.nodes, function(n, nodes){
@@ -138 +169 @@
   );
 
-  // add filter per user
+  /**
+   * Earlier process got all users in JSON and put them in array.
+   * For each user in array, new layer is added with username as parameter.
+   * Layercolour is randomized.
+   * If button is pressed again, layers will be deleted.
+   */
   $('#user_filter').click(function(){
     if(this.text=='(Add all users)'){
@@ -169 +205 @@
   });
 
-  // add filter per node
+  /**
+   * Earlier process got all nodes in JSON and put them in array.
+   * For each node in array, new layer is added with node as parameter.
+   * Layercolour is randomized.
+   * If button is pressed again, layers will be deleted.
+   */
   $('#node_filter').click(function(){
     if(this.text=='(Add all nodes)'){
@@ -201 +242 @@
   });
 
-  // add custom filter
+  /**
+   * Adds a new layer when clicked.
+   * Filters set by user are used as layer parameters.
+   * Colour is either chosen or randomized.
+   * Blank parameters are ignored.
+   */
   $('#add_filter').click(function(){
-    //get values from elements
+    // get values from elements
     user = $('#select_user option:selected').text();
     dataset = $('#select_dataset option:selected').text();
@@ -212 +258 @@
     lname = encodeURIComponent(document.getElementById("lname").value);
 
-    // HEX to RGB: http://stackoverflow.com/questions/5798868/need-some-tips-with-how-to-convert-a-hexadecimal-color-value-to-a-rgb-one/5798900#5798900
-    // '#' comes out as '%23', so substr() starts at char 3
+    /**
+     * On HEX to RGB:
+     * http://stackoverflow.com/questions/5798868/need-some-tips-with-how-to-convert-a-hexadecimal-color-value-to-a-rgb-one/5798900#5798900
+     * Note that '#' comes out as '%23', so substr() starts at char 3
+     */
     colour = parseInt((colour.substr(3, 2)),16) + ',' + parseInt((colour.substr(5, 2)),16) + ',' + parseInt((colour.substr(7, 2)),16);