Topology Graph Component

Topology Graph Component is an Angular library using D3.js to visualize network graph topology. It is designed to communicate with REST API of Sandbox microservice

Prerequisites

To use the library you need to have installed:

• NPM with access to KYPO registry

Usage

To use the topology component in your Angular application follow these steps:

1. Run npm install @muni-kypo-crp/topology-graph
2. Create topology config class extending Kypo2TopologyGraphConfig from the library. Config contains following options:
   • topologyRestUrl (url where Sandbox microservice is running)
   • decoratorsRestUrl (currently not supported by backend, leave as empty string)
   • defaultDecoratorRefreshPeriodInSeconds (currently not supported by backend)
   • useRealTime (currently not supported by backend, always set to false)
   • useDecorators (currently not supported by backend, always set to false)
3. Import Kypo2TopologyGraphModule from kypo2-topology-graph and add it to imports in your module with Kypo2TopologyGraphModule.forRoot(new CustomTopologyConfig()).
4. Use <kypo2-topology-graph> directive in your code and set its size by binding to [width] and [height] attributes. Pass sandbox id to component by binding to [sandboxId] attribute. If you wish to be notified when data of tology is loaded for the first time you can bind to (onTopologyLoaded) event.
5. Manually copy folders decorators and icons into your assets/images (script or better way to include assets TBD)
6. Subscribe to observables of Kypo2TopologyLoadingService and Kypo2TopologyErrorService to display loading and error messages emitted from the component in a standard way of your app

You will need to provide data for the components. This can be done in two ways

• Use mocked data with JSON server. After installing json-server run json-server -w db.json -r routes.json in dir utils/json-server.