Skip to content

Commit adc4cf6

Browse files
committed
Update README
1 parent 724914d commit adc4cf6

File tree

1 file changed

+44
-67
lines changed

1 file changed

+44
-67
lines changed

README.md

Lines changed: 44 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -10,114 +10,91 @@ Complete list of the plug-ins examples included in the bootcamp:
1010

1111
### Layout
1212

13-
- **Grid Layout**
13+
* **Grid Layout**
14+
Place all nodes in a simple grid. Users can configure the size of the area and the speed.
1415

15-
Place all nodes in a simple grid. Users can configure the size of the area and the speed.
16-
17-
- **Sorted Grid Layout**
18-
19-
Same example as Grid Layout but users can sort nodes with an attribute column.
16+
* **Sorted Grid Layout**
17+
Same example as Grid Layout but users can sort nodes with an attribute column.
2018

2119
### Filter
2220

23-
- **Transform to Undirected**
24-
25-
Edge filter to remove mutual edges in a directed graph.
21+
* **Transform to Undirected**
22+
Edge filter to remove mutual edges in a directed graph.
2623

27-
- **Top nodes**
24+
* **Top nodes**
25+
Keep the top K nodes using an attribute column.
2826

29-
Keep the top K nodes using an attribute column.
30-
31-
- **Remove Edge Crossing**
32-
33-
Example of a complex filter implementation which removes edges until no crossing occurs.
27+
* **Remove Edge Crossing**
28+
Example of a complex filter implementation which removes edges until no crossing occurs.
3429

3530
### Tool
3631

37-
- **Find**
38-
39-
Tool with a autocomplete text field to find any node based on labels and zoom by it.
32+
* **Find**
33+
Tool with a autocomplete text field to find any node based on labels and zoom by it.
4034

41-
- **Add Nodes**
42-
43-
Listen to mouse clicks and adds nodes. Also adds edges if selecting other nodes.
35+
* **Add Nodes**
36+
Listen to mouse clicks and adds nodes. Also adds edges if selecting other nodes.
4437

4538
### Export
4639

47-
- **JPG Export**
48-
49-
Vectorial export to the JPG image format. Contains a settings panel to set the width and height.
50-
51-
- **SQLite Database Export**
40+
* **JPG Export**
41+
Vectorial export to the JPG image format. Contains a settings panel to set the width and height.
5242

53-
Current graph export to a SQLite Database file. A new sub-menu is added in the Export menu and an example of a custom exporter is shown.
43+
* **SQLite Database Export**
44+
Current graph export to a SQLite Database file. A new sub-menu is added in the Export menu and an example of a custom exporter is shown.
5445

5546
### Preview
5647

57-
- **Highlight Mutual Edges**
58-
59-
Colors differently mutual edges. Overwrites and extends the default edge renderer.
60-
61-
- **Glow Renderer**
62-
63-
Adds a new renderer for node items which draws a glow effect around nodes.
48+
* **Highlight Mutual Edges**
49+
Colors differently mutual edges. Overwrites and extends the default edge renderer.
6450

65-
- **Node Z-ordering**
51+
* **Glow Renderer**
52+
Adds a new renderer for node items which draws a glow effect around nodes.
6653

67-
Extends the default node builder by reordering the node items by size or any number columns. Also shows how to create complex Preview UI.
54+
* **Node Z-ordering**
55+
Extends the default node builder by reordering the node items by size or any number columns. Also shows how to create complex Preview UI.
6856

6957
### Import
7058

71-
- **Matrix Market Importer**
72-
73-
File importer for the Matrix Market format.
59+
* **Matrix Market Importer**
60+
File importer for the Matrix Market format.
7461

7562
### Statistic
7663

77-
- **Count Self-Loop**
78-
79-
Example of a statistics result at the global level. Simply counts the number of self-loop edges in the graph.
80-
81-
- **Average Euclidean Distance**
64+
* **Count Self-Loop**
65+
Example of a statistics result at the global level. Simply counts the number of self-loop edges in the graph.
8266

83-
Example of a per-node calculation. For a given node it calculates the average distance to others.
67+
* **Average Euclidean Distance**
68+
Example of a per-node calculation. For a given node it calculates the average distance to others.
8469

8570
### Plugins sub-menu
8671

87-
- **Test action**
88-
89-
Simple action which display a message and a dialog.
90-
91-
- **Remove self loops**
92-
93-
Action which accesses the graph and remove self-loops, if any.
72+
* **Test action**
73+
Simple action which display a message and a dialog.
9474

95-
- **Using Progress and Cancel**
75+
* **Remove self loops**
76+
Action which accesses the graph and remove self-loops, if any.
9677

97-
Action which creates a long task and execute it with progress and cancel support.
78+
* **Using Progress and Cancel**
79+
Action which creates a long task and execute it with progress and cancel support.
9880

9981
### Execute at startup
10082

101-
- **When UI is ready**
83+
* **When UI is ready**
84+
Do something when the UI finished loading.
10285

103-
Do something when the UI finished loading.
104-
105-
- **Workspace select events**
106-
107-
Do something when a workspace is selected.
86+
* **Workspace select events**
87+
Do something when a workspace is selected.
10888

10989
### Processor
11090

111-
- **Initial Position**
112-
113-
Set up the nodes' initial position always the same. It calculates a hash with all nodes so the X/Y position is randomized always in the same way.
114-
91+
* **Initial Position**
92+
Set up the nodes' initial position always the same. It calculates a hash with all nodes so the X/Y position is randomized always in the same way.
11593

11694
### New Panel
11795

118-
- **New panel**
119-
120-
Example of a new panel plugin set up at the ranking position.
96+
* **New panel**
97+
Example of a new panel plugin set up at the ranking position.
12198

12299

123100
## Installation

0 commit comments

Comments
 (0)