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
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,25 @@ Vertices and edges can be styled through a *css stylesheet* or programmatically
11
11
12
12
### Prerequisites
13
13
14
-
You need a working JDK with JavaFX libraries to compile/use the library. The code was tested with JDK 8 and OpenJDK 11.
14
+
You need a working JDK with JavaFX libraries to use/compile the library. The code was tested with JDK 8, OpenJDK 11 and LibericaJDK 19.
15
15
16
16
### Using the library
17
17
18
-
Check the `releases` folder for compiled library and source code. The **jar** library is the only requirement, but if you need to attach the *javadoc* and *source code* in your IDE, additionally use the **zip** file.
18
+
> The visualization library can be used together with any ADT that adheres to the `Graph<V,E>` or `Digraph<V,E>` interfaces. Sample implementations are included, but you can devise your own.
19
19
20
-
The visualization library can be used together with any ADT that adheres to the `Graph<V,E>` or `Digraph<V,E>` interfaces. Sample implementations are included.
20
+
You can find in the [releases section](https://github.com/brunomnsilva/JavaFXSmartGraph/releases) the binaries, source code and documentation.
21
+
22
+
The library is available through Maven Central. The coordinates are:
23
+
24
+
```xml
25
+
<dependency>
26
+
<groupId>com.brunomnsilva</groupId>
27
+
<artifactId>smartgraph</artifactId>
28
+
<version>1.0.0</version>
29
+
</dependency>
30
+
```
31
+
32
+
You should be able to use the artifact with Maven and Gradle projects with little effort.
21
33
22
34
### Accelerated graphics
23
35
@@ -29,9 +41,11 @@ In windows the JVM machine should automatically take care of that, while in Linu
29
41
30
42
### What's **new**?
31
43
44
+
- (1.0.0) Package now available through [Maven Central](https://central.sonatype.com/?smo=true). The library seems stable, after dozens of college projects of my students have used it. Hence, the version was bumped to 1.0.0.
45
+
32
46
- (0.9.4) You can now annotate a method with `@SmartLabelSource` within a model class to provide the displayed label for a vertex/edge; see the example at `com.brunomnsilva.smartgraph.example`. If no annotation is present, then the `toString()` method is used to obtain the label's text.
33
47
34
-
- (0.9.4) You can mannualy alter a vertex position on the panel at anytime, through `SmartGraphPanel.setVertexPosition(Vertex<V> v)`; see the example at `com.brunomnsilva.smartgraph.example`.
48
+
- (0.9.4) You can manually alter a vertex position on the panel at anytime, through `SmartGraphPanel.setVertexPosition(Vertex<V> v)`; see the example at `com.brunomnsilva.smartgraph.example`.
35
49
36
50
- (0.9.4) You can override specific default properties by using a *String* parameter to the `SmartGraphProperties` constructor; see the example at `com.brunomnsilva.smartgraph.example`. This is useful if you want to display visually different graphs within the same application.
These actions will be performed whenever you *doubleclick* a vertex and/or an edge.
108
+
These actions will be performed whenever you *double-click* a vertex and/or an edge.
95
109
96
110
### Updating the view
97
111
@@ -101,7 +115,7 @@ When you make changes to the graph, you can update the visualization by calling
101
115
graphView.update();
102
116
```
103
117
104
-
this will add/remove the corresponding vertices and edges from the visualization. If a new vertex is connected to an existing one, it will be initially placed in the vicinity of the later. Otherwise, if it is an *isolated* vertex it will be placed in the center of the plot.
118
+
this will add/remove the corresponding vertices and edges from the visualization. If a new vertex is connected to an existing one, it will be initially placed in the vicinity of the latter. Otherwise, if it is an *isolated* vertex it will be placed in the center of the plot.
Please note that we use the property values `edge.arrow = true` and `vertex.label = true`.
279
293
280
-
Given its a small graph, we increased the `layout.repulsive-force = 25000`. You should use higher values for smaller graphs; inversely, use smaller values for larger graphs.
294
+
Given it's a small graph, we increased the `layout.repulsive-force = 25000`. You should use higher values for smaller graphs; inversely, use smaller values for larger graphs.
0 commit comments