@neo4j-nvl/base 1.2.1 → 1.2.2

package/dist/types/index.d.ts

@@ -139,7 +139,11 @@ declare class NVL {
     removeRelationshipsWithIds(relationshipIds: string[]): void;
     /**
      * Returns all nodes that is currently stored in the visualisation.
+     * `x` and `y` are client/screen coordinates relative to the canvas.
      * @returns The array of {@link Node nodes}.
+     *
+     * @note In the next major release, `x` and `y` become layout coordinates and
+     * screen coordinates move to a `clientPosition` field.
      */
     getNodes(): Node[];
     /**

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

@@ -5,7 +5,13 @@ import type { Node } from '../types/graph-element';
 export interface ExternalCallbacks {
     /** Triggered when a layout is done moving. */
     onLayoutDone?: () => void;
-    /** Triggered on each step of a layout. */
+    /**
+     * Triggered on each step of a layout.
+     * Node `x` and `y` are client/screen coordinates relative to the canvas.
+     *
+     * @note In the next major release, `x` and `y` become layout coordinates and
+     * screen coordinates move to a `clientPosition` field.
+     */
     onLayoutStep?: (p: Node[]) => void;
     /** Triggered when NVL throws an error after initialization. */
     onError?: (error: Error) => void;

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

@@ -226,7 +226,16 @@ export interface NvlOptions {
         disabledItemColor?: string;
         /** The color to use for the labels of the disabled nodes and relationships */
         disabledItemFontColor?: string;
-        /** The color to use for the viewport box in the minimap */
+        /**
+         * Stroke color for overlay UI lines (e.g. minimap viewport box).
+         * Use a dark color on light backgrounds and a light color on dark backgrounds.
+         * @defaultValue `#1A1B1D`
+         */
+        overlayLineColor?: string;
+        /**
+         * The color to use for the viewport box in the minimap.
+         * @deprecated Use {@link overlayLineColor}.
+         */
         minimapViewportBoxColor?: string;
     };
     /**
@@ -320,6 +329,6 @@ export interface NvlState {
     disabledItemStyles: DisabledItemStyles;
     defaultNodeColor: string;
     defaultRelationshipColor: string;
-    minimapViewportBoxColor: string;
+    overlayLineColor: string;
 }
 export {};

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

@@ -6,7 +6,7 @@ import type { NvlOptions } from './types';
  * If both caption and captions are provided, captions takes precedence.
  */
 export declare const processCaptions: (item: Partial<Node | Relationship>) => StyledCaption[];
-export declare const processColorStyles: (styling: NvlOptions["styling"]) => {
+export declare const processColorStyles: (styling?: NvlOptions["styling"]) => {
     nodeBorderStyles: {
         default: {
             rings?: {
@@ -42,5 +42,5 @@ export declare const processColorStyles: (styling: NvlOptions["styling"]) => {
     };
     defaultNodeColor: string;
     defaultRelationshipColor: string;
-    minimapViewportBoxColor: string;
+    overlayLineColor: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "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.1",
+    "@neo4j-nvl/layout-workers": "1.2.2",
     "@segment/analytics-next": "1.81.1",
     "color-string": "1.9.1",
     "d3-force": "3.0.0",