@graphty/layout 1.3.2 → 1.5.0

package/README.md

@@ -1,12 +1,13 @@
-# Layout
+# @graphty/layout
 
-[![CI](https://github.com/graphty-org/layout/actions/workflows/ci.yml/badge.svg)](https://github.com/graphty-org/layout/actions/workflows/ci.yml)
-[![Coverage Status](https://coveralls.io/repos/github/graphty-org/layout/badge.svg?branch=main)](https://coveralls.io/github/graphty-org/layout?branch=main)
-[![npm version](https://badge.fury.io/js/%40graphty%2Flayout.svg)](https://badge.fury.io/js/%40graphty%2Flayout)
+[![CI](https://github.com/graphty-org/graphty-monorepo/actions/workflows/ci.yml/badge.svg)](https://github.com/graphty-org/graphty-monorepo/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/graphty-org/graphty-monorepo/badge.svg?branch=master)](https://coveralls.io/github/graphty-org/graphty-monorepo?branch=master)
+[![npm version](https://img.shields.io/npm/v/@graphty/layout.svg)](https://www.npmjs.com/package/@graphty/layout)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Examples](https://img.shields.io/badge/demo-github%20pages-blue)](https://graphty-org.github.io/layout/examples/index.html)
+[![Documentation](https://img.shields.io/badge/docs-vitepress-blue)](https://graphty.app/docs/layout/)
+[![Examples](https://img.shields.io/badge/demo-github%20pages-blue)](https://graphty.app/layout/examples/index.html)
 
-**[View Interactive Examples →](https://graphty-org.github.io/layout/examples/index.html)**
+**[View Interactive Examples →](https://graphty.app/layout/examples/index.html)**
 
 Layout is a TypeScript library for positioning nodes in graphs. It's a TypeScript port of the [layout algorithms](https://networkx.org/documentation/stable/reference/drawing.html) from the Python [NetworkX](https://networkx.org/documentation/stable/) library.
 

package/dist/layout.js

@@ -237,7 +237,7 @@ class RandomNumberGenerator {
 function randomLayout(G, center = null, dim = 2, seed = null) {
   const processed = _processParams(G, center, dim);
   const nodes = getNodesFromGraph(processed.G);
-  center = processed.center;
+  ({ center } = processed);
   const rng = new RandomNumberGenerator(seed ?? void 0);
   const pos = {};
   nodes.forEach((node) => {
@@ -318,7 +318,7 @@ function arfLayout(G, pos = null, scaling = 1, a = 1.1, maxIter = 1e3, seed = nu
   });
   return finalPos;
 }
-function forceatlas2Layout(G, pos = null, maxIter = 100, jitterTolerance = 1, scalingRatio = 2, gravity = 1, distributedAction = false, strongGravity = false, nodeMass = null, nodeSize = null, weight = null, dissuadeHubs = false, linlog = false, seed = null, dim = 2) {
+function forceatlas2Layout(G, pos = null, maxIter = 100, jitterTolerance = 1, scalingRatio = 2, gravity = 1, distributedAction = false, strongGravity = false, nodeMass = null, nodeSize = null, weight = null, _dissuadeHubs = false, linlog = false, seed = null, dim = 2) {
   const processed = _processParams(G, null, dim);
   const graph = processed.G;
   const nodes = getNodesFromGraph(graph);
@@ -381,7 +381,13 @@ function forceatlas2Layout(G, pos = null, maxIter = 100, jitterTolerance = 1, sc
   const adjustSizes = nodeSize !== null;
   for (let i = 0; i < nodes.length; i++) {
     const node = nodes[i];
-    mass[i] = nodeMass && nodeMass[node] ? nodeMass[node] : Array.isArray(graph) ? 1 : getNodeDegree(graph, node) + 1;
+    if (nodeMass && nodeMass[node]) {
+      mass[i] = nodeMass[node];
+    } else if (Array.isArray(graph)) {
+      mass[i] = 1;
+    } else {
+      mass[i] = getNodeDegree(graph, node) + 1;
+    }
     size[i] = nodeSize && nodeSize[node] ? nodeSize[node] : 1;
   }
   const n = nodes.length;
@@ -406,30 +412,32 @@ function forceatlas2Layout(G, pos = null, maxIter = 100, jitterTolerance = 1, sc
   const repulsion = Array(n).fill(0).map(() => Array(dim).fill(0));
   let speed = 1;
   let speedEfficiency = 1;
-  function estimateFactor(n2, swing2, traction2, speed2, speedEfficiency2, jitterTolerance2) {
-    const optJitter = 0.05 * Math.sqrt(n2);
+  function estimateFactor(nodeCount, swingValue, tractionValue, currentSpeed, currentSpeedEfficiency, jitterToleranceParam) {
+    let resultSpeed = currentSpeed;
+    let resultSpeedEfficiency = currentSpeedEfficiency;
+    const optJitter = 0.05 * Math.sqrt(nodeCount);
     const minJitter = Math.sqrt(optJitter);
     const maxJitter = 10;
     const minSpeedEfficiency = 0.05;
-    const other = Math.min(maxJitter, optJitter * traction2 / (n2 * n2));
-    let jitter = jitterTolerance2 * Math.max(minJitter, other);
-    if (swing2 / traction2 > 2) {
-      if (speedEfficiency2 > minSpeedEfficiency) {
-        speedEfficiency2 *= 0.5;
+    const other = Math.min(maxJitter, optJitter * tractionValue / (nodeCount * nodeCount));
+    let jitter = jitterToleranceParam * Math.max(minJitter, other);
+    if (swingValue / tractionValue > 2) {
+      if (resultSpeedEfficiency > minSpeedEfficiency) {
+        resultSpeedEfficiency *= 0.5;
       }
-      jitter = Math.max(jitter, jitterTolerance2);
+      jitter = Math.max(jitter, jitterToleranceParam);
     }
-    const targetSpeed = swing2 === 0 ? Number.POSITIVE_INFINITY : jitter * speedEfficiency2 * traction2 / swing2;
-    if (swing2 > jitter * traction2) {
-      if (speedEfficiency2 > minSpeedEfficiency) {
-        speedEfficiency2 *= 0.7;
+    const targetSpeed = swingValue === 0 ? Number.POSITIVE_INFINITY : jitter * resultSpeedEfficiency * tractionValue / swingValue;
+    if (swingValue > jitter * tractionValue) {
+      if (resultSpeedEfficiency > minSpeedEfficiency) {
+        resultSpeedEfficiency *= 0.7;
       }
-    } else if (speed2 < 1e3) {
-      speedEfficiency2 *= 1.3;
+    } else if (resultSpeed < 1e3) {
+      resultSpeedEfficiency *= 1.3;
     }
     const maxRise = 0.5;
-    speed2 = speed2 + Math.min(targetSpeed - speed2, maxRise * speed2);
-    return [speed2, speedEfficiency2];
+    resultSpeed = resultSpeed + Math.min(targetSpeed - resultSpeed, maxRise * resultSpeed);
+    return [resultSpeed, resultSpeedEfficiency];
   }
   for (let iter = 0; iter < maxIter; iter++) {
     for (let i = 0; i < n; i++) {
@@ -593,7 +601,7 @@ function getNodeDegree(graph, node) {
 function fruchtermanReingoldLayout(G, k = null, pos = null, fixed = null, iterations = 50, scale = 1, center = null, dim = 2, seed = null) {
   const processed = _processParams(G, center, dim);
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const nodes = getNodesFromGraph(graph);
   const edges = getEdgesFromGraph(graph);
   if (nodes.length === 0) {
@@ -673,7 +681,7 @@ function fruchtermanReingoldLayout(G, k = null, pos = null, fixed = null, iterat
   }
   return positions;
 }
-function _lbfgsDirection(grad, sList, yList, m) {
+function _lbfgsDirection(grad, sList, yList, _m) {
   if (sList.length === 0) {
     return grad.map((g) => -g);
   }
@@ -951,7 +959,7 @@ function circularLayout(G, scale = 1, center = null, dim = 2) {
   }
   const processed = _processParams(G, center, dim);
   const nodes = getNodesFromGraph(processed.G);
-  center = processed.center;
+  ({ center } = processed);
   const pos = {};
   if (nodes.length === 0) {
     return pos;
@@ -991,7 +999,7 @@ function circularLayout(G, scale = 1, center = null, dim = 2) {
 function kamadaKawaiLayout(G, dist = null, pos = null, weight = "weight", scale = 1, center = null, dim = 2) {
   const processed = _processParams(G, center, dim);
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const nodes = getNodesFromGraph(graph);
   if (nodes.length === 0) {
     return {};
@@ -1056,7 +1064,7 @@ function shellLayout(G, nlist = null, scale = 1, center = null, dim = 2) {
   }
   const processed = _processParams(G, center, dim);
   const nodes = getNodesFromGraph(processed.G);
-  center = processed.center;
+  ({ center } = processed);
   const pos = {};
   if (nodes.length === 0) {
     return pos;
@@ -1101,7 +1109,7 @@ function spiralLayout(G, scale = 1, center = null, dim = 2, resolution = 0.35, e
   }
   const processed = _processParams(G, center || [0, 0], dim);
   const nodes = getNodesFromGraph(processed.G);
-  center = processed.center;
+  ({ center } = processed);
   const pos = {};
   if (nodes.length === 0) {
     return pos;
@@ -1146,7 +1154,7 @@ function multipartiteLayout(G, subsetKey = "subset", align = "vertical", scale =
   }
   const processed = _processParams(G, center || [0, 0], 2);
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const allNodes = getNodesFromGraph(graph);
   if (allNodes.length === 0) {
     return {};
@@ -1166,7 +1174,7 @@ function multipartiteLayout(G, subsetKey = "subset", align = "vertical", scale =
   }
   const layerCount = Object.keys(layers).length;
   let pos = {};
-  Object.entries(layers).forEach(([layer, nodes], layerIdx) => {
+  Object.entries(layers).forEach(([_layer, nodes], layerIdx) => {
     const layerNodes = Array.isArray(nodes) ? nodes : [nodes];
     const layerSize = layerNodes.length;
     layerNodes.forEach((node, nodeIdx) => {
@@ -1191,7 +1199,7 @@ function bfsLayout(G, start, align = "vertical", scale = 1, center = null) {
     throw new Error("BFS layout requires a Graph with edges, not just a list of nodes");
   }
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const allNodes = getNodesFromGraph(graph);
   if (allNodes.length === 0) {
     return {};
@@ -1231,7 +1239,7 @@ function bipartiteLayout(G, nodes = null, align = "vertical", scale = 1, center
   }
   const processed = _processParams(G, center || [0, 0], 2);
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const allNodes = getNodesFromGraph(graph);
   if (allNodes.length === 0) {
     return {};
@@ -1322,7 +1330,7 @@ function createTriangulationEmbedding(nodes, edges, seed = null) {
   }
   return embedding;
 }
-function findCycle(nodes, edges, adjMap) {
+function findCycle(nodes, _edges, adjMap) {
   if (nodes.length === 0) {
     return null;
   }
@@ -1517,7 +1525,7 @@ function tryFindBipartitePartition(nodes, edges) {
   }
   return [part0, part1];
 }
-function checkPlanarity(G, nodes, edges, seed = null) {
+function checkPlanarity(_G, nodes, edges, seed = null) {
   if (nodes.length <= 4) {
     return { isPlanar: true, embedding: createTriangulationEmbedding(nodes, edges, seed) };
   }
@@ -1536,7 +1544,7 @@ function planarLayout(G, scale = 1, center = null, dim = 2, seed = null) {
     throw new Error("Planar layout requires a Graph with edges, not just a list of nodes");
   }
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const nodes = getNodesFromGraph(graph);
   const edges = getEdgesFromGraph(graph);
   if (nodes.length === 0) {
@@ -1556,7 +1564,7 @@ function planarLayout(G, scale = 1, center = null, dim = 2, seed = null) {
 function spectralLayout(G, scale = 1, center = null, dim = 2) {
   const processed = _processParams(G, center, dim);
   const graph = processed.G;
-  center = processed.center;
+  ({ center } = processed);
   const nodes = getNodesFromGraph(graph);
   if (nodes.length <= 2) {
     if (nodes.length === 0) {