[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: 1 },
     { 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

@@ -9,7 +9,7 @@ import { graphDatasetActions, graphDatasetAtom, sigmaGraphAtom } from "../graph"
 import { dataGraphToFullGraph } from "../graph/utils";
 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" };
@@ -34,7 +34,7 @@ export const layoutStateAtom = atom<LayoutState>(getLocalStorageLayoutState());
  * Actions:
  * ********
  */
-export const startLayout = asyncAction(async (id: string, params: unknown) => {
+export const startLayout = asyncAction(async (id: Layout["id"], params: Record<string, unknown>) => {
   const { setNodePositions } = graphDatasetActions;
   const dataset = graphDatasetAtom.get();
 
@@ -62,7 +62,19 @@ export const startLayout = asyncAction(async (id: string, params: unknown) => {
 
   // Async layout
   if (layout && layout.type === "worker") {
-    const worker = new layout.supervisor(sigmaGraphAtom.get(), { settings: params });
+    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(graph, { settings: params });
     worker.start();
     layoutStateAtom.set((prev) => ({ ...prev, type: "running", layoutId: id, supervisor: worker }));
   }

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

@@ -534,6 +534,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

@@ -609,6 +609,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é"