ngx-loom is an Angular 17 compatible library with the sole purpose of easily rendering directed graph structures.
To install, utilize the command npm i ngx-loom
.
ngx-loom currently provides the following features:
- Ability to render directed (or undirected) graph structures.
- Ability to overwrite the default node and edge display styles utilizing ng-templates.
- Ability to pan and zoom the displayed graph.
- Ability to implement custom 'layouts', which allows replacing the default rendering engine.
- Ability to bind to output events raised when a graph node or edge is clicked.
- Ability to center and auto-zoom the graph utilizing exposed methods.
To setup for development, run the following commands within a Linux terminal.
git clone "https://github.com/Sn00pyW00dst0ck/ng-loom.git"
cd ng-loom
npm i
There are five npm scripts available to build and run ngx-loom and its demo application.
build:demo:dev
- Builds the demo application with development configuration.build:demo:prod
- Builds the demo applicaiton with production configuration.build:loom:dev
- Builds the ngx-loom project with development configuration.build:loom:prod
- Builds the ngx-loom project with production configuration.serve:demo
- Serves the demo application to localhost.
Note
In order to build the demo application, first the ngx-loom project must be built. Without completing this step, building the demo application may fail.
There are four npm scripts available to test ngx-loom and its demo application.
test:demo
- Runs unit tests for the demo application.test:demo:headless
- Runs unit tests for the demo application within headless mode.test:loom
- Runs unit tests for the ngx-loom project.test:loom:headless
- Runs unit tests for the ngx-loom project within headless mode.
Documentation for ngx-loom is created utilizing Compodoc. There are two provided npm scripts to generate documentation, or you can view the docs at this page.
compodoc:build
- Builds the documentation to a directory/documentation
.compodoc:serve
- Builds and serves the documentation tolocalhost:5555
.
Note
Documentation is not generated for the loom-demo project, only ngx-loom. Documentation is not 100% comprehensive, but will improve with time.
This project was generated with Angular CLI version 17.3.6.