Skip to content

Commit 0f718a1

Browse files
committed
Update descriptions
1 parent 5ee3e0d commit 0f718a1

File tree

1 file changed

+71
-46
lines changed

1 file changed

+71
-46
lines changed

site/content/3.12/graphs/graph-visualizer.md

Lines changed: 71 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,6 @@ create new nodes (vertices) and edges (relations).
2121

2222
![A screenshot of the Graph Visualizer user interface showing some persons and movies as circles with arrows indicting who acted in or directed a movie](../../images/graph-visualizer.png)
2323

24-
{{< info >}}
25-
Graph creation is **not** performed within the Graph Visualizer. Graphs must be
26-
created in the **Management** section under **Graphs** of the second-level
27-
navigation in the [web interface](../components/web-interface/graphs.md). Once
28-
created, you can select a graph from the list for exploration and visualization.
29-
{{< /info >}}
30-
3124
You can use the Graph Visualizer to do the following:
3225

3326
- Filter and view specific nodes to focus on a subset of your graph.
@@ -38,6 +31,13 @@ You can use the Graph Visualizer to do the following:
3831
- Rearrange nodes automatically or manually for better visual clarity.
3932
- Use zoom and pan to explore large graphs more easily.
4033

34+
{{< info >}}
35+
Graph creation is **not** performed within the Graph Visualizer. Graphs must be
36+
created in the **Management** section under **Graphs** of the second-level
37+
navigation in the [web interface](../components/web-interface/graphs.md). Once
38+
created, you can select a graph from the list for exploration and visualization.
39+
{{< /info >}}
40+
4141
## View a graph
4242

4343
The core function of the Graph Visualizer is to provide an intuitive canvas for
@@ -51,16 +51,16 @@ supported by the Graph Visualizer.
5151

5252
### Select and load a graph
5353

54-
1. In the ArangoDB Platform web interface, select the database your named graph
54+
1. In the Data Platform web interface, select the database your named graph
5555
is stored in.
5656
2. Click **Graphs** in the main navigation.
5757
3. Select a graph from the list.
5858
4. The viewport of the Graph Visualizer opens for exploring the graph.
5959

6060
The main area of the viewport may initially be empty in the following cases:
6161

62-
- You opened a graph for the first time and nothing is selected for displaying yet
63-
- You used the **Clear Canvas** option
62+
- You open a graph for the first time and nothing is selected for displaying yet
63+
- You previously used the **Clear graph** option
6464
<!-- TODO: Doesn't it preserve the last state? Can it be lost?
6565
- Reopening the Graph Visualizer after a previous session
6666
-->
@@ -80,8 +80,10 @@ The Graph Visualizer interface is comprised of the following components:
8080
- **Search & add nodes to canvas** and **Queries**:
8181
A widget in the top left corner that opens dialogs for selecting nodes and
8282
edges to display (manually or using queries).
83-
- [**Customization**](#visual-customization):
84-
A sidebar on the right-hand side to adjust the styling.
83+
- [**Legend**](#visual-customization):
84+
A panel on the right-hand side that shows you what colors and icons are used
85+
for nodes and edges, as well as to adjust the styling, and to select all
86+
items of a type.
8587
- [**Layout and Navigation**](#layouts-and-navigation-tools):
8688
A minimap and multiple tools for the canvas in the bottom right corner.
8789

@@ -92,25 +94,28 @@ displayed.
9294

9395
1. Click **Search & add nodes to canvas**.
9496
2. Select a **Node type**. This is the name of the collection that stores the
95-
node you want to select.
96-
3. Enter a value into the **Search** field. This searches common attributes
97-
as indicated by the placeholder text and finds up to 10 nodes that contain
98-
this text in one of these attributes (case-insensitive).
97+
nodes you want to select.
98+
3. Enter a value into the **Search** field. This searches for document IDs
99+
<!-- TODO: Will this come back?
100+
This searches common attributes as indicated by the placeholder text and finds
101+
up to 10 nodes that contain this text in one of these attributes
102+
-->and finds up to 10 nodes that contain this text (case-insensitive).
99103
4. Select one or more nodes from the list on the left-hand side.
100-
5. Optional: You can check the attributes of the selected nodes on the
101-
right-hand side. Use the buttons at the bottom to switch between nodes.
102-
6. Click **Add _n_ vertices**.
104+
5. Optional: You can inspect the attributes of the selected nodes on the
105+
right-hand side. Use the buttons at the bottom
106+
({{< icon "caret-left" >}} {{< icon "caret-right" >}}) to switch between nodes.
107+
6. Click **Add _n_ nodes**.
103108
7. To see the neighbor nodes and the edges that connect them, right-click a node,
104109
click **Expand (_n_)** and then **All (_n_)**.
105110

106111
![A screenshot of the dialog for adding nodes with two persons selected](../../images/graph-visualizer-add-nodes.png)
107112

108113
### Add nodes and edges using a query
109114

110-
You can run an AQL query to add a nodes, edges, or paths of the graph to the canvas.
115+
You can run an AQL query to add nodes, edges, or paths of the graph to the canvas.
111116

112117
1. Click **Queries** of the top-left widget.
113-
2. Click **New query**.
118+
2. On the **QUeries** tab, click **New query**.
114119
3. Enter an AQL query that returns nodes, edges, or paths
115120
(e.g. a graph traversal query), for example:
116121
```aql
@@ -130,17 +135,17 @@ You can run an AQL query to add a nodes, edges, or paths of the graph to the can
130135
You can save queries for future use:
131136

132137
1. Click **Queries** of the top-left widget.
133-
2. Click **New query**.
138+
2. On the **Queries** tab, click **New query**.
134139
3. Enter or edit the AQL query you want to save. You can optionally use
135-
bind variables to parameterize saved queries.
140+
bind variables (like `@var`, `@@coll`) to parameterize saved queries.
136141
4. Enter a name and optionally a description, then click **Save**.
137142
5. To run a saved query, click **Queries** of the top-left widget.
138143
6. Select a query from the list. The following actions are available for each query:
139-
- {{< icon "clone" >}} Copy the query string to the clipboard.
144+
- Copy ({{< icon "duplicate" >}}) the query string to the clipboard.
140145
- **Bind Variables** to set for the query.
141-
- {{< icon "edit" >}} Edit the query.
142-
- {{< icon "trash-alt" >}} Delete a no longer needed query.
143-
- {{< icon "caret-right" >}} Run the query.
146+
- Edit ({{< icon "edit_square" >}}) the query.
147+
- Delete ({{< icon "delete" >}}) a no longer needed query.
148+
- Run ({{< icon "run" >}}) the query.
144149
{{< /tip >}}
145150

146151
![A screenshot of the dialog with a query expanded and a bind variable filled in](../../images/graph-visualizer-queries.png)
@@ -159,7 +164,7 @@ The query has access to the current selection via special bind variables.
159164
3. Depending on the query, additional nodes or edges with their nodes are added
160165
to the canvas.
161166
4. To create a custom Canvas Action query, click **Queries** of the top-left widget.
162-
5. Click **Canvas Actions**, then **New action**.
167+
5. Go to the **Canvas actions** tab and click **New action**.
163168
6. Enter an AQL query that makes use of the special bind variable `@nodes`,
164169
`@edges`, or both and returns nodes, edges, or paths. Examples:
165170
```aql
@@ -203,15 +208,26 @@ You can inspect the document attributes of node or edge as follows:
203208

204209
These features allow you to clear, zoom, and pan the canvas, as well as rearrange
205210
the displayed graph data for a better spatial understanding of node clusters,
206-
hierarchies, and relationship flows.
211+
hierarchies, and relationship flows. You can also download an image of what is
212+
displayed.
207213

208214
- **Minimap**: A small overview to easier navigate the canvas.
215+
You can optionally hide it ({{< icon "caret-right" >}}).
216+
217+
- **Clear graph**: Remove all nodes and edges from the canvas ({{< icon "clear" >}}).
218+
This only affects what is displayed and does not delete the underlying documents.
219+
220+
- **Fit to Screen**: Resize and center the canvas so you can see everything
221+
({{< icon "fit" >}}).
209222

210-
- **Zoom Controls**: Zoom in/out or reset the zoom to 100%.
223+
- **Zoom Controls**: Zoom in ({{< icon "zoom_in" >}}), zoom out
224+
({{< icon "zoom_out" >}}), or reset the zoom to 100%.
211225

212-
- **Fit to Screen**: Resize and center the canvas so you can see everything.
226+
- **Download screenshot**: Save a PNG image of what is currently displayed on
227+
the canvas ({{< icon "download" >}}).
213228

214-
- **Re-run Layout**: Automatically rearrange the nodes using the selected algorithm.
229+
- **Re-run Layout**: Automatically rearrange the nodes using the selected
230+
algorithm ({{< icon "rerun" >}}).
215231

216232
- **Layout Algorithms**: Choose between different ways of arranging the nodes.
217233
Which algorithm to use depends on the situation and the graph topology.
@@ -228,31 +244,36 @@ You need to have write access for the database and the collections for this.
228244
You can add nodes to the graph's document collections directly from the
229245
canvas. This allows you to create additional entities to the graph.
230246

231-
1. In the **Graphs** section of the ArangoDB web interface, select your graph.
232-
2. Right-click on the canvas and choose **Create Node**.
247+
1. In the **Graphs** section of the Data Platform web interface, select your graph.
248+
2. Right-click the canvas, **Create node**, and choose a node collection to
249+
store the new node in.
233250
3. A dialog opens with the following options:
234-
- Select the target collection (**Node Type**).
251+
- Select the vertex collection (**Node Type**).
235252
- Optionally specify a unique identifier (**Node ID**).
253+
- Optionally provide a JSON body to use as the document content.
236254
4. Click **Create** to add the node to the canvas and database.
237255

238256
### Create New Edges
239257

240258
You can add edges to the graph's edge collections directly from the canvas.
241259
This allows you to create additional connections between nodes.
242260

243-
1. In the **Graphs** section of the ArangoDB web interface, select your graph.
244-
2. Right-click on the canvas and choose **Create Edge**.
245-
3. In the dialog:
246-
- Select the target collection (**Edge Type**, which corresponds to an edge collection).
247-
- Set the `_from` and `_to` fields by selecting the source and target nodes.
261+
1. In the **Graphs** section of the Data Platform web interface, select your graph.
262+
2. Right-click the canvas, **Create edge**, and choose an edge collection to
263+
store the new edge in.
264+
3. A dialog opens with the following options:
265+
- Select the edge collection (**Edge Type**).
266+
- Set the **From** and **To** fields by selecting the source and target nodes.
248267
- Optionally specify a unique identifier (**Edge ID**).
268+
- Optionally provide a JSON body to use as the document content.
249269
4. Click **Create** to add the edge to the canvas and database.
250270

251-
{{< info >}}
252-
If you select two nodes before right-clicking to open the edge creation
253-
dialog, the `_from` and `_to` fields are automatically pre-filled.
254-
You may need to swap the IDs as the order is not based on your selection sequence.
255-
{{< /info >}}
271+
{{< tip >}}
272+
If you select two nodes before right-clicking the canvas and opening the edge
273+
creation dialog, the **From** and **To** fields are automatically pre-filled.
274+
You may need to swap the IDs ({{< icon "swap" >}}) as the order is not based on
275+
your selection sequence.
276+
{{< /tip >}}
256277

257278
![A screenshot of the dialog for creating an edge with the From and To fields filled in](../../images/graph-visualizer-create-edge.png)
258279

@@ -262,7 +283,11 @@ You can modify the document attributes of nodes and edges from the canvas as fol
262283

263284
1. Double-click a node or edge.
264285
2. In the properties dialog that opens, click **Edit**.
265-
3. Change the properties and click **Save**. <!-- TODO: Can't change system attributes, even though _from and _to are generally mutable -->
286+
3. You can switch between a **Form** and **JSON** editing mode.
287+
4. Change or delete ({{< icon "delete" >}}) existing properties.
288+
5. In the **Form** mode, you can add new properties by scrolling to the bottom
289+
and clicking **Add Property**.
290+
6. Click **Save** to store the changes, or **Cancel** to abort. <!-- TODO: Can't change system attributes, even though _from and _to are generally mutable -->
266291

267292
### Delete nodes
268293

0 commit comments

Comments
 (0)