@neo4j-nvl/base 1.2.2 → 2.0.0-1e695738

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/classes/ZoomInteraction.md

@@ -0,0 +1,164 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: ZoomInteraction
+
+Interaction handler for zooming the canvas, which is achieved by:
+- Scrolling the mouse wheel on the canvas
+- Using trackpad pinch gestures (equivalent to Ctrl/Cmd + scroll)
+
+For examples, head to the [Zoom Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_zoominteraction).
+
+## Extends
+
+- `BaseInteraction`\<[`ZoomInteractionOptions`](../type-aliases/ZoomInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new ZoomInteraction(nvl, options?): ZoomInteraction;
+```
+
+Creates a new instance of the zoom interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`ZoomInteractionOptions`](../type-aliases/ZoomInteractionOptions.md) | Options to customize the zoom interaction behavior. |
+
+#### Returns
+
+`ZoomInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<ZoomInteractionOptions>.constructor
+```
+
+## Accessors
+
+### currentOptions
+
+#### Get Signature
+
+```ts
+get currentOptions(): P;
+```
+
+Returns the current options of the interaction.
+
+##### Returns
+
+`P`
+
+The current options of the interaction.
+
+#### Inherited from
+
+```ts
+BaseInteraction.currentOptions
+```
+
+## Methods
+
+### destroy()
+
+```ts
+destroy(): void;
+```
+
+Removes the relevant event listeners from the canvas.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+```ts
+BaseInteraction.destroy
+```
+
+***
+
+### removeCallback()
+
+```ts
+removeCallback(name): void;
+```
+
+Remove a callback for a given event of type.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The name of the event. |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+BaseInteraction.removeCallback
+```
+
+***
+
+### toggleGlobalTextSelection()
+
+```ts
+toggleGlobalTextSelection(enable, eventFunction?): void;
+```
+
+Enables or disables global text selection during a drag or pan operation.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `enable` | `boolean` | Whether to enable or disable global text selection. |
+| `eventFunction?` | (`this`, `ev`) => `void` | The event function to be added/removed when text selection is disabled/enabled. |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+BaseInteraction.toggleGlobalTextSelection
+```
+
+***
+
+### updateCallback()
+
+```ts
+updateCallback(name, callback): void;
+```
+
+Add or update a callback for a given event of type.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The name of the event. |
+| `callback` | `boolean` \| ((...`args`) => `void`) | The callback to be called when the event is triggered. |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+BaseInteraction.updateCallback
+```

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/index.md

@@ -0,0 +1,37 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# @neo4j-nvl/interaction-handlers
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [BoxSelectInteraction](classes/BoxSelectInteraction.md) | An interaction handler for multi-selecting nodes and relationships. When dragging the cursor, it draws a box on the scene and all nodes and relationships inside the box are selected. |
+| [ClickInteraction](classes/ClickInteraction.md) | Click interaction handler that handles click, double click and right click events on nodes, relationships, clusters, and the scene. |
+| [DragNodeInteraction](classes/DragNodeInteraction.md) | Interaction handler for dragging nodes, which is achieved by clicking and moving the node. When multiple nodes are selected, they are all dragged. |
+| [HoverInteraction](classes/HoverInteraction.md) | Interaction handler for hovering nodes and relationships. |
+| [KeyboardInteraction](classes/KeyboardInteraction.md) | Opinionated interaction handler for keyboard-driven focus navigation through graph elements (nodes and relationships). |
+| [LassoInteraction](classes/LassoInteraction.md) | An interaction handler that lets you select nodes and relationships by drawing a lasso around them. When dragging, a line is drawn on the scene and all elements inside are selected. |
+| [PanInteraction](classes/PanInteraction.md) | Interaction handler for panning the scene, which is achieved by clicking and moving the scene. |
+| [ZoomInteraction](classes/ZoomInteraction.md) | Interaction handler for zooming the canvas, which is achieved by: - Scrolling the mouse wheel on the canvas - Using trackpad pinch gestures (equivalent to Ctrl/Cmd + scroll) |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [BoxSelectInteractionCallbacks](type-aliases/BoxSelectInteractionCallbacks.md) | Callbacks for the box select interaction handler. |
+| [BoxSelectInteractionOptions](type-aliases/BoxSelectInteractionOptions.md) | Options for the multi-select interaction handler to customize its behavior. |
+| [ClickInteractionCallbacks](type-aliases/ClickInteractionCallbacks.md) | Callbacks for the click interaction handler. |
+| [ClickInteractionOptions](type-aliases/ClickInteractionOptions.md) | Options for the click interaction handler to customize its behavior. |
+| [DragNodeInteractionCallbacks](type-aliases/DragNodeInteractionCallbacks.md) | Callbacks for the drag node interaction handler. |
+| [DrawInteractionOptions](type-aliases/DrawInteractionOptions.md) | Options for the draw interaction handler. |
+| [HoverInteractionCallbacks](type-aliases/HoverInteractionCallbacks.md) | Callbacks for the hover interaction handler. |
+| [HoverInteractionOptions](type-aliases/HoverInteractionOptions.md) | Options for the hover interaction handler to customize its behavior. |
+| [KeyboardInteractionCallbacks](type-aliases/KeyboardInteractionCallbacks.md) | Callbacks for the keyboard interaction handler. |
+| [KeyboardInteractionOptions](type-aliases/KeyboardInteractionOptions.md) | Options for the keyboard interaction handler. Allows configuring which keys trigger specific navigation actions. Each key combo is an array of strings: the last element is the primary key (`event.key`), and any preceding elements are modifier keys (`'Shift'`, `'Ctrl'`, `'Alt'`, `'Meta'`). |
+| [LassoInteractionCallbacks](type-aliases/LassoInteractionCallbacks.md) | Callbacks for the lasso interaction handler. |
+| [LassoInteractionOptions](type-aliases/LassoInteractionOptions.md) | Options for the lasso interaction handler to customize its behavior. |
+| [PanInteractionCallbacks](type-aliases/PanInteractionCallbacks.md) | Callbacks for the pan interaction handler. |
+| [PanInteractionOptions](type-aliases/PanInteractionOptions.md) | Options for the pan interaction handler to customize its behavior. |
+| [ZoomInteractionCallbacks](type-aliases/ZoomInteractionCallbacks.md) | Callbacks for the zoom interaction handler. |
+| [ZoomInteractionOptions](type-aliases/ZoomInteractionOptions.md) | Options for the zoom interaction handler to customize its behavior. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/BoxSelectInteractionCallbacks.md

@@ -0,0 +1,19 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: BoxSelectInteractionCallbacks
+
+```ts
+type BoxSelectInteractionCallbacks = {
+  onBoxSelect?: (({ nodes, rels }, event) => void) | boolean;
+  onBoxStarted?: ((event) => void) | boolean;
+};
+```
+
+Callbacks for the box select interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onBoxSelect?` | ((`{ nodes, rels }`, `event`) => `void`) \| `boolean` | Called once the user releases the mouse after multi-selecting. **Param** **selectionObject** The selected nodes and relationships. **Param** **event** The original mouse event. |
+| `onBoxStarted?` | ((`event`) => `void`) \| `boolean` | Called once when the user presses the mouse on the canvas, starting the box selection. **Param** **event** The original mouse event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/BoxSelectInteractionOptions.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: BoxSelectInteractionOptions
+
+```ts
+type BoxSelectInteractionOptions = {
+  selectOnRelease?: boolean;
+};
+```
+
+Options for the multi-select interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `selectOnRelease?` | `boolean` | If true, the selection will be applied when the mouse is released. **Default** `false` |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/ClickInteractionCallbacks.md

@@ -0,0 +1,39 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ClickInteractionCallbacks
+
+```ts
+type ClickInteractionCallbacks = {
+  onCanvasClick?: ((event) => void) | boolean;
+  onCanvasDoubleClick?: ((event) => void) | boolean;
+  onCanvasRightClick?: ((event) => void) | boolean;
+  onClusterClick?: ((cluster, hitElements, event) => void) | boolean;
+  onClusterDoubleClick?: ((cluster, hitElements, event) => void) | boolean;
+  onClusterRightClick?: ((cluster, hitElements, event) => void) | boolean;
+  onNodeClick?: ((node, hitElements, event) => void) | boolean;
+  onNodeDoubleClick?: ((node, hitElements, event) => void) | boolean;
+  onNodeRightClick?: ((node, hitElements, event) => void) | boolean;
+  onRelationshipClick?: ((relationship, hitElements, event) => void) | boolean;
+  onRelationshipDoubleClick?: ((relationship, hitElements, event) => void) | boolean;
+  onRelationshipRightClick?: ((relationship, hitElements, event) => void) | boolean;
+};
+```
+
+Callbacks for the click interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onCanvasClick?` | ((`event`) => `void`) \| `boolean` | Called when the canvas is clicked. **Param** **event** The original mouse event. |
+| `onCanvasDoubleClick?` | ((`event`) => `void`) \| `boolean` | Called when the canvas is double-clicked. **Param** **event** The original mouse event. |
+| `onCanvasRightClick?` | ((`event`) => `void`) \| `boolean` | Called when the canvas is right-clicked. **Param** **event** The original mouse event. |
+| `onClusterClick?` | ((`cluster`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a cluster hull is clicked (empty space inside a clusterBy hull). **Param** **cluster** The cluster that was clicked. **Param** **hitElements** All elements that were hit by the click. **Param** **event** The original mouse event. |
+| `onClusterDoubleClick?` | ((`cluster`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a cluster hull is double-clicked. **Param** **cluster** The cluster that was double-clicked. **Param** **hitElements** All elements that were hit by the double-click. **Param** **event** The original mouse event. |
+| `onClusterRightClick?` | ((`cluster`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a cluster hull is right-clicked. **Param** **cluster** The cluster that was right-clicked. **Param** **hitElements** All elements that were hit by the right-click. **Param** **event** The original mouse event. |
+| `onNodeClick?` | ((`node`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a node is clicked. **Param** **node** The node that was clicked. **Param** **hitElements** All elements that were hit by the click. **Param** **event** The original mouse event. |
+| `onNodeDoubleClick?` | ((`node`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a node is double-clicked. **Param** **node** The node that was double-clicked. **Param** **hitElements** All elements that were hit by the double-click. **Param** **event** The original mouse event. |
+| `onNodeRightClick?` | ((`node`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a node is right-clicked. **Param** **node** The node that was right-clicked. **Param** **hitElements** All elements that were hit by the right-click. **Param** **event** The original mouse event. |
+| `onRelationshipClick?` | ((`relationship`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a relationship is clicked. **Param** **relationship** The relationship that was clicked. **Param** **hitElements** All elements that were hit by the click. **Param** **event** The original mouse event. |
+| `onRelationshipDoubleClick?` | ((`relationship`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a relationship is double-clicked. **Param** **relationship** The relationship that was double-clicked. **Param** **hitElements** All elements that were hit by the double-click. **Param** **event** The original mouse event. |
+| `onRelationshipRightClick?` | ((`relationship`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a relationship is right-clicked. **Param** **relationship** The relationship that was right-clicked. **Param** **hitElements** All elements that were hit by the right-click. **Param** **event** The original mouse event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/ClickInteractionOptions.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ClickInteractionOptions
+
+```ts
+type ClickInteractionOptions = {
+  selectOnClick?: boolean;
+};
+```
+
+Options for the click interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `selectOnClick?` | `boolean` | `false` | Whether to select the node, relationship, or cluster members on click. Clicking something that is already selected clears the selection. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/DragNodeInteractionCallbacks.md

@@ -0,0 +1,21 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: DragNodeInteractionCallbacks
+
+```ts
+type DragNodeInteractionCallbacks = {
+  onDrag?: ((nodes, evt) => void) | boolean;
+  onDragEnd?: ((nodes, evt) => void) | boolean;
+  onDragStart?: ((nodes, evt) => void) | boolean;
+};
+```
+
+Callbacks for the drag node interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onDrag?` | ((`nodes`, `evt`) => `void`) \| `boolean` | Called when node(s) are dragged **Param** **nodes** The node(s) being dragged. **Param** **event** The original mouse event. |
+| `onDragEnd?` | ((`nodes`, `evt`) => `void`) \| `boolean` | Called once when node(s) are finished being dragged **Param** **nodes** The node(s) being dragged. **Param** **event** The original mouse event. |
+| `onDragStart?` | ((`nodes`, `evt`) => `void`) \| `boolean` | Called once when node(s) are started to being dragged **Param** **nodes** The node(s) being dragged. **Param** **event** The original mouse event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/DrawInteractionOptions.md

@@ -0,0 +1,22 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: DrawInteractionOptions
+
+```ts
+type DrawInteractionOptions = {
+  ghostGraphStyling?: {
+     node?: Pick<Node, "color" | "size">;
+     relationship?: Pick<Relationship, "color" | "width">;
+  };
+};
+```
+
+Options for the draw interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `ghostGraphStyling?` | \{ `node?`: `Pick`\<`Node`, `"color"` \| `"size"`\>; `relationship?`: `Pick`\<`Relationship`, `"color"` \| `"width"`\>; \} | Styling for the ghost graph that is shown when drawing. |
+| `ghostGraphStyling.node?` | `Pick`\<`Node`, `"color"` \| `"size"`\> | Styling for the ghost node. |
+| `ghostGraphStyling.relationship?` | `Pick`\<`Relationship`, `"color"` \| `"width"`\> | Styling for the ghost relationship. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/HoverInteractionCallbacks.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: HoverInteractionCallbacks
+
+```ts
+type HoverInteractionCallbacks = {
+  onHover?: ((element, hitElements, event) => void) | boolean;
+};
+```
+
+Callbacks for the hover interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onHover?` | ((`element`, `hitElements`, `event`) => `void`) \| `boolean` | Called when a node or relationship is hovered. **Param** **element** The highest-priority node or relationship under the pointer, or `undefined` if nothing is hovered. **Param** **hitElements** All nodes, relationships, and clusters under the pointer. **Param** **event** The original mouse event. This callback is called every time the mouse moves, even when no element is hovered or the current element is already hovered. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/HoverInteractionOptions.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: HoverInteractionOptions
+
+```ts
+type HoverInteractionOptions = {
+  drawShadowOnHover?: boolean;
+};
+```
+
+Options for the hover interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `drawShadowOnHover?` | `boolean` | Whether to draw a shadow on hover for nodes/relationships **Default** `false` |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/KeyboardInteractionCallbacks.md

@@ -0,0 +1,35 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: KeyboardInteractionCallbacks
+
+```ts
+type KeyboardInteractionCallbacks = {
+  onCanvasBlur?: ((event) => void) | boolean;
+  onCanvasFocus?: ((event) => void) | boolean;
+  onContextMenu?: ((element, event) => void) | boolean;
+  onKeyDown?: ((event, focusedElement?) => void) | boolean;
+  onKeyUp?: ((event, focusedElement?) => void) | boolean;
+  onNodeBlur?: ((node, event) => void) | boolean;
+  onNodeFocus?: ((node, event) => void) | boolean;
+  onNodeMove?: ((nodes, event) => void) | boolean;
+  onRelationshipBlur?: ((relationship, event) => void) | boolean;
+  onRelationshipFocus?: ((relationship, event) => void) | boolean;
+};
+```
+
+Callbacks for the keyboard interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onCanvasBlur?` | ((`event`) => `void`) \| `boolean` | Called when the NVL canvas container loses DOM focus **Param** **event** The original focus event. |
+| `onCanvasFocus?` | ((`event`) => `void`) \| `boolean` | Called when the NVL canvas container receives DOM focus **Param** **event** The original focus event. |
+| `onContextMenu?` | ((`element`, `event`) => `void`) \| `boolean` | Called when the context menu key is pressed while the NVL container is focused. **Param** **element** The focused node or relationship, or undefined if the canvas itself is focused. **Param** **event** The original keyboard event. |
+| `onKeyDown?` | ((`event`, `focusedElement?`) => `void`) \| `boolean` | Called when a key is pressed while the NVL container is focused. Fires for all key events, including those handled by the built-in navigation. **Param** **event** The original keyboard event. **Param** **focusedElement** The currently focused node or relationship, if any. |
+| `onKeyUp?` | ((`event`, `focusedElement?`) => `void`) \| `boolean` | Called when a key is released while the NVL container is focused **Param** **event** The original keyboard event. **Param** **focusedElement** The currently focused node or relationship, if any. |
+| `onNodeBlur?` | ((`node`, `event`) => `void`) \| `boolean` | Called when a node loses focus (via keyboard navigation) **Param** **node** The node that lost focus. **Param** **event** The original keyboard event that triggered the focus change. |
+| `onNodeFocus?` | ((`node`, `event`) => `void`) \| `boolean` | Called when a node receives focus (via keyboard navigation) **Param** **node** The node that received focus. **Param** **event** The original keyboard event that triggered the focus change. |
+| `onNodeMove?` | ((`nodes`, `event`) => `void`) \| `boolean` | Called when node(s) are moved with the keyboard. **Param** **nodes** The moved node(s), with their updated positions. **Param** **event** The original keyboard event. |
+| `onRelationshipBlur?` | ((`relationship`, `event`) => `void`) \| `boolean` | Called when a relationship loses focus (via keyboard navigation) **Param** **relationship** The relationship that lost focus. **Param** **event** The original keyboard event that triggered the focus change. |
+| `onRelationshipFocus?` | ((`relationship`, `event`) => `void`) \| `boolean` | Called when a relationship receives focus (via keyboard navigation) **Param** **relationship** The relationship that received focus. **Param** **event** The original keyboard event that triggered the focus change. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/KeyboardInteractionOptions.md

@@ -0,0 +1,55 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: KeyboardInteractionOptions
+
+```ts
+type KeyboardInteractionOptions = {
+  canvasOutlineColor?: string;
+  contextMenuKey?: string[];
+  enterGraphKey?: string[];
+  exitGraphKey?: string[];
+  largeMoveStep?: number;
+  largeMoveStepModifier?: "Shift" | "Ctrl" | "Alt" | "Meta";
+  moveDownKey?: string[];
+  moveLeftKey?: string[];
+  moveRightKey?: string[];
+  moveStep?: number;
+  moveUpKey?: string[];
+  navigateBackwardKey?: string[];
+  navigateForwardKey?: string[];
+};
+```
+
+Options for the keyboard interaction handler.
+Allows configuring which keys trigger specific navigation actions.
+Each key combo is an array of strings: the last element is the primary key (`event.key`),
+and any preceding elements are modifier keys (`'Shift'`, `'Ctrl'`, `'Alt'`, `'Meta'`).
+
+## Example
+
+```ts
+import { KeyboardInteractionOptions } from '@neo4j-nvl/interaction-handlers'
+
+const options: KeyboardInteractionOptions = {
+  navigateForwardKey: ['Tab'],
+  contextMenuKey: ['Shift', 'F10']
+}
+```
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `canvasOutlineColor?` | `string` | The color of the outline shown when the canvas receives keyboard focus. Default: `'#30839D'` |
+| `contextMenuKey?` | `string`[] | Key combo for opening the context menu on the focused element. Default: `['Shift', 'F10']` |
+| `enterGraphKey?` | `string`[] | Key combo for entering the graph and focusing the first element. Default: `['Enter']` |
+| `exitGraphKey?` | `string`[] | Key combo for exiting the graph (blur focused element and container). Default: `['Escape']` |
+| `largeMoveStep?` | `number` | Distance in screen pixels the node(s) are moved per key press while [KeyboardInteractionOptions.largeMoveStepModifier](#largemovestepmodifier) is held. Default: `50` |
+| `largeMoveStepModifier?` | `"Shift"` \| `"Ctrl"` \| `"Alt"` \| `"Meta"` | Modifier key that, held together with a move key, applies [KeyboardInteractionOptions.largeMoveStep](#largemovestep) instead of [KeyboardInteractionOptions.moveStep](#movestep). Default: `'Shift'` |
+| `moveDownKey?` | `string`[] | Key combo for moving the selected (or focused) node(s) down. Default: `['ArrowDown']` |
+| `moveLeftKey?` | `string`[] | Key combo for moving the selected (or focused) node(s) left. Default: `['ArrowLeft']` |
+| `moveRightKey?` | `string`[] | Key combo for moving the selected (or focused) node(s) right. Default: `['ArrowRight']` |
+| `moveStep?` | `number` | Distance in screen pixels the node(s) are moved per key press. Converted to graph coordinates using the current zoom level, so the node travels the same visible distance however far the graph is zoomed in or out. Default: `5` |
+| `moveUpKey?` | `string`[] | Key combo for moving the selected (or focused) node(s) up. Default: `['ArrowUp']` |
+| `navigateBackwardKey?` | `string`[] | Key combo for navigating focus to the previous element. Default: `['Shift', 'Tab']` |
+| `navigateForwardKey?` | `string`[] | Key combo for navigating focus to the next element. Default: `['Tab']` |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/LassoInteractionCallbacks.md

@@ -0,0 +1,19 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: LassoInteractionCallbacks
+
+```ts
+type LassoInteractionCallbacks = {
+  onLassoSelect?: (({ nodes, rels }, event) => void) | boolean;
+  onLassoStarted?: ((event) => void) | boolean;
+};
+```
+
+Callbacks for the lasso interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onLassoSelect?` | ((`{ nodes, rels }`, `event`) => `void`) \| `boolean` | Called once when the user releases the mouse after lasso selecting. **Param** **selectionObject** The selected nodes and relationships. **Param** **event** The original mouse event. |
+| `onLassoStarted?` | ((`event`) => `void`) \| `boolean` | Called once when the user presses the mouse on the canvas, starting the lasso. **Param** **event** The original mouse event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/LassoInteractionOptions.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: LassoInteractionOptions
+
+```ts
+type LassoInteractionOptions = {
+  selectOnRelease?: boolean;
+};
+```
+
+Options for the lasso interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `selectOnRelease?` | `boolean` | If true, the selected items will be automatically selected when the gesture is finished. **Default** `false` |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/PanInteractionCallbacks.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: PanInteractionCallbacks
+
+```ts
+type PanInteractionCallbacks = {
+  onPan?: ((panning, event) => void) | boolean;
+};
+```
+
+Callbacks for the pan interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onPan?` | ((`panning`, `event`) => `void`) \| `boolean` | Called when the canvas is panned. **Param** **panning** The panning coordinates. **Param** **event** The original mouse event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/PanInteractionOptions.md

@@ -0,0 +1,19 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: PanInteractionOptions
+
+```ts
+type PanInteractionOptions = {
+  controlledPan?: boolean;
+  excludeNodeMargin?: boolean;
+};
+```
+
+Options for the pan interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `controlledPan?` | `boolean` | `false` | If true, the interaction handler will not update the NVL instance directly. Instead, it will only call the onPan callback with the calculated values, allowing the parent application to control when and how to apply the pan update. |
+| `excludeNodeMargin?` | `boolean` | `false` | Whether to not pan when dragging within a certain margin of a node |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/ZoomInteractionCallbacks.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ZoomInteractionCallbacks
+
+```ts
+type ZoomInteractionCallbacks = {
+  onZoomAndPan?: ((zoomLevel, panX, panY, event) => void) | boolean;
+};
+```
+
+Callbacks for the zoom interaction handler.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onZoomAndPan?` | ((`zoomLevel`, `panX`, `panY`, `event`) => `void`) \| `boolean` | Called when the canvas is zoomed and panned. **Param** **zoomLevel** The zoom level. **Param** **panX** The new pan X coordinate. **Param** **panY** The new pan Y coordinate. **Param** **event** The original mouse wheel event. |

package/skills/neo4j-nvl-skill/references/api/interaction-handlers/type-aliases/ZoomInteractionOptions.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ZoomInteractionOptions
+
+```ts
+type ZoomInteractionOptions = {
+  controlledZoom?: boolean;
+};
+```
+
+Options for the zoom interaction handler to customize its behavior.
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `controlledZoom?` | `boolean` | `false` | If true, the interaction handler will not update the NVL instance directly. Instead, it will only call the onZoomAndPan callback with the calculated values, allowing the parent application to control when and how to apply the zoom update. |

package/skills/neo4j-nvl-skill/references/api/react/functions/StaticPictureWrapper.md

@@ -0,0 +1,35 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Function: StaticPictureWrapper()
+
+```ts
+function StaticPictureWrapper(props): Element | null;
+```
+
+A React component that creates a static picture of a graph using NVL.
+This component is useful for generating static visualizations of graphs without requiring user interaction.
+The component automatically fits all nodes in the viewport before capturing the image
+NVL is automatically destroyed after capturing the image to free up resources.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `props` | [`StaticPictureWrapperProps`](../type-aliases/StaticPictureWrapperProps.md) | The component properties |
+
+## Returns
+
+`Element` \| `null`
+
+An img element displaying the graph visualization, or null during rendering
+
+## Example
+
+```tsx
+<StaticPictureWrapper
+  nodes={nodes}
+  rels={relationships}
+  width={500}
+  height={500}
+/>
+```