@antv/layout/lib/d3-force/types.d.ts

graph layout algorithm

import type { Simulation, SimulationLinkDatum, SimulationNodeDatum } from 'd3-force';
import type { EdgeData, LayoutMapping, NodeData } from '../types';
export interface D3ForceLayoutOptions {
    /**
     * <zh/> 节点大小（直径）。用于防止节点重叠时的碰撞检测
     *
     * <en/> Node size (diameter). Used for collision detection when nodes overlap
     *
     * @defaultValue 10
     */
    nodeSize?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
    /**
     * <zh/> 每次迭代执行回调
     *
     * <en/> Callback executed on each tick
     * @param data - <zh/> 布局结果 | <en/> layout result
     */
    onTick?: (data: LayoutMapping) => void;
    /**
     * <zh/> 迭代次数
     *
     * <en/> Number of iterations
     * @description
     * <zh/> 设置的是力的迭代次数，而不是布局的迭代次数
     *
     * <en/> The number of iterations of the force, not the layout
     */
    iterations?: number;
    /**
     * <zh/> 自定义 force 方法，若不指定，则使用 d3.js 的方法
     *
     * <en/> Custom force method, if not specified, use d3.js method
     */
    forceSimulation?: Simulation<NodeDatum, EdgeDatum>;
    /**
     * <zh/> 当前的迭代收敛阈值
     *
     * <en/> Convergence threshold of the current iteration
     */
    alpha?: number;
    /**
     * <zh/> 停止迭代的阈值
     *
     * <en/> Convergence threshold of the current iteration
     */
    alphaMin?: number;
    /**
     * <zh/> 迭代阈值的衰减率。范围 [0, 1]。0.028 对应迭代数为 300
     *
     * <en/> Convergence threshold of the current iteration
     */
    alphaDecay?: number;
    /**
     * <zh/> 设置目标迭代收敛阈值
     *
     * <en/> Set the target convergence threshold of the current iteration
     */
    alphaTarget?: number;
    /**
     * <zh/> 指定衰减因子
     *
     * <en/> Specify the decay factor
     */
    velocityDecay?: number;
    /**
     * <zh/> 设置用于生成随机数的函数
     *
     * <en/> Set the function for generating random numbers
     * @returns <zh/> 随机数 | <en/> Random number
     */
    randomSource?: () => number;
    /**
     * <zh/> 中心力
     *
     * <en/> Center force
     */
    center?: false | {
        x?: number;
        y?: number;
        strength?: number;
    };
    /**
     * <zh/> 碰撞力
     *
     * <en/> Collision force
     */
    collide?: false | {
        radius?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        strength?: number;
        iterations?: number;
    };
    /**
     * <zh/> 多体力
     *
     * <en/> Many body force
     */
    manyBody?: false | {
        strength?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        theta?: number;
        distanceMin?: number;
        distanceMax?: number;
    };
    /**
     * <zh/> 链接力
     *
     * <en/> Link force
     */
    link?: false | {
        id?: (edge: EdgeDatum, index: number, edges: EdgeDatum[]) => string;
        distance?: number | ((edge: EdgeDatum, index: number, edges: EdgeDatum[]) => number);
        strength?: number | ((edge: EdgeDatum, index: number, edges: EdgeDatum[]) => number);
        iterations?: number;
    };
    /**
     * <zh/> 径向力
     *
     * <en/> Radial force
     */
    radial?: false | {
        strength?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        radius?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        x?: number;
        y?: number;
    };
    /**
     * <zh/> X 轴力
     *
     * <en/> X axis force
     */
    x?: false | {
        strength?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        x?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
    };
    /**
     * <zh/> Y 轴力
     *
     * <en/> Y axis force
     */
    y?: false | {
        strength?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
        y?: number | ((node: NodeDatum, index: number, nodes: NodeDatum[]) => number);
    };
}
export interface NodeDatum extends NodeData, SimulationNodeDatum {
}
export interface EdgeDatum extends EdgeData, SimulationLinkDatum<NodeDatum> {
}