Code cleanup

Author: ChristophPopp

content.js

@@ -12,10 +12,8 @@ if (isIE()) {
   // parse data only if tree not loaded already
   if (getDataFromSessionStorage(repoName + "Tree") === null) {
     let parsedData = parseData(dataHost, dataDict, jsonDataFile);
-    // let parsedTreeChildren = parseData(dataHost, dataDict, jsonTreeFile);
     if(!parsedData.length) throw new Error("index.js: Data error");
     keepDataInSessionStorage(repoName + "Tree", JSON.stringify(parsedData));
-    // keepDataInSessionStorage(repoName + "TreeChildren", JSON.stringify(parsedTreeChildren));
   }
 
   initGraph();

dag.js

@@ -45,7 +45,7 @@ function initGraph() {
     let data = structuredClone(treeData); // A clone is made to avoid any modifications in the original data
     for(let i=0;i<data.length;i++)
     {
-        ///Expand the nodes with no parents and initialize shownNodesMap with the shown nodes in the tree
+        // Expand the nodes with no parents and initialize shownNodesMap with the shown nodes in the tree
         // and nodeChildrenStateMap with the state of the node children(expanded or collapsed)
         if(data[i]["parentIds"].length === 0)
         {
@@ -61,18 +61,17 @@ function initGraph() {
                 shownNodesMap[data[i]["id"]] = 0;
             }
         }
-        ///Get nodes with no children to draw them without children expand/collapse button
+        // Get nodes with no children to draw them without children expand/collapse button
         if(getNodeChildren(data[i]["id"],data).length === 0)
         {
             leavesNodesIds.push(data[i]["id"])
         }
     }
-    ///Remove hidden parents of the nodes in the currentTree
+    // Remove hidden parents of the nodes in the currentTree
     for (let i = 0; i < currentTree.length; i++)
     {
         if(shownNodesMap[currentTree[i]["id"]] === 1)
         {
-            // currentTree[i]["parentIds"] = removeHiddenParents(currentTree[i]["id"]);
             removeHiddenParents(currentTree[i]["parentIds"]);
         }
     }
@@ -124,7 +123,6 @@ function initGraph() {
     let node = getNodeByTitle(d.currentTarget.__data__.data.title);
     $("#info_box").empty();
     addNodeInfos(node, "preview");
-    // document.getElementById("preview").scrollIntoView({ behavior: 'smooth' });
     updateGraphPlot(currentNodeId);
  }
 
@@ -137,7 +135,6 @@ function initGraph() {
    let node = getNodeByTitle(d.currentTarget.__data__.data.title);
    $("#info_box").empty();
    addNodeInfos(node, "preview");
-    // document.getElementById("preview").scrollIntoView({ behavior: 'smooth' });
    updateGraphPlot(currentNodeId);
 }
 
@@ -178,7 +175,6 @@ function initGraph() {
                   .text(word);
           }
       }
-      // set new box height
   });
 }
 /**
@@ -239,7 +235,7 @@ function onNodeParentsToggle(d)
  * @param {String} state node to be expanded or collapsed
  */
 function updateTree(currentNodeId,state){
-    let data = structuredClone(treeData);// A clone is made to avoid any modifications in the original data
+    let data = structuredClone(treeData); // A clone is made to avoid any modifications in the original data
     if(state === "children expand")
     {
         nodeChildrenExpand(currentNodeId,data);
@@ -262,8 +258,6 @@ function updateTree(currentNodeId,state){
     updateShownNodeMap(treeData)
     highlightSelectedNode(currentNodeId);
     updateTreeGraph(currentTree,currentNodeId, state);
-    // graph
-    //     .attr('transform', zoomTransform);
 }
 
 /**
@@ -281,7 +275,6 @@ function drawTree(drawData,state)
     // --------------------------------
     // This code only handles rendering
     // --------------------------------
-    // keepTopLayersNodesUp();
     svgSelection = d3.select("svg");
     svgSelection.selectAll('*').remove();
     if(state === "expand tree")
@@ -372,7 +365,7 @@ function drawTree(drawData,state)
         .attr("x", nodeWidth - 20 - (5 / 2))
         .html("i");
 
-    ///Filter nodes with no parent to add parents expand/collapse button
+    // Filter nodes with no parent to add parents expand/collapse button
     let rootsNodes = nodes.filter(function(node){
         return !nodeParentsStateMap[node.data.id];
     })
@@ -391,7 +384,7 @@ function drawTree(drawData,state)
         .attr("y",8.5)
         .html("+")
 
-    ///Filter nodes with no children to add expand/collapse button
+    // Filter nodes with no children to add expand/collapse button
     let leavesNodes = nodes.filter(function(node){
         return !leavesNodesIds.includes(node.data.id);
     })
@@ -493,7 +486,7 @@ function nodeChildrenExpand(currentNodeId,data)
     {
         if(data[i]["parentIds"].includes(currentNodeId))
         {
-            ///If the child is already shown, add the parent to it in currentTree
+            // If the child is already shown, add the parent to it in currentTree
             if(shownNodesMap[data[i]["id"]] === 1)
             {
                 for(let j = 0;j<currentTree.length;j++)
@@ -515,7 +508,7 @@ function nodeChildrenExpand(currentNodeId,data)
             nodeChildren.push(data[i]["id"]);
         }
     }
-    ///Link new nodes (clicked node children) to their existing children
+    // Link new nodes (clicked node children) to their existing children
     linkNewNodes(nodeChildren,data)
 }
 /**
@@ -621,7 +614,7 @@ function expandSearchedNodeTree(node)
         currentTree.push(node);
     }
     let nodeParentsQueue = node.parentIds.slice(0);
-    //show node parents till the top layer
+    // show node parents till the top layer
     while(nodeParentsQueue.length > 0)
     {
         let parentId = nodeParentsQueue.shift();
@@ -635,7 +628,7 @@ function expandSearchedNodeTree(node)
             nodeParentsQueue.push(elem);
         })
     }
-    //show node children
+    // show node children
     let children = getNodeChildren(node.id,data);
     children.forEach(function(child){
         if(shownNodesMap[child.id] !==1)
@@ -727,7 +720,6 @@ function updateTreeGraph(drawData,currentNodeId,state)
     graph.select(".paths-list").selectAll("*").remove();
     generateTreeLayout(drawData);
     layout(dag);
-    // keepTopLayersNodesUp();
 
     // Remove collapsed nodes before starting the animation
     let collapsedNodes = nodes.filter(function(node){
@@ -822,7 +814,7 @@ function keepTopLayersNodesUp()
 {
     let rootsNodesY = 100000;
     let rootsNodesX = [];
-    //get roots nodes y-coordinate(the minimum to make it constant for all of them) and x-coordinates
+    // get roots nodes y-coordinate(the minimum to make it constant for all of them) and x-coordinates
     dag.descendants().forEach(function(node){
         if(node.y<rootsNodesY)
         {
@@ -836,7 +828,7 @@ function keepTopLayersNodesUp()
     rootsNodesX.sort(function(a, b){return a - b});
     let xStep = (rootsNodesX[rootsNodesIds.length - 1] - rootsNodesX[0])/rootsNodesIds.length;//horizontal space between roots nodes
     let i = 0;
-    //Set the new coordinates to the roots nodes
+    // Set the new coordinates to the roots nodes
     dag.descendants().forEach(function(node){
         if(rootsNodesIds.includes(node.data.id))
         {
@@ -846,7 +838,7 @@ function keepTopLayersNodesUp()
             i+=1;
         }
     })
-    //Set the new coordinates to the roots nodes links
+    // Set the new coordinates to the roots nodes links
     dag.links().forEach(function(node){
         if(rootsNodesIds.includes(node.source.data.id))
         {

helper.js

@@ -4,9 +4,6 @@
 if (!HTMLCollection.prototype.forEach) {
   HTMLCollection.prototype.forEach = Array.prototype.forEach;
 }
-/*if (!Object.prototype.forEach) {
-  Object.prototype.forEach = Array.prototype.forEach;
-}*/
 if (!HTMLCollection.prototype.indexOf) {
   HTMLCollection.prototype.indexOf = Array.prototype.indexOf;
 }
@@ -73,10 +70,8 @@ function addNodeInfos(node, id) {
         value.push(["Decomposition Block", node.decomBlock.replaceAll("\\n", "<br><br>")]);
         break;
       case "number of parent nodes":
-        //value.push([a, getNumberOfParents(node)]);
         break;
       case "number of child nodes":
-        //value.push([a, getNumberOfChildren(node)]);
         break;
       case "references":
         value = prepareReferencesInfo(node.references);
@@ -212,15 +207,13 @@ function jumpToSearch() {
  * @returns 
  */
 function addAutoComplete(input) {
-  // TODO switch to jQuery
-
   let tree = JSON.parse(getDataFromSessionStorage(repoName + "Tree"));
   if (!tree) return;
 
   // collect all nodes names in tree
   let arr = [];
   let tagsArr = [];
-  let tagsTitlesMap = {};//map that links each tag to its associated titles.
+  let tagsTitlesMap = {}; // map that links each tag to its associated titles.
   tree.forEach(function (n) {
     if (!arr.includes(n.title)) {
       arr.push(n.title);
@@ -250,7 +243,7 @@ function addAutoComplete(input) {
   let currentFocus;
   input.addEventListener("input", function () {
     let val = this.value;
-    let titlesMap = {};//check if the title already in the search results to avoid duplicates.
+    let titlesMap = {}; // check if the title already in the search results to avoid duplicates.
 
     // close already open lists
     closeAllLists();
@@ -308,8 +301,7 @@ function addAutoComplete(input) {
 
   });
 
-  function checkSearchBarValue(data,searchVal)
-  {
+  function checkSearchBarValue(data,searchVal) {
     let includes = false;
     if (data.toLowerCase().includes(searchVal.toLowerCase())) {
       includes = true;
@@ -382,7 +374,6 @@ function prepareReferencesInfo(referenceString){
   let preparedRefString = referenceString
   .replace("[", "")
   .replaceAll("]", "")
-  //.replaceAll(/[\s]/g, "")
   .split("[")
   .filter(function (e) { return e != ""; });
 

style.css

@@ -358,8 +358,6 @@ body {
 }
 
 .content #info_box {
-  /*margin-top: 20px;*/
-  /*display: inline-block;*/
   overflow-y: scroll;
   height: 96%;
 }