Lumagrid
    Preparing search index...

    Interface ForceGraphProps

    Props for ForceGraph.

    interface ForceGraphProps {
        ariaLabel?: string;
        colorField?: string;
        data: TransformedData;
        height: number;
        idField?: string;
        iterations?: number;
        labelField?: string;
        onSelect?: (node: { id: string; label: string }) => void;
        relayout?: boolean;
        seed?: number;
        theme: ThemeDefinition;
        valueField?: string;
        width: number;
        xField?: string;
        yField?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    ariaLabel?: string
    colorField?: string

    Groups rows into colored series (LineChart).

    height: number
    idField?: string

    Identifies a node (ForceGraph).

    iterations?: number

    Simulation iterations per layout run. Default 60.

    labelField?: string

    Category or display label: bar label, line x category, pie slice label, force-graph node label.

    onSelect?: (node: { id: string; label: string }) => void

    Called with the node id and label when a node is clicked or activated with Enter/Space.

    relayout?: boolean

    Re-run the layout simulation when the graph's nodes or edges change. Default true. When false, the layout is computed once; on later data changes existing nodes keep their positions, new nodes are placed at their seeded initial position, and removed nodes are dropped — no re-simulation. Resizing never triggers a relayout (positions are rescaled to fit).

    seed?: number

    Seed for the deterministic initial node placement. Default 1.

    valueField?: string

    Numeric measure: bar length, line y value, pie slice size, choropleth color value.

    width: number
    xField?: string

    Use valueField, labelField or idField (the mapping depends on the chart, see CHANGELOG.md). Removed in 2.0.

    yField?: string

    Use valueField, labelField or idField (the mapping depends on the chart, see CHANGELOG.md). Removed in 2.0.