@react-sigma/core/src/hooks/useLoadGraph.ts

React Sigma

import Graph from 'graphology';
import { Attributes } from 'graphology-types';
import { useCallback } from 'react';

import { useSigma } from './useSigma';

/**
 * React hook that helps you to load a graph.
 * If a graph was previously loaded in Sigma/Graphology, per default it is cleared.
 * You can change this behaviour by settings the parameter `clear` to false.
 *
 * ```typescript
 * const loadGraph = useLoadGraph();
 * ...
 * useEffect(() => {
 *  loadGraph(erdosRenyi(UndirectedGraph, { order: 100, probability: 0.2 }), true);
 * }, []);
 *```
 * @category Hook
 */
export function useLoadGraph<
  N extends Attributes = Attributes,
  E extends Attributes = Attributes,
  G extends Attributes = Attributes,
>(): (graph: Graph<N, E, G>, clear?: boolean) => void {
  const sigma = useSigma<N, E, G>();

  return useCallback(
    (graph: Graph<N, E, G>, clear = true) => {
      if (sigma && graph) {
        if (clear && sigma.getGraph().order > 0) sigma.getGraph().clear();
        sigma.getGraph().import(graph);
        sigma.refresh();
      }
    },
    [sigma],
  );
}