galaxy-nodes
    Preparing search index...

    Interface GalaxyGraphVisualizerProps<NMeta, EMeta, CMeta>

    interface GalaxyGraphVisualizerProps<
        NMeta = unknown,
        EMeta = unknown,
        CMeta = unknown,
    > {
        accessors?: GraphAccessors<NMeta, EMeta>;
        brandLabel?: string;
        className?: string;
        controlActions?: ReactNode;
        dataset: GraphDataset<NMeta, EMeta, CMeta>;
        groups?: readonly string[];
        initialGroup?: string | null;
        keyLegend?: ReactNode;
        labels?: Partial<GalaxyGraphLabels>;
        largeGraph?: LargeGraphOptions<NMeta, EMeta, CMeta>;
        layout?: GraphLayoutInput;
        legend?: ReactNode;
        onContextBudgetExceeded?: (budget: GalaxyRendererContextBudget) => void;
        onDatasetSizeChange?: (size: number) => void;
        onGroupChange?: (group: string | null) => void;
        onHoverEdge?: (edge: GraphEdge<EMeta> | null) => void;
        onHoverNode?: (node: GraphNode<NMeta> | null) => void;
        onNavigate?: (command: CameraCommand) => void;
        onSceneFailure?: (failure: GalaxySceneFailure) => void;
        onSelectEdge?: (edge: GraphEdge<EMeta> | null) => void;
        onSelectNode?: (node: GraphNode<NMeta> | null) => void;
        options?: GalaxyGraphVisualizerOptions;
        renderAccessibleSummary?: (
            context: GalaxyAccessibleSummaryContext<NMeta, EMeta, CMeta>,
        ) => ReactNode;
        renderEdgeDetail?: (
            edge: GraphEdge<EMeta>,
            endpoints: { source: EdgeEndpoint<NMeta>; target: EdgeEndpoint<NMeta> },
            context?: LargeGraphDetailContext,
        ) => ReactNode;
        renderNodeDetail?: (
            node: GraphNode<NMeta>,
            context?: LargeGraphDetailContext,
        ) => ReactNode;
        renderStats?: (stats: GraphStats) => ReactNode;
        selectedEdgeId?: string | null;
        selectedNodeId?: string | null;
        sideRailActions?: ReactNode;
        theme?: GalaxyGraphTheme;
    }

    Type Parameters

    • NMeta = unknown
    • EMeta = unknown
    • CMeta = unknown
    Index

    Properties

    accessors? brandLabel? className? controlActions? dataset groups? initialGroup? keyLegend? labels? largeGraph? layout? legend? onContextBudgetExceeded? onDatasetSizeChange? onGroupChange? onHoverEdge? onHoverNode? onNavigate? onSceneFailure? onSelectEdge? onSelectNode? options? renderAccessibleSummary? renderEdgeDetail? renderNodeDetail? renderStats? selectedEdgeId? selectedNodeId? sideRailActions? theme?

    Properties

    accessors?: GraphAccessors<NMeta, EMeta>

    Visual accessors. Memoize to avoid unnecessary buffer refreshes on parent renders.

    brandLabel?: string
    className?: string
    controlActions?: ReactNode

    Extra toggles rendered in the control ribbon (e.g. domain-specific modes).

    dataset: GraphDataset<NMeta, EMeta, CMeta>
    groups?: readonly string[]

    Group filter buttons. Defaults to the distinct node.group values.

    initialGroup?: string | null
    keyLegend?: ReactNode

    Optional keyboard/mouse shortcut legend overlay.

    labels?: Partial<GalaxyGraphLabels>

    Localized labels for built-in chrome and the non-visual graph summary.

    largeGraph?: LargeGraphOptions<NMeta, EMeta, CMeta>
    layout?: GraphLayoutInput

    Optional built-in spatial layout. Omit for auto, pass false to require authored coordinates.

    legend?: ReactNode

    Replaces the legend strip; nothing renders without it.

    onContextBudgetExceeded?: (budget: GalaxyRendererContextBudget) => void
    onDatasetSizeChange?: (size: number) => void

    Called when a dataset-size button is pressed; supply a new dataset.

    onGroupChange?: (group: string | null) => void
    onHoverEdge?: (edge: GraphEdge<EMeta> | null) => void
    onHoverNode?: (node: GraphNode<NMeta> | null) => void
    onNavigate?: (command: CameraCommand) => void
    onSceneFailure?: (failure: GalaxySceneFailure) => void
    onSelectEdge?: (edge: GraphEdge<EMeta> | null) => void
    onSelectNode?: (node: GraphNode<NMeta> | null) => void
    options?: GalaxyGraphVisualizerOptions
    renderAccessibleSummary?: (
        context: GalaxyAccessibleSummaryContext<NMeta, EMeta, CMeta>,
    ) => ReactNode
    renderEdgeDetail?: (
        edge: GraphEdge<EMeta>,
        endpoints: { source: EdgeEndpoint<NMeta>; target: EdgeEndpoint<NMeta> },
        context?: LargeGraphDetailContext,
    ) => ReactNode
    renderNodeDetail?: (
        node: GraphNode<NMeta>,
        context?: LargeGraphDetailContext,
    ) => ReactNode
    renderStats?: (stats: GraphStats) => ReactNode
    selectedEdgeId?: string | null
    selectedNodeId?: string | null
    sideRailActions?: ReactNode
    theme?: GalaxyGraphTheme

    Settings

    Member Visibility

    On This Page

    Properties