flow like the river

This commit is contained in:
root 2025-11-07 00:06:12 +01:00
commit 013fe673f3
42435 changed files with 5764238 additions and 0 deletions

View file

@ -0,0 +1,255 @@
import { Object3D, Material } from 'three';
interface GraphData {
nodes: NodeObject[];
links: LinkObject[];
}
type NodeObject = object & {
/**
* Node id
*/
id?: string | number;
/**
* The nodes zero-based index into *nodes*
*/
index?: number;
/**
* The nodes current *x*-position.
* This value may be subsequently modified by forces and by the simulation.
* If it is *NaN*, the position is initialized in a 3D [phyllotaxis arrangement](https://observablehq.com/@d3/force-layout-phyllotaxis) arrangement,
* so chosen to ensure a deterministic, uniform distribution around the origin.
*/
x?: number;
/**
* The nodes current *y*-position.
* This value may be subsequently modified by forces and by the simulation.
* If it is *NaN*, the position is initialized in a 3D [phyllotaxis arrangement](https://observablehq.com/@d3/force-layout-phyllotaxis) arrangement,
* so chosen to ensure a deterministic, uniform distribution around the origin.
*/
y?: number;
/**
* The nodes current *z*-position.
* This value may be subsequently modified by forces and by the simulation.
* If it is *NaN*, the position is initialized in a 3D [phyllotaxis arrangement](https://observablehq.com/@d3/force-layout-phyllotaxis) arrangement,
* so chosen to ensure a deterministic, uniform distribution around the origin.
*/
z?: number;
/**
* The nodes current *x*-velocity.
* This value may be subsequently modified by forces and by the simulation.
* @default 0
*/
vx?: number;
/**
* The nodes current *y*-velocity.
* This value may be subsequently modified by forces and by the simulation.
* @default 0
*/
vy?: number;
/**
* The nodes current *z*-velocity.
* This value may be subsequently modified by forces and by the simulation.
* @default 0
*/
vz?: number;
/**
* The nodes fixed *x*-position.
* At the end of each tick, after the application of any forces, a node with a defined *node*.fx has *node*.x reset to this value and *node*.vx set to zero.
* To unfix a node that was previously fixed, set *node*.fx to null, or delete this property.
* @default undefined
*/
fx?: number;
/**
* The nodes fixed *y*-position.
* At the end of each tick, after the application of any forces, a node with a defined *node*.fy has *node*.y reset to this value and *node*.vy set to zero.
* To unfix a node that was previously fixed, set *node*.fy to null, or delete this property.
* @default undefined
*/
fy?: number;
/**
* The nodes fixed *z*-position.
* At the end of each tick, after the application of any forces, a node with a defined *node*.fz has *node*.z reset to this value and *node*.vz set to zero.
* To unfix a node that was previously fixed, set *node*.fz to null, or delete this property.
* @default undefined
*/
fz?: number;
};
type LinkObject = object & {
/**
* The links source node.
* When the link force is initialized (or re-initialized, as when the nodes or links change), any *link*.source property which is *not* an object is replaced by an object reference to
* the corresponding *node* with the given identifier.
*/
source?: string | number | NodeObject;
/**
* The links target node.
* When the link force is initialized (or re-initialized, as when the nodes or links change), any *link*.target property which is *not* an object is replaced by an object reference to
* the corresponding *node* with the given identifier.
*/
target?: string | number | NodeObject;
/**
* The zero-based index into links
*/
index?: number;
};
type Accessor<In, Out> = Out | string | ((obj: In) => Out);
type NodeAccessor<T> = Accessor<NodeObject, T>;
type LinkAccessor<T> = Accessor<LinkObject, T>;
type DagMode = 'td' | 'bu' | 'lr' | 'rl' | 'zout' | 'zin' | 'radialout' | 'radialin';
type ForceEngine = 'd3' | 'ngraph';
interface ForceFn {
(alpha: number): void;
initialize?: (nodes: NodeObject[], ...args: any[]) => void;
[key: string]: any;
}
type Coords = { x: number; y: number; z: number; }
type NodePositionUpdateFn = (obj: Object3D, coords: Coords, node: NodeObject) => void | null | boolean;
type LinkPositionUpdateFn = (obj: Object3D, coords: { start: Coords, end: Coords }, link: LinkObject) => void | null | boolean;
declare class ThreeForceGraphGeneric<ChainableInstance> extends Object3D {
constructor();
// Data input
graphData(): GraphData;
graphData(data: GraphData): ChainableInstance;
jsonUrl(): string | null;
jsonUrl(url: string | null): ChainableInstance;
nodeId(): string;
nodeId(id: string): ChainableInstance;
linkSource(): string;
linkSource(source: string): ChainableInstance;
linkTarget(): string;
linkTarget(target: string): ChainableInstance;
// Node styling
nodeRelSize(): number;
nodeRelSize(size: number): ChainableInstance;
nodeVal(): NodeAccessor<number>;
nodeVal(valAccessor: NodeAccessor<number>): ChainableInstance;
nodeVisibility(): NodeAccessor<boolean>;
nodeVisibility(visibilityAccessor: NodeAccessor<boolean>): ChainableInstance;
nodeColor(): NodeAccessor<string>;
nodeColor(colorAccessor: NodeAccessor<string>): ChainableInstance;
nodeAutoColorBy(): NodeAccessor<string | null>;
nodeAutoColorBy(colorByAccessor: NodeAccessor<string | null>): ChainableInstance;
nodeOpacity(): number;
nodeOpacity(opacity: number): ChainableInstance;
nodeResolution(): number;
nodeResolution(resolution: number): ChainableInstance;
nodeThreeObject(): NodeAccessor<Object3D>;
nodeThreeObject(objAccessor: NodeAccessor<Object3D>): ChainableInstance;
nodeThreeObjectExtend(): NodeAccessor<boolean>;
nodeThreeObjectExtend(extendAccessor: NodeAccessor<boolean>): ChainableInstance;
nodePositionUpdate(): NodePositionUpdateFn | null;
nodePositionUpdate(updateFn: NodePositionUpdateFn): ChainableInstance;
// Link styling
linkVisibility(): LinkAccessor<boolean>;
linkVisibility(visibilityAccessor: LinkAccessor<boolean>): ChainableInstance;
linkColor(): LinkAccessor<string>;
linkColor(colorAccessor: LinkAccessor<string>): ChainableInstance;
linkAutoColorBy(): LinkAccessor<string | null>;
linkAutoColorBy(colorByAccessor: LinkAccessor<string | null>): ChainableInstance;
linkOpacity(): number;
linkOpacity(opacity: number): ChainableInstance;
linkWidth(): LinkAccessor<number>;
linkWidth(widthAccessor: LinkAccessor<number>): ChainableInstance;
linkResolution(): number;
linkResolution(resolution: number): ChainableInstance;
linkCurvature(): LinkAccessor<number>;
linkCurvature(curvatureAccessor: LinkAccessor<number>): ChainableInstance;
linkCurveRotation(): LinkAccessor<number>;
linkCurveRotation(curveRotationAccessor: LinkAccessor<number>): ChainableInstance;
linkMaterial(): LinkAccessor<Material | boolean | null>;
linkMaterial(materialAccessor: LinkAccessor<Material | boolean | null>): ChainableInstance;
linkThreeObject(): LinkAccessor<Object3D>;
linkThreeObject(objAccessor: LinkAccessor<Object3D>): ChainableInstance;
linkThreeObjectExtend(): LinkAccessor<boolean>;
linkThreeObjectExtend(extendAccessor: LinkAccessor<boolean>): ChainableInstance;
linkPositionUpdate(): LinkPositionUpdateFn | null;
linkPositionUpdate(updateFn: LinkPositionUpdateFn): ChainableInstance;
linkDirectionalArrowLength(): LinkAccessor<number>;
linkDirectionalArrowLength(lengthAccessor: LinkAccessor<number>): ChainableInstance;
linkDirectionalArrowColor(): LinkAccessor<string>;
linkDirectionalArrowColor(colorAccessor: LinkAccessor<string>): ChainableInstance;
linkDirectionalArrowRelPos(): LinkAccessor<number>;
linkDirectionalArrowRelPos(fractionAccessor: LinkAccessor<number>): ChainableInstance;
linkDirectionalArrowResolution(): number;
linkDirectionalArrowResolution(resolution: number): ChainableInstance;
linkDirectionalParticles(): LinkAccessor<number>;
linkDirectionalParticles(numParticlesAccessor: LinkAccessor<number>): ChainableInstance;
linkDirectionalParticleSpeed(): LinkAccessor<number>;
linkDirectionalParticleSpeed(relDistancePerFrameAccessor: LinkAccessor<number>): ChainableInstance;
linkDirectionalParticleWidth(): LinkAccessor<number>;
linkDirectionalParticleWidth(widthAccessor: LinkAccessor<number>): ChainableInstance;
linkDirectionalParticleColor(): LinkAccessor<string>;
linkDirectionalParticleColor(colorAccessor: LinkAccessor<string>): ChainableInstance;
linkDirectionalParticleResolution(): number;
linkDirectionalParticleResolution(resolution: number): ChainableInstance;
emitParticle(link: LinkObject): ChainableInstance;
// Force engine configuration
forceEngine(): ForceEngine;
forceEngine(engine: ForceEngine): ChainableInstance;
numDimensions(): 1 | 2 | 3;
numDimensions(dimensions: 1 | 2 | 3): ChainableInstance;
dagMode(): DagMode;
dagMode(mode: DagMode): ChainableInstance;
dagLevelDistance(): number | null;
dagLevelDistance(distance: number): ChainableInstance;
dagNodeFilter(): (node: NodeObject) => boolean;
dagNodeFilter(filterFn: (node: NodeObject) => boolean): ChainableInstance;
onDagError(): (loopNodeIds: (string | number)[]) => void;
onDagError(errorHandleFn: (loopNodeIds: (string | number)[]) => void): ChainableInstance;
d3AlphaMin(): number;
d3AlphaMin(alphaMin: number): ChainableInstance;
d3AlphaDecay(): number;
d3AlphaDecay(alphaDecay: number): ChainableInstance;
d3AlphaTarget(): number;
d3AlphaTarget(alphaTarget: number): ChainableInstance;
d3VelocityDecay(): number;
d3VelocityDecay(velocityDecay: number): ChainableInstance;
d3Force(forceName: 'link' | 'charge' | 'center' | string): ForceFn | undefined;
d3Force(forceName: 'link' | 'charge' | 'center' | string, forceFn: ForceFn | null): ChainableInstance;
d3ReheatSimulation(): ChainableInstance;
ngraphPhysics(physics: object): ChainableInstance;
warmupTicks(): number;
warmupTicks(ticks: number): ChainableInstance;
cooldownTicks(): number;
cooldownTicks(ticks: number): ChainableInstance;
cooldownTime(): number;
cooldownTime(milliseconds: number): ChainableInstance;
resetCountdown(): ChainableInstance;
// Lifecycle methods
onEngineTick(callback: () => void): ChainableInstance;
onEngineStop(callback: () => void): ChainableInstance;
onLoading(callback: () => void): ChainableInstance;
onFinishLoading(callback: () => void): ChainableInstance;
onUpdate(callback: () => void): ChainableInstance;
onFinishUpdate(callback: () => void): ChainableInstance;
tickFrame(): ChainableInstance;
resetProps(): ChainableInstance;
refresh(): ChainableInstance;
// Utilities
getGraphBbox(nodeFilter?: (node: NodeObject) => boolean): { x: [number, number], y: [number, number], z: [number,number] };
}
declare class ThreeForceGraph extends ThreeForceGraphGeneric<ThreeForceGraph> {}
export { type GraphData, type LinkObject, type NodeObject, ThreeForceGraphGeneric, ThreeForceGraph as default };