[phylotree] fix edge cases surrounding display of branch labels

Fixes a couple of edge cases introduced by the scatterplot functionality which would result in a tree rendering with branch labels when it shouldn't have them (and vice versa).
nextstrain · Mar 30, 2021 · a80e186 · a80e186
1 parent 0751e81
commit a80e186
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/src/components/tree/phyloTree/change.js b/src/components/tree/phyloTree/change.js
@@ -150,7 +150,7 @@ export const modifySVG = function modifySVG(elemsToUpdate, svgPropsToUpdate, tra
   });
 
   /* special cases not listed in classesToPotentiallyUpdate */
-  if (elemsToUpdate.has('.branchLabel')) {
+  if (elemsToUpdate.has('.branchLabel') && !extras.newBranchLabellingKey) {
     this.updateBranchLabels(transitionTime);
   }
   if (extras.hideTipLabels) {

diff --git a/src/components/tree/reactD3Interface/change.js b/src/components/tree/reactD3Interface/change.js
@@ -56,7 +56,8 @@ export const changePhyloTreeViaPropsComparison = (mainTree, phylotree, oldProps,
     args.newBranchLabellingKey = "none";
   } else if (
     (oldProps.canRenderBranchLabels===false && newProps.canRenderBranchLabels===true) ||
-    (oldProps.selectedBranchLabel !== newProps.selectedBranchLabel)
+    (oldProps.selectedBranchLabel !== newProps.selectedBranchLabel) ||
+    (oldProps.scatterVariables.showBranches===false && newProps.scatterVariables.showBranches===true)
   ) {
     args.newBranchLabellingKey = newProps.selectedBranchLabel;
   }

diff --git a/src/components/tree/reactD3Interface/initialRender.js b/src/components/tree/reactD3Interface/initialRender.js
@@ -12,6 +12,11 @@ export const renderTree = (that, main, phylotree, props) => {
     console.warn("can't run renderTree (not loaded)");
     return;
   }
+  // calculate if branch labels should be rendered
+  let renderBranchLabels = props.canRenderBranchLabels;
+  if (Object.prototype.hasOwnProperty.call(props.scatterVariables, "showBranches") && props.scatterVariables.showBranches===false) {
+    renderBranchLabels=false;
+  }
   /* simply the call to phylotree.render */
   phylotree.render(
     select(ref),
@@ -20,7 +25,7 @@ export const renderTree = (that, main, phylotree, props) => {
     { /* parameters (modifies PhyloTree's defaults) */
       grid: true,
       confidence: props.temporalConfidence.display,
-      branchLabelKey: props.canRenderBranchLabels && props.selectedBranchLabel,
+      branchLabelKey: renderBranchLabels && props.selectedBranchLabel,
       orientation: main ? [1, 1] : [-1, 1],
       tipLabels: true,
       showTipLabels: true