Skip to content

Commit

Permalink
more stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Rowell authored and Eric Rowell committed May 10, 2019
1 parent 89b12aa commit af6917e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 11 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,23 +71,29 @@ let graph = new ElGrapho({

* ```model.edges``` - object that defines the edges between nodes based on their indices. Each edge is defined by a from-node-index and a to-node-index. In the example above, the first edge begins at node ```0``` and ends at node ```1```. For non directed graphs, or bi-directional graphs, ```from``` and ```to``` are interchangeable.

* ```width``` - number that defines the width of the El Grapho viewport in pixels. The default is 500;
* ```width``` - number that defines the width of the El Grapho viewport in pixels. The default is ```500```.

* ```height``` - number defines the height of the El Grapho viewport in pixels. The default is 500;
* ```height``` - number defines the height of the El Grapho viewport in pixels. The default is ```500```.

* ```nodeSize``` - number between 0 and 1 which defines the node size. The default is 1.
* ```nodeSize``` - number between 0 and 1 which defines the node size. The default is ```1```.

* ```edgeSize``` - number between 0 and 1 which defines the edge size. Edge sizes are relative to the connecting node size. The default is 0.25.
* ```nodeOutline``` - boolean that enables or disables node outlines. The default is ```true```.

* ```fillContainer``` - boolean that enables or disables auto filling the container. When true, El Grapho will automatically detect anytime its container has changed shape, and will auto resize itself. The default is false.
* ```edgeSize``` - number between 0 and 1 which defines the edge size. Edge sizes are relative to the connecting node size. The default is ```0.25```.

* ```tooltips``` - boolean that enables or disables tooltips. The default is true.
* ```darkMode``` - boolean that enables or disables dark mode. The default is ```false```.

* ```arrows``` - boolean that enables or disables edge arrows. The default is false. For non directed or bi-directional graphs, you should keep ```arrows``` as ```false```.
* ```globalAlpha``` - number between 0 and 1 that defines the global alpha of nodes and edges. Alphas are blended where nodes and edges intersect, resulting in a brightening effect at the intersections. The default is ```1```.

* ```animations``` - boolean that defines animation strategy. When animations is true, zoom and pan transitions will be animated. Otherwise the transitions will be immediate. Although animations utilize requestAnimationFrame for dynamic frame rates, in some situations you may prefer to set animations to false to improve transition performance for very high cardinality graphs with millions of nodes and edges. The default is true.
* ```fillContainer``` - boolean that enables or disables auto filling the container. When true, El Grapho will automatically detect anytime its container has changed shape, and will auto resize itself. The default is ```false```.

* ```debug``` - boolean that can be used to enable debug mode. Debug mode will show the node and edge count in the bottom right corner of the visualization. The default is false.
* ```tooltips``` - boolean that enables or disables tooltips. The default is ```true```.

* ```arrows``` - boolean that enables or disables edge arrows. For non directed or bi-directional graphs, you should keep ```arrows``` as ```false```. The default is ```false```.

* ```animations``` - boolean that defines animation strategy. When animations is true, zoom and pan transitions will be animated. Otherwise the transitions will be immediate. Although animations utilize requestAnimationFrame for dynamic frame rates, in some situations you may prefer to set animations to false to improve transition performance for very high cardinality graphs with millions of nodes and edges. The default is ```true```.

* ```debug``` - boolean that can be used to enable debug mode. Debug mode will show the node and edge count in the bottom right corner of the visualization. The default is ```false```.


### Layouts
Expand Down Expand Up @@ -358,6 +364,11 @@ graph.on('node-mouseover', function(evt) {

* ```graph.setSize(width, height)``` - set the graph size in pixels

* ```graph.setDarkMode(mode)``` - set dark mode to true or false

* new selectNode() method
* new deselectNode() method

## About the Name and Logo

Why is this called El Grapho? - *Why not?*
Expand Down
2 changes: 1 addition & 1 deletion gallery/big-clusters.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h1>El Grapho Big Clusters</h1>
edgeSize: 0.1,
debug: true,
darkMode: true,
globalAlpha: 0.5,
globalAlpha: 0.1,
nodeOutline: false
});

Expand Down
2 changes: 1 addition & 1 deletion gallery/network-hairball-graph.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
edgeSize: 1,
fillContainer: true,
darkMode: true,
globalAlpha: 0.9,
globalAlpha: 0.1,
nodeOutline: false
});
</script>
Expand Down

0 comments on commit af6917e

Please sign in to comment.