You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,23 +71,29 @@ let graph = new ElGrapho({
71
71
72
72
*```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.
73
73
74
-
*```width``` - number that defines the width of the El Grapho viewport in pixels. The default is 500;
74
+
*```width``` - number that defines the width of the El Grapho viewport in pixels. The default is ```500```.
75
75
76
-
*```height``` - number defines the height of the El Grapho viewport in pixels. The default is 500;
76
+
*```height``` - number defines the height of the El Grapho viewport in pixels. The default is ```500```.
77
77
78
-
*```nodeSize``` - number between 0 and 1 which defines the node size. The default is 1.
78
+
*```nodeSize``` - number between 0 and 1 which defines the node size. The default is ```1```.
79
79
80
-
*```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.
80
+
*```nodeOutline``` - boolean that enables or disables node outlines. The default is ```true```.
81
81
82
-
*```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.
82
+
*```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```.
83
83
84
-
*```tooltips``` - boolean that enables or disables tooltips. The default is true.
84
+
*```darkMode``` - boolean that enables or disables dark mode. The default is ```false```.
85
85
86
-
*```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```.
86
+
*```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```.
87
87
88
-
*```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.
88
+
*```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```.
89
89
90
-
*```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.
90
+
*```tooltips``` - boolean that enables or disables tooltips. The default is ```true```.
91
+
92
+
*```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```.
93
+
94
+
*```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```.
95
+
96
+
*```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```.
0 commit comments