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

package/skills/neo4j-nvl-skill/references/api/base/functions/getZoomTargetForNodePositions.md

@@ -0,0 +1,37 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Function: getZoomTargetForNodePositions()
+
+```ts
+function getZoomTargetForNodePositions(
+   nodePositions, 
+   containerWidth, 
+   containerHeight, 
+   maxNodeRadius?
+): {
+  panX: number;
+  panY: number;
+  zoom: number;
+};
+```
+
+Gets the zoom target to fit the given node positions into the scene.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nodePositions` | [`Point`](../interfaces/Point.md)[] | The node positions. |
+| `containerWidth` | `number` | The width of the container NVL is displayed in. |
+| `containerHeight` | `number` | The height of the container NVL is displayed in. |
+| `maxNodeRadius` | `number` | The maximum node radius, which is added as margin to the scene (defaults to 2 * DefaultNodeSize). |
+
+## Returns
+
+The zoom and pan targets.
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| `panX` | `number` | The x-coordinate of the pan. |
+| `panY` | `number` | The y-coordinate of the pan. |
+| `zoom` | `number` | The zoom level. |

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

@@ -0,0 +1,71 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# @neo4j-nvl/base
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [NVL](classes/NVL.md) | Class for a NVL instance. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [CircularOptions](interfaces/CircularOptions.md) | The options for the circular layout. |
+| [ClusteringOptions](interfaces/ClusteringOptions.md) | Options that control physical clustering and cluster decorations for the force-directed layout. |
+| [ExternalCallbacks](interfaces/ExternalCallbacks.md) | An object specifying the required callback functions for certain actions |
+| [ForceDirectedOptions](interfaces/ForceDirectedOptions.md) | The options for the force directed layout |
+| [HierarchicalOptions](interfaces/HierarchicalOptions.md) | The options for the hierarchical layout |
+| [HitTargetCluster](interfaces/HitTargetCluster.md) | A [ClusteringOptions.clusterBy](interfaces/ClusteringOptions.md#clusterby) cluster hull that has been hit by a pointer event |
+| [HitTargetNode](interfaces/HitTargetNode.md) | A node that has been hit by a pointer event |
+| [HitTargetRelationship](interfaces/HitTargetRelationship.md) | A relationship that has been hit by a pointer event |
+| [Node](interfaces/Node.md) | A node inside the graph visualization. |
+| [NvlMouseEvent](interfaces/NvlMouseEvent.md) | Extends the MouseEvent interface with the [HitTargets](type-aliases/HitTargets.md) property. The result of a [NVL.getHits](classes/NVL.md#gethits) call. |
+| [NvlOptions](interfaces/NvlOptions.md) | Configurations for a NVL instance |
+| [Point](interfaces/Point.md) | An object representing a point in 2D space. |
+| [Relationship](interfaces/Relationship.md) | A relationship inside the graph visualization. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [CanvasRendererType](type-aliases/CanvasRendererType.md) | A renderer using canvas. |
+| [Cluster](type-aliases/Cluster.md) | A physical cluster produced by [ClusteringOptions.clusterBy](interfaces/ClusteringOptions.md#clusterby). Not a graph element — used for hit-testing and interaction callbacks. |
+| [ClusterByFn](type-aliases/ClusterByFn.md) | Function that maps a node id to a [ClusterId](type-aliases/ClusterId.md) for force-directed clustering. Returns `undefined` for nodes that should remain independent. |
+| [ClusterId](type-aliases/ClusterId.md) | Identifier returned by [ClusterByFn](type-aliases/ClusterByFn.md) to group nodes into physical clusters. Nodes sharing the same string or number are clustered together. |
+| [HitTargets](type-aliases/HitTargets.md) | A collection of nodes, relationships and clusters that have been hit by a pointer event Part of the result of a [NVL](classes/NVL.md).[NVL.getHits](classes/NVL.md#gethits) call |
+| [HitTestTarget](type-aliases/HitTestTarget.md) | - |
+| [Layout](type-aliases/Layout.md) | The different types of layouts available |
+| [LayoutOptions](type-aliases/LayoutOptions.md) | The options for the layout. |
+| [NodeWithClientPosition](type-aliases/NodeWithClientPosition.md) | A node returned by [NVL.getNodes](classes/NVL.md#getnodes) with layout coordinates and screen position. `x` and `y` are canvas/layout space; `clientPosition` is relative to the canvas element. |
+| [PartialNode](type-aliases/PartialNode.md) | A node with only a subset of its properties. |
+| [PartialRelationship](type-aliases/PartialRelationship.md) | A relationship with only a subset of its properties. |
+| [Renderer](type-aliases/Renderer.md) | The different types of renderers available |
+| [StyledCaption](type-aliases/StyledCaption.md) | The caption text and its text style. |
+| [WebGLRendererType](type-aliases/WebGLRendererType.md) | A WebGL2 renderer that uses the GPU for rendering. |
+| [ZoomOptions](type-aliases/ZoomOptions.md) | Options that influence how fit-to-zoom should behave |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [CircularLayoutType](variables/CircularLayoutType.md) | A basic circular layout. |
+| [d3ForceLayoutType](variables/d3ForceLayoutType.md) | The commonly used d3-force layout. |
+| [ForceDirectedLayoutType](variables/ForceDirectedLayoutType.md) | NVL's main force directed layout. |
+| [FreeLayoutType](variables/FreeLayoutType.md) | A free layout that allows for arbitrary positioning of elements using NVL's setPosition method. |
+| [GridLayoutType](variables/GridLayoutType.md) | A basic grid layout. |
+| [HierarchicalLayoutType](variables/HierarchicalLayoutType.md) | A hierarchical layout using the dagre algorithm. |
+| [nvlResultTransformer](variables/nvlResultTransformer.md) | Result transformer for the Neo4j JavaScript driver results to NVL graph elements. |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [getZoomTargetForNodePositions](functions/getZoomTargetForNodePositions.md) | Gets the zoom target to fit the given node positions into the scene. |
+
+## References
+
+### default
+
+Renames and re-exports [NVL](classes/NVL.md)

package/skills/neo4j-nvl-skill/references/api/base/interfaces/CircularOptions.md

@@ -0,0 +1,11 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: CircularOptions
+
+The options for the circular layout.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `sortFunction?` | (`nodes`) => [`Node`](Node.md)[] | Function which should return the sorted nodes. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/ClusteringOptions.md

@@ -0,0 +1,14 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: ClusteringOptions
+
+Options that control physical clustering and cluster decorations for the force-directed layout.
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `clusterBy?` | [`ClusterByFn`](../type-aliases/ClusterByFn.md) | `undefined` | Optional function to group nodes into physical clusters based on a custom identifier. Nodes returning the same string or number will be grouped together in the layout. Nodes returning undefined will be treated as independent. **Remarks** Ensure this function has a stable reference to avoid evaluation on every render. |
+| `crossClusterRelationshipMultiplier?` | `number` | `0 @experimental` | **`Experimental`** Spring force multiplier for relationships that cross a [ClusteringOptions.clusterBy](#clusterby) cluster boundary. Capped between `0` and `1`. `0` disables cross-cluster spring pull. `1` is full strength. Intra-cluster edges are always full strength. Only applies when [ClusteringOptions.clusterBy](#clusterby) is set. **Remarks** Can cause unstable layouts when set to close to `1` in highly connected graphs. |
+| `drawHalo?` | `boolean` | `false` | Fills a soft glowing halo around each cluster. **Remarks** Halo color is the same as the nodes in the cluster. If the nodes in the cluster have different colors, the halo won't be shown. |
+| `drawOutline?` | `boolean` | `false` | Draws a convex-hull outline around each cluster. **Remarks** Outline color is the same as the nodes in the cluster. If the nodes in the cluster have different colors, the outline uses `NvlOptions.styling.overlayLineColor`. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/ExternalCallbacks.md

@@ -0,0 +1,18 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: ExternalCallbacks
+
+An object specifying the required callback functions for certain actions
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `onError?` | (`error`) => `void` | Triggered when NVL throws an error after initialization. |
+| `onInitialization?` | () => `void` | Triggered when NVL is initialized. |
+| `onLayoutComputing?` | (`isComputing`) => `void` | Triggered when a asynchronous layout calculation starts/stops. |
+| `onLayoutDone?` | () => `void` | Triggered when a layout is done moving. |
+| `onLayoutStep?` | (`p`) => `void` | Triggered on each step of a layout. |
+| `onWebGLContextLost?` | (`webGLContextEvent`) => `void` | Triggered when the WebGL context is lost. [https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/webglcontextlost\_event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/webglcontextlost_event) |
+| `onZoomTransitionDone?` | () => `void` | Triggered when a zoom transition (e.g. [NVL.fit](../classes/NVL.md#fit) or [NVL.resetZoom](../classes/NVL.md#resetzoom)) function is done. |
+| `restart?` | () => `void` | Triggered when NVL is restarted. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/ForceDirectedOptions.md

@@ -0,0 +1,12 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: ForceDirectedOptions
+
+The options for the force directed layout
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `clustering?` | [`ClusteringOptions`](ClusteringOptions.md) | `undefined` | Physical clustering and cluster decoration options. |
+| `seedingMethod?` | `"box"` \| `"circle"` | `'box'` | How initial node positions are seeded before the physics simulation runs. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/HierarchicalOptions.md

@@ -0,0 +1,13 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: HierarchicalOptions
+
+The options for the hierarchical layout
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `clusterBy?` | [`ClusterByFn`](../type-aliases/ClusterByFn.md) | **`Experimental`** Optional function to group nodes into semantic clusters based on a custom identifier. Nodes returning the same string or number will be grouped together in the layout via dagre compound subgraphs. Nodes returning undefined will be treated as independent. **Remarks** Ensure this function has a stable reference to avoid evaluation on every render. |
+| `direction?` | `"up"` \| `"down"` \| `"left"` \| `"right"` | The direction in which the layout should be oriented |
+| `packing?` | `"bin"` \| `"stack"` | The packing method to be used |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/HitTargetCluster.md

@@ -0,0 +1,13 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: HitTargetCluster
+
+A [ClusteringOptions.clusterBy](ClusteringOptions.md#clusterby) cluster hull that has been hit by a pointer event
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`Cluster`](../type-aliases/Cluster.md) | The cluster that was hit |
+| `hull` | [`Point`](Point.md)[] | The convex hull used for the hit test |
+| `pointerCoordinates` | [`Point`](Point.md) | The coordinates of the pointer event |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/HitTargetNode.md

@@ -0,0 +1,16 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: HitTargetNode
+
+A node that has been hit by a pointer event
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`Node`](Node.md) | The node that was hit |
+| `distance` | `number` | The distance between the node and the pointer event |
+| `distanceVector` | [`Point`](Point.md) | The distance vector between the node and the pointer event |
+| `insideNode` | `boolean` | Whether the pointer event is inside the node |
+| `pointerCoordinates` | [`Point`](Point.md) | The coordinates of the pointer event |
+| `targetCoordinates` | [`Point`](Point.md) | The coordinates of the node that was hit |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/HitTargetRelationship.md

@@ -0,0 +1,15 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: HitTargetRelationship
+
+A relationship that has been hit by a pointer event
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`Relationship`](Relationship.md) | The relationship that was hit |
+| `distance` | `number` | The distance between the relationship and the pointer event |
+| `fromTargetCoordinates` | [`Point`](Point.md) | The coordinates of the source node of the relationship that was hit |
+| `pointerCoordinates` | [`Point`](Point.md) | The coordinates of the pointer event |
+| `toTargetCoordinates` | [`Point`](Point.md) | The coordinates of the target node of the relationship that was hit |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/Node.md

@@ -0,0 +1,32 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: Node
+
+A node inside the graph visualization.
+
+## Extends
+
+- `GraphElement`
+
+## Properties
+
+| Property | Modifier | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| `activated?` | `public` | `boolean` | Whether or not the current node is activated. | - |
+| `caption?` | `public` | `string` | The text to display inside on node or relationship. @note: If both caption and captions are provided, captions takes precedence. @note: To provide multiple captions with custom styles, use the [captions](#captions) property. @note: Captions are only visible when using the 'canvas' renderer. | `GraphElement.caption` |
+| `captionAlign?` | `public` | `"top"` \| `"bottom"` \| `"center"` | The caption align. Has no affect on self-referring relationships. | `GraphElement.captionAlign` |
+| `captions?` | `public` | [`StyledCaption`](../type-aliases/StyledCaption.md)[] | The caption text and font styles. @note: To provide a single caption without custom styles, you can also use the [caption](#caption) property. @note: Captions are only visible when using the 'canvas' renderer. | `GraphElement.captions` |
+| `captionSize?` | `public` | `number` | The caption text size. | `GraphElement.captionSize` |
+| `color?` | `public` | `string` | The color of the graph element. | `GraphElement.color` |
+| `disabled?` | `public` | `boolean` | Whether or not the current node or relationship is disabled. | `GraphElement.disabled` |
+| `hovered?` | `public` | `boolean` | Whether or not the current node or relationship is hovered. | `GraphElement.hovered` |
+| `html?` | `public` | `HTMLElement` | **`Experimental`** The DOM element to display on top of a node. | - |
+| `icon?` | `public` | `string` | The url to an icon to display inside the node. Icons are expected to be black. If the node's background color is dark, the icon will be inverted to white. Icons are expected to be square. | - |
+| `id` | `readonly` | `string` | The id of the current node or relationship. Ids need to be unique across all nodes and relationships. Ids need to be strings and cannot be empty. | `GraphElement.id` |
+| `overlayIcon?` | `public` | \{ `position?`: `number`[]; `size?`: `number`; `url`: `string`; \} | An icon to be displayed anywhere on top of the graph element. Icons are expected to be square. | `GraphElement.overlayIcon` |
+| `overlayIcon.position?` | `public` | `number`[] | The position of the icon relative to the node or relationship. The position is a percentage of the node or relationship size. `[1, 1]` is the bottom right corner of the node or relationship. `[-1, -1]` is the top left corner of the node or relationship. | - |
+| `overlayIcon.size?` | `public` | `number` | The size of the icon relative to the node size or relationship caption size. The size is a percentage of the node size or relationship caption size. | - |
+| `overlayIcon.url` | `public` | `string` | The url to the icon. | - |
+| `pinned?` | `public` | `boolean` | Whether or not the current node is pinned. | - |
+| `selected?` | `public` | `boolean` | Whether or not the current node or relationship is selected. | `GraphElement.selected` |
+| `size?` | `public` | `number` | The size of the node. | - |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/NvlMouseEvent.md

@@ -0,0 +1,16 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: NvlMouseEvent
+
+Extends the MouseEvent interface with the [HitTargets](../type-aliases/HitTargets.md) property.
+The result of a [NVL.getHits](../classes/NVL.md#gethits) call.
+
+## Extends
+
+- `MouseEvent`
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `nvlTargets` | [`HitTargets`](../type-aliases/HitTargets.md) | The graph elements that have been hit by the pointer event. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/NvlOptions.md

@@ -0,0 +1,38 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: NvlOptions
+
+Configurations for a NVL instance
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `allowDynamicMinZoom?` | `boolean` | `true` | Whether or not to dynamically allow decreasing minimum zoom value if current graph does not fit on screen at minimum zoom. When set to `true`, zoom and fit operations will allow zooming out further than [minZoom](#minzoom) if the graph does not fit on screen. [minZoom](#minzoom) is lowered to the new zoom level, so later zoom operations can go that low too. When set to `false`, zoom and fit operations will stop at the minimum zoom value, even if the full graph does not fit on screen at that zoom level. |
+| `callbacks?` | [`ExternalCallbacks`](ExternalCallbacks.md) | `undefined` | Callbacks for various events in the NVL instance. |
+| `disableAria?` | `boolean` | `false` | Disables [ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes on the graph. By default, NVL adds ARIA attributes to the graph container to make it more accessible. Attributes include `role="image"`, `aria-label="Graph visualization"` and `aria-describedby="nvl-${instanceId}-description"`. The description element is a live region that will announce changes to the graph. |
+| `disableTelemetry?` | `boolean` | `false` | Disables tracking of library usage |
+| `disableWebWorkers?` | `boolean` | `undefined` | Disables the use of [web workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) for the layout calculations. |
+| `initialZoom?` | `number` | `undefined` | Zoom value of the current viewport |
+| `instanceId?` | `string` | `undefined` | Id for uniquely identifying the instance of Nvl |
+| `layout?` | [`Layout`](../type-aliases/Layout.md) | `undefined` | The graph layout algorithm to be used |
+| `layoutOptions?` | [`LayoutOptions`](../type-aliases/LayoutOptions.md) | `undefined` | Configuration for the current layout |
+| `maxFps?` | `number` | `30` | Target maximum presentation fps while layout is active; extra time in the tick goes to layout stabilization. Budgets layout steps only. Actual fps may undershoot when rendering is expensive. **Remarks** Will be capped between 1 and 120. |
+| `maxZoom?` | `number` | `10` | The maximum zoom level allowed |
+| `minFps?` | `number` | `3` | Target minimum presentation fps while layout is active, at the cost of stabilization speed when set higher. Budgets layout steps only. Actual fps may undershoot when rendering is expensive. **Remarks** Will be capped between 1 and 120. |
+| `minimapContainer?` | `HTMLElement` | `undefined` | The DOM container in which to render the minimap. **Remarks** When using a React ref, make sure the attached element is rendered before the NVL instance is created. Otherwise, the minimap will not be displayed. |
+| `minZoom?` | `number` | `0.075` | The minimum zoom level allowed |
+| `panX?` | `number` | `undefined` | X-coordinate for panning of the current viewport |
+| `panY?` | `number` | `undefined` | Y-coordinate for panning of the current viewport |
+| `renderer?` | `Renderer` | `'canvas'` | What rendering method to use for the visualization. WebGL renderer uses the GPU and has better performance. Captions are only displayed when using the canvas or svg renderer. |
+| `styling?` | \{ `defaultNodeColor?`: `string`; `defaultRelationshipColor?`: `string`; `disabledItemColor?`: `string`; `disabledItemFontColor?`: `string`; `dropShadowColor?`: `string`; `minimapViewportBoxColor?`: `string`; `nodeDefaultBorderColor?`: `string`; `overlayLineColor?`: `string`; `selectedBorderColor?`: `string`; `selectedInnerBorderColor?`: `string`; \} | `undefined` | Styling options for the NVL instance. |
+| `styling.defaultNodeColor?` | `string` | `undefined` | The default color for nodes. |
+| `styling.defaultRelationshipColor?` | `string` | `undefined` | The default color for relationships. |
+| `styling.disabledItemColor?` | `string` | `undefined` | The color to use for the disabled nodes and relationships |
+| `styling.disabledItemFontColor?` | `string` | `undefined` | The color to use for the labels of the disabled nodes and relationships |
+| `styling.dropShadowColor?` | `string` | `undefined` | The color to use for the drop shadow of selected/hovered nodes and relationships |
+| `styling.minimapViewportBoxColor?` | `string` | `undefined` | The color to use for the viewport box in the minimap. **Deprecated** Use `overlayLineColor`. |
+| `styling.nodeDefaultBorderColor?` | `string` | `undefined` | The color to use for the default border of nodes |
+| `styling.overlayLineColor?` | `string` | `#1A1B1D` | 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. |
+| `styling.selectedBorderColor?` | `string` | `undefined` | The color to use for the selected border of nodes and relationships |
+| `styling.selectedInnerBorderColor?` | `string` | `undefined` | The color to use for the selected inner border of nodes and relationships |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/Point.md

@@ -0,0 +1,12 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: Point
+
+An object representing a point in 2D space.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `x` | `number` | The x coordinate of the point. |
+| `y` | `number` | The y coordinate of the point. |

package/skills/neo4j-nvl-skill/references/api/base/interfaces/Relationship.md

@@ -0,0 +1,32 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Interface: Relationship
+
+A relationship inside the graph visualization.
+
+## Extends
+
+- `GraphElement`
+
+## Properties
+
+| Property | Modifier | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| `caption?` | `public` | `string` | The text to display inside on node or relationship. @note: If both caption and captions are provided, captions takes precedence. @note: To provide multiple captions with custom styles, use the [captions](Node.md#captions) property. @note: Captions are only visible when using the 'canvas' renderer. | `GraphElement.caption` |
+| `captionAlign?` | `public` | `"top"` \| `"bottom"` \| `"center"` | The caption align. Has no affect on self-referring relationships. | `GraphElement.captionAlign` |
+| `captionHtml?` | `public` | `HTMLElement` | **`Experimental`** The DOM element to display on top of a relationship caption. The [captionSize](Node.md#captionsize) and [captionAlign](Node.md#captionalign) properties will affect the position and height of the html container element. | - |
+| `captions?` | `public` | [`StyledCaption`](../type-aliases/StyledCaption.md)[] | The caption text and font styles. @note: To provide a single caption without custom styles, you can also use the [caption](Node.md#caption) property. @note: Captions are only visible when using the 'canvas' renderer. | `GraphElement.captions` |
+| `captionSize?` | `public` | `number` | The caption text size. | `GraphElement.captionSize` |
+| `color?` | `public` | `string` | The color of the graph element. | `GraphElement.color` |
+| `disabled?` | `public` | `boolean` | Whether or not the current node or relationship is disabled. | `GraphElement.disabled` |
+| `from` | `public` | `string` | Node id where the relationship starts from. | - |
+| `hovered?` | `public` | `boolean` | Whether or not the current node or relationship is hovered. | `GraphElement.hovered` |
+| `id` | `readonly` | `string` | The id of the current node or relationship. Ids need to be unique across all nodes and relationships. Ids need to be strings and cannot be empty. | `GraphElement.id` |
+| `overlayIcon?` | `public` | \{ `position?`: `number`[]; `size?`: `number`; `url`: `string`; \} | An icon to be displayed anywhere on top of the graph element. Icons are expected to be square. | `GraphElement.overlayIcon` |
+| `overlayIcon.position?` | `public` | `number`[] | The position of the icon relative to the node or relationship. The position is a percentage of the node or relationship size. `[1, 1]` is the bottom right corner of the node or relationship. `[-1, -1]` is the top left corner of the node or relationship. | - |
+| `overlayIcon.size?` | `public` | `number` | The size of the icon relative to the node size or relationship caption size. The size is a percentage of the node size or relationship caption size. | - |
+| `overlayIcon.url` | `public` | `string` | The url to the icon. | - |
+| `selected?` | `public` | `boolean` | Whether or not the current node or relationship is selected. | `GraphElement.selected` |
+| `to` | `public` | `string` | Node id where the relationship points to. | - |
+| `type?` | `public` | `string` | The relationship type. | - |
+| `width?` | `public` | `number` | The width of the relationship. | - |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/CanvasRendererType.md

@@ -0,0 +1,14 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: CanvasRendererType
+
+```ts
+type CanvasRendererType = "canvas";
+```
+
+A renderer using canvas.
+
+## Remarks
+
+This renderer has lower performance than the WebGL renderer,
+but supports captions.

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/Cluster.md

@@ -0,0 +1,20 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: Cluster
+
+```ts
+type Cluster = {
+  id: ClusterId;
+  nodeIds: string[];
+};
+```
+
+A physical cluster produced by [ClusteringOptions.clusterBy](../interfaces/ClusteringOptions.md#clusterby).
+Not a graph element — used for hit-testing and interaction callbacks.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `id` | [`ClusterId`](ClusterId.md) | Semantic cluster id returned by [ClusterByFn](ClusterByFn.md). |
+| `nodeIds` | `string`[] | Real member node ids belonging to this cluster (at least two). |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/ClusterByFn.md

@@ -0,0 +1,20 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ClusterByFn
+
+```ts
+type ClusterByFn = (nodeId) => ClusterId | undefined;
+```
+
+Function that maps a node id to a [ClusterId](ClusterId.md) for force-directed clustering.
+Returns `undefined` for nodes that should remain independent.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `nodeId` | `string` |
+
+## Returns
+
+[`ClusterId`](ClusterId.md) \| `undefined`

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/ClusterId.md

@@ -0,0 +1,10 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ClusterId
+
+```ts
+type ClusterId = string | number;
+```
+
+Identifier returned by [ClusterByFn](ClusterByFn.md) to group nodes into physical clusters.
+Nodes sharing the same string or number are clustered together.

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/HitTargets.md

@@ -0,0 +1,22 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: HitTargets
+
+```ts
+type HitTargets = {
+  clusters: HitTargetCluster[];
+  nodes: HitTargetNode[];
+  relationships: HitTargetRelationship[];
+};
+```
+
+A collection of nodes, relationships and clusters that have been hit by a pointer event
+Part of the result of a [NVL](../classes/NVL.md).[NVL.getHits](../classes/NVL.md#gethits) call
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `clusters` | [`HitTargetCluster`](../interfaces/HitTargetCluster.md)[] | The cluster hulls that have been hit by the pointer event. |
+| `nodes` | [`HitTargetNode`](../interfaces/HitTargetNode.md)[] | The nodes that have been hit by the pointer event. |
+| `relationships` | [`HitTargetRelationship`](../interfaces/HitTargetRelationship.md)[] | The relationships that have been hit by the pointer event. |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/HitTestTarget.md

@@ -0,0 +1,7 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: HitTestTarget
+
+```ts
+type HitTestTarget = "node" | "relationship" | "cluster";
+```

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/Layout.md

@@ -0,0 +1,15 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: Layout
+
+```ts
+type Layout = 
+  | typeof ForceDirectedLayoutType
+  | typeof HierarchicalLayoutType
+  | typeof GridLayoutType
+  | typeof FreeLayoutType
+  | typeof d3ForceLayoutType
+  | typeof CircularLayoutType;
+```
+
+The different types of layouts available

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/LayoutOptions.md

@@ -0,0 +1,12 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: LayoutOptions
+
+```ts
+type LayoutOptions = 
+  | ForceDirectedOptions
+  | HierarchicalOptions
+  | CircularOptions;
+```
+
+The options for the layout.

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/NodeWithClientPosition.md

@@ -0,0 +1,18 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: NodeWithClientPosition
+
+```ts
+type NodeWithClientPosition = Node & Point & {
+  clientPosition: Point;
+};
+```
+
+A node returned by [NVL.getNodes](../classes/NVL.md#getnodes) with layout coordinates and screen position.
+`x` and `y` are canvas/layout space; `clientPosition` is relative to the canvas element.
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `clientPosition` | [`Point`](../interfaces/Point.md) |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/PartialNode.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: PartialNode
+
+```ts
+type PartialNode = Partial<Node> & {
+  id: string;
+};
+```
+
+A node with only a subset of its properties.
+
+## Type Declaration
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The id of the node. |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/PartialRelationship.md

@@ -0,0 +1,17 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: PartialRelationship
+
+```ts
+type PartialRelationship = Partial<Relationship> & {
+  id: string;
+};
+```
+
+A relationship with only a subset of its properties.
+
+## Type Declaration
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The id of the relationship. |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/Renderer.md

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: Renderer
+
+```ts
+type Renderer = Exclude<InternalRenderer, typeof SvgRendererType>;
+```
+
+The different types of renderers available

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/StyledCaption.md

@@ -0,0 +1,21 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: StyledCaption
+
+```ts
+type StyledCaption = {
+  key?: string;
+  styles?: string[];
+  value?: string;
+};
+```
+
+The caption text and its text style.
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `key?` | `string` | The identifier key for the caption. |
+| `styles?` | `string`[] | The font styles as an array of style keywords, e.g. `['bold', 'italic']`. |
+| `value?` | `string` | The text value for the caption. |

package/skills/neo4j-nvl-skill/references/api/base/type-aliases/WebGLRendererType.md

@@ -0,0 +1,14 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: WebGLRendererType
+
+```ts
+type WebGLRendererType = "webgl";
+```
+
+A WebGL2 renderer that uses the GPU for rendering.
+
+## Remarks
+
+This renderer has better performance than the canvas renderer,
+but does not support captions.