[layout] fixed node for FA2

Author: sim51

packages/gephi-lite/src/core/layouts/collection/forceAtlas2.ts

@@ -76,5 +76,12 @@ export const ForceAtlas2Layout = {
     },
     { id: "slowDown", type: "number", defaultValue: FA2_DEFAULT_SETTINGS.slowDown, min: 1, step:"any"},
     { id: "strongGravityMode", type: "boolean", defaultValue: FA2_DEFAULT_SETTINGS.strongGravityMode },
+    {
+      id: "getNodeFixedAttribut",
+      type: "attribute",
+      itemType: "nodes",
+      restriction: ["boolean"],
+      required: false,
+    },
   ],
 } as WorkerLayout<ForceAtlas2LayoutParameters>;

packages/gephi-lite/src/core/layouts/index.ts

@@ -10,7 +10,7 @@ import { dataGraphToFullGraph } from "../graph/utils";
 import { sessionAtom } from "../session";
 import { resetCamera } from "../sigma";
 import { LAYOUTS } from "./collection";
-import { LayoutMapping, LayoutQuality, LayoutState } from "./types";
+import { type Layout, LayoutMapping, LayoutQuality, LayoutState } from "./types";
 
 function getEmptyLayoutState(): LayoutState {
   return { quality: { enabled: false, showGrid: true }, type: "idle" };
@@ -59,10 +59,11 @@ export const stopLayout = asyncAction(async (isForRestart = false) => {
   if (!isForRestart) layoutStateAtom.set((prev) => ({ ...prev, type: "idle" }));
 });
 
-export const startLayout = asyncAction(async (id: string, params: unknown, isForRestart = false) => {
+export const startLayout = asyncAction(async (id: string, params: Record<string, unknown>, isForRestart = false) => {
   // Stop the previous algo (the "if needed" is done in the function itself)
   await stopLayout(isForRestart);
 
+  const dataset = graphDatasetAtom.get();
   const { setNodePositions } = graphDatasetActions;
 
   // search the layout
@@ -74,7 +75,6 @@ export const startLayout = asyncAction(async (id: string, params: unknown, isFor
       layoutStateAtom.set((prev) => ({ ...prev, type: "running", layoutId: id, supervisor: undefined }));
 
       // generate positions
-      const dataset = graphDatasetAtom.get();
       const fullGraph = dataGraphToFullGraph(dataset);
       const positions = layout.run(fullGraph, { settings: params });
 
@@ -91,6 +91,18 @@ export const startLayout = asyncAction(async (id: string, params: unknown, isFor
 
     // Async layout
     if (layout.type === "worker") {
+      const graph = sigmaGraphAtom.get();
+
+      // If layout parameter has a `getNodeFixedAttribut`, then we have to set the 'fixed'
+      // attribut in sigma's graph
+      if ("getNodeFixedAttribut" in params && params.getNodeFixedAttribut) {
+        const fixedAttribut = `${params.getNodeFixedAttribut}`;
+        graph.updateEachNodeAttributes((id, attrs) => ({
+          ...attrs,
+          fixed: dataset.nodeData[id][fixedAttribut] === true,
+        }));
+      }
+
       const worker = new layout.supervisor(sigmaGraphAtom.get(), { settings: params });
       worker.start();
       layoutStateAtom.set((prev) => ({ ...prev, type: "running", layoutId: id, supervisor: worker }));

packages/gephi-lite/src/locales/dev.json

@@ -539,6 +539,9 @@
           "description": "Influence of the edge’s weights on the layout",
           "title": "Edge weight influence"
         },
+        "getNodeFixedAttribut": {
+          "title": "Attribute indicating whether the node’s position is fixed"
+        },
         "gravity": {
           "description": "Strength of the layout’s gravity",
           "title": "Gravity"

packages/gephi-lite/src/locales/fr.json

@@ -613,6 +613,9 @@
           "description": "Influence des poids des liens sur la spatialisation",
           "title": "Influence du poids des liens"
         },
+        "getNodeFixedAttribut": {
+          "title": "Attribut indiquant si la position du nœud est fixée"
+        },
         "gravity": {
           "description": "Intensité de la gravité de la spatialisation",
           "title": "Gravité"