1.0.0 • Published 2 years ago

react-digraph-18 v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-digraph

Demo

Overview

A React component which makes it easy to create a directed graph editor without implementing any of the SVG drawing or event handling logic.

Important v5.0.0 Information

Version 5.0.0 is a breaking change to some of the API interfaces. Many of the component attributes are the same, and the data format is the same, but there have been some necessary changes to improve the API, make the component faster, and add new features. Many changes will be listed below in the deprecation notes section. If you notice a problem, please use the ^4.0.0 versions of the package and refer to the legacy documentation in the v4.x.x git branch.

Installation

npm install --save react-digraph

If you don't have the following peerDependenies, make sure to install them:

npm install --save react react-dom

Usage

The default export is a component called GraphView; it provides a multitude of hooks for various graph editing operations and a set of controls for zooming. Typically, it should be wrapped in a higher order component that supplies various callbacks (onCreateNode, onCreateEdge etc...).

GraphView expects several properties to exist on your nodes and edges. If these types conflict with existing properties on your data, you must transform your data to re-key these properties under different names and to add the expected properties. All nodes and edges can have a type attribute set - nodes also support a subtype attribute. For a full description of node and edge properties, see the sections for INode and IEdge below.

Configuration for nodes and edges can be passed to GraphView via the nodeTypes, nodeSubtypes, and edgeTypes props. Custom SVG elements can be defined here for the node's type/subtype and the edge's type.

It is often convenient to combine these types into a configuration object that can be referred to elsewhere in the application and used to associate events fired from nodes/edges in the GraphView with other actions in the application. Here is an abbreviated example:

import {
  GraphView, // required
  Edge, // optional
  type IEdge, // optional
  Node, // optional
  type INode, // optional
  type LayoutEngineType, // required to change the layoutEngineType, otherwise optional
  BwdlTransformer, // optional, Example JSON transformer
  GraphUtils // optional, useful utility functions
} from 'react-digraph';

const GraphConfig =  {
  NodeTypes: {
    empty: { // required to show empty nodes
      typeText: "None",
      shapeId: "#empty", // relates to the type property of a node
      shape: (
        <symbol viewBox="0 0 100 100" id="empty" key="0">
          <circle cx="50" cy="50" r="45"></circle>
        </symbol>
      )
    },
    custom: { // required to show empty nodes
      typeText: "Custom",
      shapeId: "#custom", // relates to the type property of a node
      shape: (
        <symbol viewBox="0 0 50 25" id="custom" key="0">
          <ellipse cx="50" cy="25" rx="50" ry="25"></ellipse>
        </symbol>
      )
    }
  },
  NodeSubtypes: {},
  EdgeTypes: {
    emptyEdge: {  // required to show empty edges
      shapeId: "#emptyEdge",
      shape: (
        <symbol viewBox="0 0 50 50" id="emptyEdge" key="0">
          <circle cx="25" cy="25" r="8" fill="currentColor"> </circle>
        </symbol>
      )
    }
  }
}

const NODE_KEY = "id"       // Allows D3 to correctly update DOM

class Graph extends Component {

  constructor(props) {
    super(props);

    this.state = {
      graph: sample,
      selected: {}
    }
  }

  /* Define custom graph editing methods here */

  render() {
    const nodes = this.state.graph.nodes;
    const edges = this.state.graph.edges;
    const selected = this.state.selected;

    const NodeTypes = GraphConfig.NodeTypes;
    const NodeSubtypes = GraphConfig.NodeSubtypes;
    const EdgeTypes = GraphConfig.EdgeTypes;

    return (
      <div id='graph' style={styles.graph}>

        <GraphView  ref='GraphView'
                    nodeKey={NODE_KEY}
                    nodes={nodes}
                    edges={edges}
                    selected={selected}
                    nodeTypes={NodeTypes}
                    nodeSubtypes={NodeSubtypes}
                    edgeTypes={EdgeTypes}
                    onSelectNode={this.onSelectNode}
                    onCreateNode={this.onCreateNode}
                    onUpdateNode={this.onUpdateNode}
                    onDeleteNode={this.onDeleteNode}
                    onSelectEdge={this.onSelectEdge}
                    onCreateEdge={this.onCreateEdge}
                    onSwapEdge={this.onSwapEdge}
                    onDeleteEdge={this.onDeleteEdge}/>
      </div>
    );
  }

}

A typical graph that would be stored in the Graph component's state looks something like this:

{
  "nodes": [
    {
      "id": 1,
      "title": "Node A",
      "x": 258.3976135253906,
      "y": 331.9783248901367,
      "type": "empty"
    },
    {
      "id": 2,
      "title": "Node B",
      "x": 593.9393920898438,
      "y": 260.6060791015625,
      "type": "empty"
    },
    {
      "id": 3,
      "title": "Node C",
      "x": 237.5757598876953,
      "y": 61.81818389892578,
      "type": "custom"
    },
    {
      "id": 4,
      "title": "Node C",
      "x": 600.5757598876953,
      "y": 600.81818389892578,
      "type": "custom"
    }
  ],
  "edges": [
    {
      "source": 1,
      "target": 2,
      "type": "emptyEdge"
    },
    {
      "source": 2,
      "target": 4,
      "type": "emptyEdge"
    }
  ]
}

For a detailed example, check out src/examples/graph.js. To run the example:

npm install
npm run serve

A webpage will open in your default browser automatically.

  • To add nodes, hold shift and click on the grid.
  • To add edges, hold shift and click/drag to between nodes.
  • To delete a node or edge, click on it and press delete.
  • Click and drag nodes to change their position.

All props are detailed below.

Props

PropTypeRequiredNotes
nodeKeystringtrueKey for D3 to update nodes(typ. UUID).
nodesArray<INode>trueArray of graph nodes.
edgesArray<IEdge>trueArray of graph edges.
allowMultiselectbooleanfalseUse Ctrl-Shift-LeftMouse to draw a multiple selection box
selectedobjecttrueThe currently selected graph entity.
selectedNodesArray<INode>falseIf allowMultiselect is true, this should be the currently selected array of nodes.
selectedEdgesArray<IEdge>trueIf allowMultiselect is true, this should be the currently selected array of edges.
nodeTypesobjecttrueConfig object of available node types.
nodeSubtypesobjecttrueConfig object of available node subtypes.
edgeTypesobjecttrueConfig object of available edge types.
onSelectfuncfalseCalled when nodes are selected when allowMultiselect is true. Is passed an object with nodes and edges included.
onSelectNodefuncfalseCalled when a node is selected.
onCreateNodefunctrueCalled when a node is created.
onContextMenufunctrueCalled when contextmenu event triggered.
onUpdateNodefunctrueCalled when a node is moved.
onDeleteNodefunctrueCalled when a node is deleted.
onSelectEdgefunctrueCalled when an edge is selected.
onCreateEdgefunctrueCalled when an edge is created.
onSwapEdgefunctrueCalled when an edge 'target' is swapped.
onDeleteEdgefunctrueCalled when an edge is deleted.
onBackgroundClickfuncfalseCalled when the background is clicked.
onArrowClickedfuncfalseCalled when the arrow head is clicked.
onUndofuncfalseA function called when Ctrl-Z is activated. React-digraph does not keep track of actions, this must be implemented in the client website.
onCopySelectedfuncfalseA function called when Ctrl-C is activated. React-digraph does not keep track of copied nodes or edges, the this must be implemented in the client website.
onPasteSelectedfuncfalseA function called when Ctrl-V is activated. React-digraph does not keep track of copied nodes or edges, the this must be implemented in the client website.
canDeleteNodefuncfalseCalled before a node is deleted.
canCreateEdgefuncfalseCalled before an edge is created.
canDeleteEdgefuncfalseCalled before an edge is deleted.
canSwapEdgefuncfalseCalled before an edge 'target' is swapped.
afterRenderEdgefuncfalseCalled after an edge is rendered.
renderNodefuncfalseCalled to render node geometry.
renderNodeTextfuncfalseCalled to render the node text
renderDefsfuncfalseCalled to render SVG definitions.
renderBackgroundfuncfalseCalled to render SVG background.
readOnlyboolfalseDisables all graph editing interactions.
disableBackspaceboolfalseDisables using backspace to delete the selected node.
maxTitleCharsnumberfalseTruncates node title characters.
gridSizenumberfalseOverall grid size.
gridSpacingnumberfalseGrid spacing.
gridDotSizenumberfalseGrid dot size.
minZoomnumberfalseMinimum zoom percentage.
maxZoomnumberfalseMaximum zoom percentage.
nodeSizenumberfalseNode bbox size.
edgeHandleSizenumberfalseEdge handle size.
edgeArrowSizenumberfalseEdge arrow size in pixels. Default 8. Set to 0 to hide arrow.
zoomDelaynumberfalseDelay before zoom occurs.
zoomDurnumberfalseDuration of zoom transition.
showGraphControlsbooleanfalseWhether to show zoom controls.
layoutEngineTypetypeof LayoutEngineTypefalseUses a pre-programmed layout engine, such as 'SnapToGrid'
rotateEdgeHandlebooleanfalseWhether to rotate edge handle with edge when a node is moved
centerNodeOnMovebooleanfalseWhether the node should be centered on cursor when moving a node
initialBBoxtypeof IBBoxfalseIf specified, initial render graph using the given bounding box
graphConfigobjectfalsedagre graph setting configuration, which will override layout engine graph configuration - only apply to 'HorizontalTree'
nodeSizeOverridesAllowedbooleanfalseFlag to toggle sizeOverride in nodes - only apply to 'HorizontalTree'
nodeLocationOverridesobjectfalseNodes location overrides object - only apply to 'HorizontalTree'

onCreateNode

You have access to d3 mouse event in onCreateNode function.

  onCreateNode = (x, y, mouseEvent) => {
    // we can get the exact mouse position when click happens with this line
    const {pageX, pageY} = mouseEvent;
    // rest of the code for adding a new node ...
  };

Prop Types:

  nodes: any[];
  edges: any[];
  minZoom?: number;
  maxZoom?: number;
  readOnly?: boolean;
  maxTitleChars?: number;
  nodeSize?: number;
  edgeHandleSize?: number;
  edgeArrowSize?: number;
  zoomDelay?: number;
  zoomDur?: number;
  showGraphControls?: boolean;
  nodeKey: string;
  gridSize?: number;
  gridSpacing?: number;
  gridDotSize?: number;
  backgroundFillId?: string;
  nodeTypes: any;
  nodeSubtypes: any;
  edgeTypes: any;
  selected: any;
  selectedNodes: INode[];
  selectedEdges: IEdge[];
  onSelect?: ({ nodes: INode[], edges: IEdge[]) => void,
  onBackgroundClick?: (x: number, y: number) => void;
  onDeleteNode: (selected: any, nodeId: string, nodes: any[]) => void;
  onSelectNode: (node: INode | null) => void;
  onCreateNode: (x: number, y: number, event: object) => void;
  onCreateEdge: (sourceNode: INode, targetNode: INode) => void;
  onDeleteEdge: (selectedEdge: IEdge, edges: IEdge[]) => void;
  onUpdateNode: (node: INode) => void;
  onSwapEdge: (sourceNode: INode, targetNode: INode, edge: IEdge) => void;
  onSelectEdge: (selectedEdge: IEdge) => void;
  onArrowClicked?: (edge: IEdge) => void;
  canDeleteNode?: (selected: any) => boolean;
  canDeleteEdge?: (selected: any) => boolean;
  canCreateEdge?: (startNode?: INode, endNode?: INode) => boolean;
  canSwapEdge?: (sourceNode: INode, targetNode: INode, edge: IEdge) => boolean;
  afterRenderEdge?: (id: string, element: any, edge: IEdge, edgeContainer: any, isEdgeSelected: boolean) => void;
  onUndo?: () => void;
  onCopySelected?: () => void;
  onPasteSelected?: () => void;
  renderBackground?: (gridSize?: number) => any;
  renderDefs?: () => any;
  renderNode?: (
    nodeRef: any,
    data: any,
    index: number,
    selected: boolean,
    hovered: boolean
  ) => any;
  renderNodeText?: (data: any, id: string | number, isSelected: boolean) => any;
  layoutEngineType?: LayoutEngineType;
  rotateEdgeHandle?: boolean;
  centerNodeOnMove?: boolean;
  initialBBox?: IBBox;
  graphConfig?: object;
  nodeSizeOverridesAllowed?: boolean;
  nodeLocationOverrides?: {[string]: {x?: number, y?:number}}

INode

PropTypeRequiredNotes
titlestringtrueUsed in edges and to render the node text.
xnumberfalseX coordinate of the node.
ynumberfalseY coordinate of the node.
typestringfalseNode type, for displaying a custom SVG shape.
subtypestringfalseNode subtype, for displaying a custom SVG shape.

title

The title attribute is used for the IDs in the SVG nodes in the graph. Because Element.querySelector() is used to locate graph entities, please ensure that all titles are properly escaped (for example, with CSS.escape()).

IEdge

PropTypeRequiredNotes
sourcestringtrueThe title of the parent node.
targetstringtrueThe title of the child node.
typestringfalseEdge type, for displaying a custom SVG shape.
handleTextstringfalseText to render on the edge.
handleTooltipTextstringfalseUsed to render the SVG title element.
label_fromstringfalseText to render along the edge with label_to.
label_tostringfalseText to render along the edge with label_from.

Imperative API

You can call these methods on the GraphView class using a ref.

MethodTypeNotes
panToNode(id: string, zoom?: boolean) => voidCenter the node given by id within the viewport, optionally zoom in to fit it.
panToEdge(source: string, target: string, zoom?: boolean) => voidCenter the edge between source and target node IDs within the viewport, optionally zoom in to fit it.

Deprecation Notes

PropTypeRequiredNotes
emptyTypestringtrue'Default' node type.
getViewNodefunctrueNode getter.
renderEdgefuncfalseCalled to render edge geometry.
enableFocusboolfalseAdds a 'focus' toggle state to GraphView.
transitionTimenumberfalseFade-in/Fade-out time.
primarystringfalsePrimary color.
lightstringfalseLight color.
darkstringfalseDark color.
styleobjectfalseStyle prop for wrapper.
gridDotnumberfalseGrid dot size.
graphControlsbooleantrueWhether to show zoom controls.