@neo4j-nvl/base 1.2.0-e691fdb4 → 1.2.0-ec8b9947

package/dist/types/layouts/d3forcelayout/constants.d.ts

@@ -12,7 +12,6 @@ export declare const BARNES_HUT_THETA = 1.2;
 export declare const FORCE_LINK_DISTANCE: (relationship: SimulationLinkDatum<D3Node>) => number;
 export declare const FORCE_LINK_STRENGTH: (link: SimulationLinkDatum<SimulationNodeDatum>, count: number[]) => number;
 export declare const FORCE_COLLIDE_RADIUS: (node: D3Node) => number;
-export declare const LAYOUT_RADIUS: (numberOfNodes: number) => number;
 export declare const FORCE_CHARGE: () => number;
 export declare const FORCE_CHARGE_START: () => number;
 export declare const FORCE_CENTER_X = 0.03;

package/dist/types/layouts/forcedirectedlayout/physlayout/PhysLayout.d.ts

@@ -47,6 +47,7 @@ export declare class PhysLayout {
     private offsetTexture;
     private pinTexture;
     private addedNodes;
+    private seedingMethod;
     private updateTexture;
     private physVao;
     private physSmallVao;

package/dist/types/modules/NvlController.d.ts

@@ -49,6 +49,7 @@ export default class NvlController {
     private lastTimestamp;
     private accumulator;
     private readonly layoutTimeLimit;
+    private readonly smoothFrameBudgetMs;
     private pixelRatio;
     private readonly removeResizeListener;
     private readonly removeMinimapResizeListener;
@@ -62,6 +63,7 @@ export default class NvlController {
     private descriptionElement;
     constructor(state: NvlState, frame: HTMLElement, options: NvlOptions);
     private onWebGLContextLost;
+    private fpsToFrameBudgetMs;
     private getLayoutNeedsToUpdate;
     private isWithinBudget;
     private updateMinimapZoom;

package/dist/types/modules/state/types.d.ts

@@ -50,6 +50,11 @@ export interface ForceDirectedOptions {
      * @defaultValue true
      */
     enableCytoscape?: boolean;
+    /**
+     * How initial node positions are seeded before the physics simulation runs.
+     * @defaultValue 'box'
+     */
+    seedingMethod?: 'box' | 'circle';
 }
 /**
  * The options for the hierarchical layout
@@ -224,17 +229,24 @@ export interface NvlOptions {
         minimapViewportBoxColor?: string;
     };
     /**
-     * @internal
-     * @hidden
-     * Defines a time limit in ms for how long layout iterations may run
-     * before yielding to the renderer.
-     * Higher values let layout stabilisation complete faster
-     * at the cost of less frequent rendering during stabilisation.
-     * Lower values keep rendering smoother at the cost of slower layout movement.
+     * Target minimum presentation rate (fps) while layout is active.
+     * Rendering will not drop below this rate at the cost of stabilization speed.
+     *
+     * @defaultValue 3
+     *
+     * @note Must be within range of 1 and 120.
+     */
+    minFps?: number;
+    /**
+     * Target maximum presentation rate (fps) while layout is active.
+     * Rendering will not go above with rate. Any additional
+     * computation available is used to speed up layout stabilization.
+     *
+     * @defaultValue 30
      *
-     * @defaultValue 300
+     * @note Must be within range of 1 and 120.
      */
-    layoutTimeLimit?: number;
+    maxFps?: number;
     /**
      * Disables tracking of library usage
      * @defaultValue false

package/dist/types/utils/constants.d.ts

@@ -6,8 +6,10 @@ export declare const Gravity = 25;
 export declare const SimulationStopVelocity = 0.25;
 export declare const MappingEnd = 999999;
 export declare const LayoutStepIntervalMs = 13;
-export declare const SmoothFrameBudgetMs = 8;
-export declare const DefaultLayoutTimeLimit = 300;
+export declare const DefaultMaxFps = 30;
+export declare const DefaultMinFps = 3;
+export declare const MinAllowedFps = 1;
+export declare const MaxAllowedFps = 120;
 export declare const ActiveAnimDuration = 1000;
 export declare const DefaultNodeSize = 25;
 export declare const DefaultNodeColor = "#FFDF81";

package/dist/types/utils/layoutSeeding.d.ts

@@ -0,0 +1,7 @@
+import type { Point } from './geometry';
+export type SeedingMethod = 'box' | 'circle';
+export declare const getCircleSeedRadius: (nodeCount: number, seedSpacing: number) => number;
+export declare const getBoxStartSize: (nodeCount: number) => number;
+export declare const getCirclePositionsForNodeCount: (nodeCount: number, center: Point, radius: number) => Point[];
+export declare const getBoxPositionsForNodeCount: (nodeCount: number, center: Point) => Point[];
+export declare const getSeedPositions: (nodeCount: number, seedingMethod: SeedingMethod, center?: Point) => Point[];

package/dist/types/utils/layoutSeeding.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "1.2.0-e691fdb4",
+  "version": "1.2.0-ec8b9947",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -30,7 +30,7 @@
     "postpack": "rm LICENSE.txt && rm CHANGELOG.md"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "1.2.0-e691fdb4",
+    "@neo4j-nvl/layout-workers": "1.2.0-ec8b9947",
     "@segment/analytics-next": "1.81.1",
     "color-string": "1.9.1",
     "d3-force": "3.0.0",