3d-force-graph 1.73.4 → 1.73.6

package/README.md

@@ -206,7 +206,7 @@ ForceGraph3d({ configOptions })(<domElement>)
 
 | Method | Description |
 | --- | --- |
-| <b>getGraphBbox</b>([<i>nodeFilterFn</i>]) | Returns the current bounding box of the nodes in the graph, formatted as `{ x: [<num>, <num>], y: [<num>, <num>], z: [<num>, <num>] }`. If no nodes are found, returns `null`. Accepts an optional argument to define a custom node filter: `node => <boolean>`, which should return a truthy value if the node is to be included. This can be useful to calculate the bounding box of a portion of the graph. ||
+| <b>getGraphBbox</b>([<i>nodeFilterFn</i>]) | Returns the current bounding box of the nodes in the graph, formatted as `{ x: [<num>, <num>], y: [<num>, <num>], z: [<num>, <num>] }`. If no nodes are found, returns `null`. Accepts an optional argument to define a custom node filter: `node => <boolean>`, which should return a truthy value if the node is to be included. This can be useful to calculate the bounding box of a portion of the graph. |
 | <b>graph2ScreenCoords</b>(<i>x</i>, <i>y</i>, <i>z</i>) | Utility method to translate node coordinates to the viewport domain. Given a set of `x`,`y`,`z` graph coordinates, returns the current equivalent `{x, y}` in viewport coordinates. |
 | <b>screen2GraphCoords</b>(<i>x</i>, <i>y</i>, <i>distance</i>) | Utility method to translate viewport distance coordinates to the graph domain. Given a pair of `x`,`y` screen coordinates and distance from the camera, returns the current equivalent `{x, y, z}` in the domain of graph node coordinates. |
 

package/dist/3d-force-graph.d.ts

@@ -1,6 +1,6 @@
 import { WebGLRendererParameters, Renderer, Light, Scene, Camera, WebGLRenderer } from 'three';
 import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer.js';
-import { ThreeForceGraphGeneric } from 'three-forcegraph';
+import { NodeObject, LinkObject, ThreeForceGraphGeneric } from 'three-forcegraph';
 
 interface ConfigOptions {
   controlType?: 'trackball' | 'orbit' | 'fly'
@@ -9,15 +9,15 @@ interface ConfigOptions {
 }
 
 type Accessor<In, Out> = Out | string | ((obj: In) => Out);
-type ObjAccessor<T> = Accessor<object, T>;
+type ObjAccessor<T, InT = object> = Accessor<InT, T>;
 
 type Coords = { x: number; y: number; z: number; };
 
 // don't surface these internal props from inner ThreeForceGraph
 type ExcludedInnerProps = 'onLoading' | 'onFinishLoading' | 'onUpdate' | 'onFinishUpdate' | 'tickFrame' | 'd3AlphaTarget' | 'resetCountdown';
 
-interface ForceGraph3DGenericInstance<ChainableInstance>
-    extends Omit<ThreeForceGraphGeneric<ChainableInstance>, ExcludedInnerProps> {
+interface ForceGraph3DGenericInstance<ChainableInstance, N extends NodeObject = NodeObject, L extends LinkObject<N> = LinkObject<N>>
+    extends Omit<ThreeForceGraphGeneric<ChainableInstance, N, L>, ExcludedInnerProps> {
   (element: HTMLElement): ChainableInstance;
   _destructor(): void;
 
@@ -32,20 +32,20 @@ interface ForceGraph3DGenericInstance<ChainableInstance>
   showNavInfo(enabled: boolean): ChainableInstance;
 
   // Labels
-  nodeLabel(): ObjAccessor<string>;
-  nodeLabel(textAccessor: ObjAccessor<string>): ChainableInstance;
-  linkLabel(): ObjAccessor<string>;
-  linkLabel(textAccessor: ObjAccessor<string>): ChainableInstance;
+  nodeLabel(): ObjAccessor<string, N>;
+  nodeLabel(textAccessor: ObjAccessor<string, N>): ChainableInstance;
+  linkLabel(): ObjAccessor<string, L>;
+  linkLabel(textAccessor: ObjAccessor<string, L>): ChainableInstance;
 
   // Interaction
-  onNodeClick(callback: (node: object, event: MouseEvent) => void): ChainableInstance;
-  onNodeRightClick(callback: (node: object, event: MouseEvent) => void): ChainableInstance;
-  onNodeHover(callback: (node: object | null, previousNode: object | null) => void): ChainableInstance;
-  onNodeDrag(callback: (node: object, translate: Coords) => void): ChainableInstance;
-  onNodeDragEnd(callback: (node: object, translate: Coords) => void): ChainableInstance;
-  onLinkClick(callback: (link: object, event: MouseEvent) => void): ChainableInstance;
-  onLinkRightClick(callback: (link: object, event: MouseEvent) => void): ChainableInstance;
-  onLinkHover(callback: (link: object | null, previousLink: object | null) => void): ChainableInstance;
+  onNodeClick(callback: (node: N, event: MouseEvent) => void): ChainableInstance;
+  onNodeRightClick(callback: (node: N, event: MouseEvent) => void): ChainableInstance;
+  onNodeHover(callback: (node: N | null, previousNode: N | null) => void): ChainableInstance;
+  onNodeDrag(callback: (node: N, translate: Coords) => void): ChainableInstance;
+  onNodeDragEnd(callback: (node: N, translate: Coords) => void): ChainableInstance;
+  onLinkClick(callback: (link: L, event: MouseEvent) => void): ChainableInstance;
+  onLinkRightClick(callback: (link: L, event: MouseEvent) => void): ChainableInstance;
+  onLinkHover(callback: (link: L | null, previousLink: L | null) => void): ChainableInstance;
   onBackgroundClick(callback: (event: MouseEvent) => void): ChainableInstance;
   onBackgroundRightClick(callback: (event: MouseEvent) => void): ChainableInstance;
   linkHoverPrecision(): number;
@@ -62,7 +62,7 @@ interface ForceGraph3DGenericInstance<ChainableInstance>
   resumeAnimation(): ChainableInstance;
   cameraPosition(): Coords;
   cameraPosition(position: Partial<Coords>, lookAt?: Coords, transitionMs?: number): ChainableInstance;
-  zoomToFit(durationMs?: number, padding?: number, nodeFilter?: (node: object) => boolean): ChainableInstance;
+  zoomToFit(durationMs?: number, padding?: number, nodeFilter?: (node: N) => boolean): ChainableInstance;
   postProcessingComposer(): EffectComposer;
   lights(): Light[];
   lights(lights: Light[]): ChainableInstance;
@@ -76,8 +76,8 @@ interface ForceGraph3DGenericInstance<ChainableInstance>
   screen2GraphCoords(screenX: number, screenY: number, distance: number): Coords;
 }
 
-type ForceGraph3DInstance = ForceGraph3DGenericInstance<ForceGraph3DInstance>;
+type ForceGraph3DInstance<NodeType = NodeObject, LinkType = LinkObject<NodeType>> = ForceGraph3DGenericInstance<ForceGraph3DInstance<NodeType, LinkType>, NodeType, LinkType>;
 
-declare function ForceGraph3D(configOptions?: ConfigOptions): ForceGraph3DInstance;
+declare function ForceGraph3D<NodeType = NodeObject, LinkType = LinkObject<NodeType>>(configOptions?: ConfigOptions): ForceGraph3DInstance<NodeType, LinkType>;
 
 export { type ConfigOptions, type ForceGraph3DGenericInstance, type ForceGraph3DInstance, ForceGraph3D as default };