react-network-diagrams

React Network Diagrams

This repository contains an initial set of React circuit drawing and network mapping components which are used within the ESnet Portal, but are not tied to ESnet, or even to network visualization.

The mapping portion of this library is used in the public facing ESnet Portal. The circuit diagrams code us used internally to track ESnet circuits in the ESDB.

Current features of the library include:

• Circuit diagrams:
  • Basic
  • Concatenated
  • Parallel
• Circuit couplers
• Patch panel diagrams
• Topology mapping
  • Higher level network traffic visualization
  • Linear, arc, bidirectional traffic and square edge types
• Route rendering

Please browse the examples for a feel for the library, or read on to get started.

Getting started

The charts library is intended to be used with npm and the built into your project with something like webpack.

npm install react-network-diagrams --save

Once installed, you can import the necessary components from the library:

import { TrafficMap } from "react-network-diagrams";

You can then render() the traffic map in your component:

<TrafficMap width={980} height={500} margin={50}
            topology={topo}
            traffic={traffic}
            edgeColorMap={edgeColorMap}
            edgeDrawingMethod="bidirectionalArrow"
            edgeThicknessMap={edgeThicknessMap}
            edgeShapeMap={edgeShapeMap}
            nodeSizeMap={nodeSizeMap}
            nodeShapeMap={nodeShapeMap}
            stylesMap={stylesMap}
            selection={mapSelection}
            onSelectionChange={this.handleSelectionChanged} />
            

See the examples for more information.

Examples

To run the examples yourself you first need to run:

npm install

This will install the development dependencies into your node_modules directory.

You can then start up the test server, as well as automatic source building, by doing:

npm run start-website

And now, for the magic, point your browser to:

http://localhost:8080/webpack-dev-server/

From now on, if you change the source code, webpack will rebuild the examples bundle and the browser will refresh itself. Errors will also be reported in the browser window.

Before commiting back, run:

npm run build

Changelog

v1.0.0

5th July 2022

This release contains a set of bug fixes and enhancements.

Enhancements

• BREAKING CHANGE : Renamed a misnamed prop from edgeThinknessMap to edgeThicknessMap
• Ability to style the background and default edge color of the traffic map
• Ability to add a square shape to the legend as a type

Bug Fixes

• Fix a PropType that was throwing an error on import
• Fix an error that was caused due to not propagating the event in the onMouseDown() function