lint/doc scatterplot.js

Author: spond

src/hiv_tx_network.js

@@ -827,23 +827,22 @@ class HIVTxNetwork {
   
       validate the list of CoI
   
-      @param groups [array] is a list of CoI
-
-      name: unique string
-      description: string,
-      nodes: {
-          {
-              'id' : node id,
-              'added' : date,
-              'kind' : enum (one of _cdcPrioritySetNodeKind)
-          }
-      },
-      created: date,
-      kind: enum (one of kGlobals.CDCCOIKind),
-      tracking: enum (one of kGlobals.CDCCOITrackingOptions)
-      createdBy : enum (on of [kGlobals.CDCCOICreatedBySystem,kGlobals.CDCCOICreatedManually])
+      @param groups {array} is a list of CoI
+              name: unique string
+              description: string,
+              nodes: {
+                  {
+                      'id' : node id,
+                      'added' : date,
+                      'kind' :  _cdcPrioritySetNodeKind
+                  }
+              },
+              created: date,
+              kind:  kGlobals.CDCCOIKind,
+              tracking: kGlobals.CDCCOITrackingOptions
+              createdBy : kGlobals.CDCCOICreatedBySystem,kGlobals.CDCCOICreatedManually
 
-      @param auto_extend [bool] : if true, automatically expand existing CoI
+      @param auto_extend {bool} : if true, automatically expand existing CoI
 
     */
   priority_groups_validate(groups, auto_extend) {

src/scatterplot.js

@@ -1,28 +1,37 @@
 var d3 = require("d3");
 
+/**
+ * Renders a scatter plot using D3.js.
+
+ * @param {Object[]} points - An array of data points, each with x and y coordinates (and optionally a title).
+ * @param {number} w - The width of the plot area.
+ * @param {number} h - The height of the plot area.
+ * @param {string} id - The ID of the HTML element where the plot will be rendered.
+ * @param {Object} labels - An object containing labels for the x and y axes.
+ * @param {boolean} [dates=false] - A flag indicating whether the x-axis should represent dates.
+
+ * @returns {void}
+ */
+
 function hivtrace_render_scatterplot(points, w, h, id, labels, dates) {
   var _defaultFloatFormat = d3.format(",.2r");
   var _defaultDateViewFormatShort = d3.time.format("%B %Y");
 
   var margin = {
-    top: 10,
-    right: 10,
-    bottom: 100,
-    left: 100,
-  },
+      top: 10,
+      right: 10,
+      bottom: 100,
+      left: 100,
+    },
     width = w - margin.left - margin.right,
     height = h - margin.top - margin.bottom;
 
   var x = (dates ? d3.time.scale() : d3.scale.linear())
-    .domain(
-      d3.extent(points, (p) => p.x)
-    )
+    .domain(d3.extent(points, (p) => p.x))
     .range([0, width]);
 
   var y = (dates ? d3.time.scale() : d3.scale.linear())
-    .domain(
-      d3.extent(points, (p) => p.y)
-    )
+    .domain(d3.extent(points, (p) => p.y))
     .range([height, 0]);
 
   var xAxis = d3.svg