@neo4j-nvl/base 2.0.0-c8e499dc → 2.0.0-ec6fdba7

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

@@ -0,0 +1,25 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Type Alias: ZoomOptions
+
+```ts
+type ZoomOptions = {
+  animated?: boolean;
+  maxZoom?: number;
+  minZoom?: number;
+  noPan?: boolean;
+  outOnly?: boolean;
+};
+```
+
+Options that influence how fit-to-zoom should behave
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `animated?` | `boolean` | If true, will not animate the zoom/pan transition. |
+| `maxZoom?` | `number` | The maximum zoom value for the fit-to-zoom operation. This can only lower the [NvlOptions.maxZoom](../interfaces/NvlOptions.md#maxzoom) limit, not raise it. |
+| `minZoom?` | `number` | The minimum zoom value for the fit-to-zoom operation. The fit never zooms out further than this. If [NvlOptions.allowDynamicMinZoom](../interfaces/NvlOptions.md#allowdynamicminzoom) is `true`, it can be lower than [NvlOptions.minZoom](../interfaces/NvlOptions.md#minzoom), which is then lowered to the resulting zoom level. If it is `false`, this can only raise the [NvlOptions.minZoom](../interfaces/NvlOptions.md#minzoom) limit, not lower it. |
+| `noPan?` | `boolean` | If true, will zoom out to fit the specified nodes without changing the pan of the viewport. |
+| `outOnly?` | `boolean` | If true, will only zoom out if specified nodes won't fit into viewport but won't zoom in any further. |

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

@@ -0,0 +1,11 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: CircularLayoutType
+
+```ts
+const CircularLayoutType: "circular" = 'circular';
+```
+
+**`Experimental`**
+
+A basic circular layout.

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

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: ForceDirectedLayoutType
+
+```ts
+const ForceDirectedLayoutType: "forceDirected" = 'forceDirected';
+```
+
+NVL's main force directed layout.

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

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: FreeLayoutType
+
+```ts
+const FreeLayoutType: "free" = 'free';
+```
+
+A free layout that allows for arbitrary positioning of elements using NVL's setPosition method.

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

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: GridLayoutType
+
+```ts
+const GridLayoutType: "grid" = 'grid';
+```
+
+A basic grid layout.

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

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: HierarchicalLayoutType
+
+```ts
+const HierarchicalLayoutType: "hierarchical" = 'hierarchical';
+```
+
+A hierarchical layout using the dagre algorithm.

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

@@ -0,0 +1,9 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: d3ForceLayoutType
+
+```ts
+const d3ForceLayoutType: "d3Force" = 'd3Force';
+```
+
+The commonly used d3-force layout.

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

@@ -0,0 +1,38 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Variable: nvlResultTransformer
+
+```ts
+const nvlResultTransformer: ResultTransformer<{
+  nodes: Node[];
+  recordObjectMap: Map<string, 
+     | Node<Integer, Properties, string>
+     | Relationship<Integer, Properties, string>
+    | Path<Integer>>;
+  relationships: Relationship[];
+}>;
+```
+
+Result transformer for the Neo4j JavaScript driver results to NVL graph elements.
+
+## Example
+
+```ts
+import * as neo4j from 'neo4j-driver'
+import { nvlResultTransformer, NVL } from '@neo4j-nvl/base'
+
+const run = async () => {
+  const driver = neo4j.driver('{uri}', neo4j.auth.basic('{user}', '{password}'))
+  const nvlGraph = await driver.executeQuery(
+    'MATCH (a)-[r]-(b) RETURN a,r,b LIMIT 25',
+    {},
+    { resultTransformer: nvlResultTransformer }
+  )
+
+  const nvl = new NVL(document.getElementById('viz'), nvlGraph.nodes, nvlGraph.relationships)
+}
+```
+
+## See
+
+[on Neo4j JS Driver API Docs](https://neo4j.com/docs/api/javascript-driver/current/class/lib6/result-transformers.js~ResultTransformers.html|ResultTransformers)

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

@@ -0,0 +1,163 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: BoxSelectInteraction
+
+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.
+
+For examples, head to the [Box Select Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_boxselectinteraction).
+
+## Extends
+
+- `BaseInteraction`\<[`BoxSelectInteractionOptions`](../type-aliases/BoxSelectInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new BoxSelectInteraction(nvl, options?): BoxSelectInteraction;
+```
+
+Creates a new instance of the multi-select interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`BoxSelectInteractionOptions`](../type-aliases/BoxSelectInteractionOptions.md) | Options for the multi-select interaction handler to customize its behavior. |
+
+#### Returns
+
+`BoxSelectInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<BoxSelectInteractionOptions>.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 all related event listeners and the overlay renderer for the box.
+
+#### 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/classes/ClickInteraction.md

@@ -0,0 +1,163 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: ClickInteraction
+
+Click interaction handler that handles click, double click and right click events on
+nodes, relationships, clusters, and the scene.
+
+For examples, head to the [Click Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_clickinteraction).
+
+## Extends
+
+- `BaseInteraction`\<[`ClickInteractionOptions`](../type-aliases/ClickInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new ClickInteraction(nvl, options?): ClickInteraction;
+```
+
+Creates a new click interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`ClickInteractionOptions`](../type-aliases/ClickInteractionOptions.md) | Options for the click interaction handler. |
+
+#### Returns
+
+`ClickInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<ClickInteractionOptions>.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 all related event listeners from the container.
+
+#### 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/classes/DragNodeInteraction.md

@@ -0,0 +1,164 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: DragNodeInteraction
+
+Interaction handler for dragging nodes,
+which is achieved by clicking and moving the node.
+When multiple nodes are selected, they are all dragged.
+
+For examples, head to the [Drag Node Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_dragnodeinteraction).
+
+## Extends
+
+- `BaseInteraction`\<`Record`\<`string`, `never`\>\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new DragNodeInteraction(nvl, options?): DragNodeInteraction;
+```
+
+Creates a new instance of the drag node interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | \{ \} | - |
+
+#### Returns
+
+`DragNodeInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<Record<string, never>>.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 all related event listeners from the container.
+
+#### 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
+```