fix(scatter): SJIP-954 adjust marker layer annotation position

Ferlab-Ste-Justine · Sep 25, 2024 · 675b7e7 · 675b7e7
1 parent 83ee250
commit 675b7e7
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 9 deletions.
diff --git a/packages/ui/Release.md b/packages/ui/Release.md
@@ -1,3 +1,6 @@
+### 10.10.1 2024-09-24
+- fix: SJIP-954 adjust marker layer annotation position
+
 ### 10.10.0 2024-09-24
 - fix: SJIP-958 feat add bordered style to basic description
 

diff --git a/packages/ui/package-lock.json b/packages/ui/package-lock.json
diff --git a/packages/ui/package.json b/packages/ui/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@ferlab/ui",
-    "version": "10.10.0",
+    "version": "10.10.1",
     "description": "Core components for scientific research data portals",
     "publishConfig": {
         "access": "public"

diff --git a/packages/ui/src/components/Charts/ScatterPlot/Canvas/Layers/MarkerCanvasLayer.tsx b/packages/ui/src/components/Charts/ScatterPlot/Canvas/Layers/MarkerCanvasLayer.tsx
@@ -1,5 +1,3 @@
-import { ScatterPlotDatum, ScatterPlotNodeData } from '@nivo/scatterplot';
-
 import { TCanvasLayer } from './type';
 
 type TMarkerCanvasLayer = TCanvasLayer & {
@@ -10,11 +8,17 @@ type TMarkerCanvasLayer = TCanvasLayer & {
     font: string;
 };
 
+const DIRECTION_THRESHOLD = 60;
+
 /**
  * Try to replicate svg's annotation behavior
  *
+ * Chart must have a padding top of at least the size of the radius
+ *
+ * e.g.radius is 12px, chart must have a padding-top of 12 px.
+ *  If not, the top element will be cut when rendering
+ *
  * Nivo's doc said that annotation props is supported but it was a lie
- * @returns
  */
 const MarkerCanvasLayer = ({
     ctx,
@@ -31,7 +35,8 @@ const MarkerCanvasLayer = ({
     const target = props.nodes.find((node) => node.id === selectedNodeId);
     if (!target) return;
 
-    const textPosition = { x: target.x + 30, y: target.y - 30 };
+    const direction = target.y < DIRECTION_THRESHOLD ? -1 : 1;
+    const textPosition = { x: target.x + 30, y: target.y - 30 * direction };
     const underlineOffset = { x: 7, y: 7 };
     const underlineLength = 45;
     ctx.beginPath();

diff --git a/packages/ui/src/components/Charts/ScatterPlot/index.module.css b/packages/ui/src/components/Charts/ScatterPlot/index.module.css
@@ -3,7 +3,7 @@
   flex-direction: column;
   height: 100%;
   width: 100%;
-  gap: 48px;
+  gap: 12px;
 }
 
 .controls {

diff --git a/packages/ui/src/components/Charts/SwarmPlot/index.module.css b/packages/ui/src/components/Charts/SwarmPlot/index.module.css
@@ -3,7 +3,7 @@
   flex-direction: column;
   height: 100%;
   width: 100%;
-  gap: 48px;
+  gap: 24px;
 }
 
 .controls {