galaxy-nodes
    Preparing search index...

    Interface GraphNode<TMeta>

    A renderable graph node. Only id is required; if position is omitted the built-in layout generates a stable 3D coordinate. Everything else is optional and resolved through GraphAccessors so the engine stays domain-free. Attach any domain payload (scores, metrics, tags, ...) to meta and read it back in your accessors and detail renderers.

    interface GraphNode<TMeta = unknown> {
        color?: string;
        group?: string;
        id: string;
        image?: string;
        label?: string;
        major?: boolean;
        meta?: TMeta;
        name?: string;
        position?: Vec3;
        ring?: boolean;
        size?: number;
        type?: string;
    }

    Type Parameters

    • TMeta = unknown
    Index

    Properties

    color? group? id image? label? major? meta? name? position? ring? size? type?

    Properties

    color?: string

    Explicit color override; wins over the accessor default.

    group?: string

    Grouping / filter key used by the category nav and cluster association.

    id: string
    image?: string

    Optional image URL rendered on the node's planet overlay.

    The renderer loads this URL as a WebGL texture with crossOrigin: 'anonymous'. Treat values as consumer-supplied remote content: validate allowed origins in your host app and allow those origins in CSP img-src.

    label?: string

    Display name shown in the detail panel heading.

    major?: boolean

    Major nodes render as interactive "planets" with labels.

    meta?: TMeta

    Arbitrary domain payload.

    name?: string

    Optional display name; used as a display fallback when label is absent.

    position?: Vec3
    ring?: boolean

    Opt-in orbit/donut ring around this node. Defaults to false.

    size?: number

    World-space size; the renderer defaults to 1.

    type?: string

    Optional node type label; useful when imported data stores names under type.

    Settings

    Member Visibility

    On This Page

    Properties