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

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

@@ -0,0 +1,160 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: HoverInteraction
+
+Interaction handler for hovering nodes and relationships.
+
+For examples, head to the [Hover Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_hoverinteraction).
+
+## Extends
+
+- `BaseInteraction`\<[`HoverInteractionOptions`](../type-aliases/HoverInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new HoverInteraction(nvl, options?): HoverInteraction;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `nvl` | `NVL` |
+| `options` | [`HoverInteractionOptions`](../type-aliases/HoverInteractionOptions.md) |
+
+#### Returns
+
+`HoverInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<HoverInteractionOptions>.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
+
+### handleHover()
+
+```ts
+handleHover(event): void;
+```
+
+Handle mouse hover events
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `event` | `MouseEvent` | The mouse event. |
+
+#### Returns
+
+`void`
+
+***
+
+### 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/KeyboardInteraction.md

@@ -0,0 +1,185 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: KeyboardInteraction
+
+Opinionated interaction handler for keyboard-driven focus navigation
+through graph elements (nodes and relationships).
+
+By default, Tab / Shift+Tab cycle focus through elements, Escape exits the
+graph, and Shift+F10 call the `onContextMenu` callback with the focused element.
+While a node is focused, the arrow keys move the selected node(s), or the focused
+node when nothing is selected, by `moveStep` screen pixels - or by `largeMoveStep`
+while the large step modifier (Shift by default) is held.
+All keys can be reconfigured via [KeyboardInteractionOptions](../type-aliases/KeyboardInteractionOptions.md).
+
+Callbacks are fired for focus/blur transitions and context-menu activation,
+following the same one-way data-flow pattern as the other interaction handlers.
+
+## Extends
+
+- `BaseInteraction`\<[`KeyboardInteractionOptions`](../type-aliases/KeyboardInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new KeyboardInteraction(nvl, options?): KeyboardInteraction;
+```
+
+Creates a new keyboard interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`KeyboardInteractionOptions`](../type-aliases/KeyboardInteractionOptions.md) | Options for the keyboard interaction handler. |
+
+#### Returns
+
+`KeyboardInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<KeyboardInteractionOptions>.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
+```
+
+***
+
+### getFocused()
+
+```ts
+getFocused(): Node | Relationship | undefined;
+```
+
+Returns the currently focused element, if any.
+
+#### Returns
+
+`Node` \| `Relationship` \| `undefined`
+
+***
+
+### 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/LassoInteraction.md

@@ -0,0 +1,163 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: LassoInteraction
+
+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.
+
+For examples, head to the [Lasso Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_lassointeraction).
+
+## Extends
+
+- `BaseInteraction`\<[`LassoInteractionOptions`](../type-aliases/LassoInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new LassoInteraction(nvl, options?): LassoInteraction;
+```
+
+Creates a new instance of the lasso interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`LassoInteractionOptions`](../type-aliases/LassoInteractionOptions.md) | Options for the lasso interaction handler to customize its behavior. |
+
+#### Returns
+
+`LassoInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<LassoInteractionOptions>.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/PanInteraction.md

@@ -0,0 +1,196 @@
+[//]: # (This file is auto-generated by scripts/docs/generate-skills.mjs, do not edit it manually)
+
+# Class: PanInteraction
+
+Interaction handler for panning the scene, which is achieved by clicking and moving the scene.
+
+For examples, head to the [Pan Interaction documentation page](https://neo4j.com/docs/nvl/current/interaction-handlers/#_paninteraction).
+
+## Extends
+
+- `BaseInteraction`\<[`PanInteractionOptions`](../type-aliases/PanInteractionOptions.md)\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new PanInteraction(nvl, options?): PanInteraction;
+```
+
+Creates a new instance of the pan interaction handler.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nvl` | `NVL` | The NVL instance to attach the interaction handler to. |
+| `options` | [`PanInteractionOptions`](../type-aliases/PanInteractionOptions.md) | - |
+
+#### Returns
+
+`PanInteraction`
+
+#### Overrides
+
+```ts
+BaseInteraction<PanInteractionOptions>.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 related 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
+```
+
+***
+
+### updateTargets()
+
+```ts
+updateTargets(targets, excludeNodeMargin): void;
+```
+
+Updates which type of graph elements should hinder panning.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `targets` | (`"node"` \| `"relationship"`)[] | The graph elements that should hinder panning. |
+| `excludeNodeMargin` | `boolean` | If true, the node margin will not hinder panning. By default, panning is hindered by nodes and relationships. |
+
+#### Returns
+
+`void`
+
+#### Example
+
+```js
+import { NVL } from '@neo4j-nvl/base'
+import { PanInteraction } from '@neo4j-nvl/interaction-handlers'
+
+const nvl = new NVL(document.createElement('div'), [{ id: '0' }], [])
+const panInteraction = new PanInteraction(nvl)
+
+// Pan canvas even when dragging on nodes and relationships
+panInteraction.updateTargets([], true)
+```