Graphora API
    Preparing search index...

    Interface GraphProps<NodeData, EdgeData>

    interface GraphProps<NodeData = unknown, EdgeData = unknown> {
        ariaLabel?: string;
        className?: string;
        defaultSelection?: SelectionStateInput;
        defaultViewport?: ViewportPartial;
        fitToViewOnLayout?: boolean | FitBoundsOptions;
        graph: RawGraph<NodeData, EdgeData>;
        graphUpdatePolicy?: GraphUpdatePolicy;
        highlight?: HighlightStateInput;
        interactionStyles?: InteractionStyleInput;
        interactive?: boolean | GraphInteractionOptions;
        layout?: GraphLayout<NodeData, EdgeData>;
        layoutOptions?: GraphEngineLayoutOptions;
        onCanvasClick?: (event: GraphPointerEventBase) => void;
        onEdgeClick?: (event: GraphEdgeClickEvent<EdgeData>) => void;
        onError?: (error: unknown) => void;
        onGraphEvent?: (event: GraphEvent<NodeData, EdgeData>) => void;
        onHoverChange?: (target: HoverTarget) => void;
        onNodeClick?: (event: GraphNodeClickEvent<NodeData>) => void;
        onNodeDrag?: (event: GraphNodeDragEvent<NodeData>) => void;
        onNodeDragEnd?: (event: GraphNodeDragEvent<NodeData>) => void;
        onNodeDragStart?: (event: GraphNodeDragEvent<NodeData>) => void;
        onReady?: (api: GraphRef<NodeData, EdgeData>) => void;
        onSelectionChange?: (selection: SelectionState) => void;
        onViewportChange?: (viewport: ViewportState) => void;
        rendererFactory?: GraphRendererFactory<NodeData, EdgeData>;
        selection?: SelectionStateInput;
        style?: CSSProperties;
        theme?: RenderThemeInput;
        viewport?: ViewportPartial;
    }

    Type Parameters

    • NodeData = unknown
    • EdgeData = unknown
    Index
    ariaLabel?: string
    className?: string
    defaultSelection?: SelectionStateInput
    defaultViewport?: ViewportPartial
    fitToViewOnLayout?: boolean | FitBoundsOptions
    graphUpdatePolicy?: GraphUpdatePolicy
    interactionStyles?: InteractionStyleInput
    interactive?: boolean | GraphInteractionOptions
    layoutOptions?: GraphEngineLayoutOptions
    onCanvasClick?: (event: GraphPointerEventBase) => void
    onEdgeClick?: (event: GraphEdgeClickEvent<EdgeData>) => void
    onError?: (error: unknown) => void
    onGraphEvent?: (event: GraphEvent<NodeData, EdgeData>) => void
    onHoverChange?: (target: HoverTarget) => void
    onNodeClick?: (event: GraphNodeClickEvent<NodeData>) => void
    onNodeDrag?: (event: GraphNodeDragEvent<NodeData>) => void
    onNodeDragEnd?: (event: GraphNodeDragEvent<NodeData>) => void
    onNodeDragStart?: (event: GraphNodeDragEvent<NodeData>) => void
    onReady?: (api: GraphRef<NodeData, EdgeData>) => void
    onSelectionChange?: (selection: SelectionState) => void
    onViewportChange?: (viewport: ViewportState) => void
    style?: CSSProperties
    viewport?: ViewportPartial