sander/d3-dot-graph
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Compare commits

base: sander:master
Branches Tags
sander:master
sander:1.0.0
..
compare: sander:1.0.0
Branches Tags
sander:master
sander:1.0.0

No commits in common. "master" and "1.0.0" have entirely different histories.
master ... 1.0.0

2 changed files with 12 additions and 39 deletions
Show stats Expand all files Collapse all files

51
README.md
View file

@ -1,32 +1,17 @@
# d3-dot-graph # d3-dot-graph
This module provides [D3js][d3js] compatible library to parse and load files in [graphviz][graphviz] [DOT (.dot)][dot] (graph description language) format. This module provides [D3js](#d3js) compatible library to parse and load files in graphviz [.dot](#dot) (graph description language) format.
## why? ## why?
While working on [Java Platform Module System][jpms] migration projects coming with Java 9 (as of August 2017), I am heavily using [jdeps][jdeps] which is generating [DOT (.dot)][dot] files. These are usually visualised using dot tool of [graphviz][graphviz]. While working on Java Platform Module System migration projects coming with Java 9 (as of August 2017), I am havily using jdeps which is generating DOT (.dot) files. These are usually visualized using dot tool of graphviz.
In most cases it is enough, but I wanted to have nicer [D3js][d3js] visualisation and interaction. In most cases it is enough, but I wanted to have nicer d3js visualization and interaction.
## example
See sample `summary.dot` file generated by [jdeps][jdeps] visualised using [D3js][d3js] here: [index.html][example]
![](doc/digraph.png "Sample .dot file generated by jdeps visualised using D3js")
Inspired by Mike Bostock's [Mobile Patent Suits][mbostock]
## usage ## usage
Usage is identical with well known ´d3.json([url], [callback])´ or ´d3.csv([url], [callback])´.
```js ```js
d3.dot(url, callback);
```
Usage is identical with well known `d3.json([url], [callback])` or `d3.csv([url], [callback])`.
```html
<script src="https://cdn.jsdelivr.net/gh/gmamaladze/d3-dot-graph@1.0.0/build/d3-dot-graph.min.js"></script>
<script>
d3.dot("/path/to/graph.dot", function(error, graph) { d3.dot("/path/to/graph.dot", function(error, graph) {
if (error) throw error; if (error) throw error;
console.log(JSON.stringify(graph, null, true)); console.log(JSON.stringify(graph, null, true));
@ -35,31 +20,19 @@ d3.dot("/path/to/graph.dot", function(error, graph) {
// "links": [ {"source": "Myriel"}, {"target": "Napoleon"}] // "links": [ {"source": "Myriel"}, {"target": "Napoleon"}]
//} //}
}); });
</script>
``` ```
## parser ## parser
The parser was generated using [PEG.js][pegjs]. The grammer is taken from here [cpettitt/graphlib-dot](https://github.com/cpettitt/graphlib-dot). Thanks to Chris Pettitt. The parser was generated using [PEG.js](#pegjs). The grammer is taken from here [cpettitt/graphlib-dot](https://github.com/cpettitt/graphlib-dot). Thanks to Chris Pettitt.
You can also use parser independently from loader and converter. You can also use parser independently from loader and converter.
## build # build
```shell
npm install #install dependencies and build
npm run build #generate parser, and rollup
rollup -c -w (rollup --config --watch) #very convenient rolls the whenever sources are changed
```
[d3js]: https://www.d3js.org ## notes
[dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language)
[pegjs]: https://pegjs.org [#d3js]: https://www.d3js.org
[jpms]: http://openjdk.java.net/projects/jigsaw/spec/sotms [#dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language)
[jdeps]: https://docs.oracle.com/javase/9/tools/jdeps.htm [#pegjs]: https://pegjs.org
[graphviz]: http://www.graphviz.org
[mbostock]: http://bl.ocks.org/mbostock/1153292
[example]: https://cdn.rawgit.com/gmamaladze/d3-dot-graph/cf08847e/example/index.html

BIN
doc/digraph.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 35 KiB