@neo4j-nvl/base 0.3.1-c678d7aa → 0.3.1-ebba99bf

package/dist/types/index.d.ts

@@ -18,7 +18,9 @@ interface NvlMouseEvent extends MouseEvent {
  * Class for a NVL instance.
  * @example
  * This is a basic setup for a NVL instance.
- * ```js
+ * ```ts
+ * import { NVL } from '@neo4j-nvl/base'
+ *
  * const nodes = [
  *   { id: '1', label: 'Node 1', color: '#e04141' },
  *   { id: '2', label: 'Node 2', color: '#e09c41' }
@@ -27,7 +29,6 @@ interface NvlMouseEvent extends MouseEvent {
  *   { id: '12', from: '1', to: '2' }
  * ]
  * const options = {
- *   layout: 'hierarchical',
  *   initialZoom: 0.5
  * }
  * const callbacks = {
@@ -69,7 +70,11 @@ declare class NVL {
      * If an existing property is not provided, it will not be changed.
      * @example
      * Adding and updating nodes and relationships
-     * ```js
+     * ```ts
+     * import { NVL } from '@neo4j-nvl/base'
+     *
+     * const nvl = new NVL(document.getElementById('frame'), [{ id: '0' }], [])
+     *
      * const nodes = [
      * { id: '1', label: 'Node 1', color: '#e04141' },
      * { id: '2', label: 'Node 2', color: '#e09c41' }
@@ -105,15 +110,17 @@ declare class NVL {
      * If an existing property is not provided, it will not be changed.
      * @example
      * Updating nodes and relationships
-     * ```js
+     * ```ts
+     * import { NVL } from '@neo4j-nvl/base'
+     *
      * const nodes = [
-     * { id: '1', label: 'Node 1', color: '#e04141' },
-     * { id: '2', label: 'Node 2', color: '#e09c41' }
+     *   { id: '1', label: 'Node 1', color: '#e04141' },
+     *   { id: '2', label: 'Node 2', color: '#e09c41' }
      * ]
      * const relationships = [
-     * { id: '12', from: '1', to: '2' }
+     *   { id: '12', from: '1', to: '2' }
      * ]
-     * const nvl = new NVL(container, nodes, relationships)
+     * const nvl = new NVL(document.getElementById('frame'), nodes, relationships)
      * // Updates an existing node and relationship
      * nvl.updateElementsInGraph([{ id: '1', selected: true }], [{ id: '12', color: '#e0df41' }])
      * ```
@@ -278,9 +285,6 @@ declare class NVL {
      * @param {string} options.backgroundColor - The background color of the png file.
      * @note The size of the png file will be as large as the entire graph at the default zoom level.
      * Can result in a very large file.
-     * @example
-     * // Save the entire graph visualization canvas as a png to the client.
-     * graphVisualization.saveFullGraphToFile({ filename: 'graph.png', backgroundColor: '#fff' })
      */
     saveFullGraphToLargeFile(options: {
         filename?: string;
@@ -342,10 +346,10 @@ declare class NVL {
      * @example
      * ```js
      * const container = document.getElementById('frame')
-     * const nvl = new NVL(container, nodes, relationships)
+     * const nvl = new NVL(container, [{ id: '0' }], [])
      *
      * // Get the nodes and relationships that have been hit by a pointer event.
-     * container.addEventListener('click', (evt) => {
+     * container?.addEventListener('click', (evt) => {
      *   const { nvlTargets } = nvl.getHits(evt)
      *   console.log('clicked elements:', nvlTargets)
      * })

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

@@ -4,15 +4,15 @@ type CallbackFunction = ExternalCallbacks['onError'] | ExternalCallbacks['onLayo
  * A class for registering and calling callbacks
  * @example
  * ```
+ * import { CallbackHelper } from './CallbackHelper'
+ *
  * const callbackHelper = new CallbackHelper()
- * callbackHelper.register('myEvent', (data) => {
- *  console.log(data)
+ * callbackHelper.register('onError', (e) => {
+ *  console.error(e)
  * })
- * callbackHelper.callIfRegistered('myEvent', 'Hello World')
- * // Logs 'Hello World'
  * ```
  */
-export default class CallbackHelper {
+export declare class CallbackHelper {
     private readonly callbacks;
     constructor();
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "0.3.1-c678d7aa",
+  "version": "0.3.1-ebba99bf",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -33,7 +33,7 @@
     "tsconfig": "./tsconfig.json"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "^0.3.1-c678d7aa",
+    "@neo4j-nvl/layout-workers": "^0.3.1-ebba99bf",
     "color-string": "^1.9.1",
     "contrast": "1.0.1",
     "d3-force": "^3.0.0",