@@ -23,13 +23,14 @@ create new nodes (vertices) and edges (relations).
2323
2424You can use the Graph Visualizer to do the following:
2525
26- - Filter and view specific nodes to focus on a subset of your graph.
26+ - Select and view specific nodes including with custom queries to focus on a
27+ subset of your graph.
2728- Dynamically expand nodes to show more of their neighborhood to see how
2829 entities are connected.
2930- Inspect the properties of nodes and edges.
3031- Modify existing or create new nodes and edges.
31- - Rearrange nodes automatically or manually for better visual clarity.
32- - Use zoom and pan to explore large graphs more easily .
32+ - Rearrange nodes automatically or manually as well as assign colors and icons
33+ for better visual clarity .
3334
3435{{< info >}}
3536Graph creation is ** not** performed within the Graph Visualizer. Graphs must be
@@ -80,7 +81,7 @@ The Graph Visualizer interface is comprised of the following components:
8081- ** Search & add nodes to canvas** and ** Queries** :
8182 A widget in the top left corner that opens dialogs for selecting nodes and
8283 edges to display (manually or using queries).
83- - [ ** Legend** ] ( #visual-customization ) :
84+ - [ ** Legend** ] ( #legend ) :
8485 A panel on the right-hand side that shows you what colors and icons are used
8586 for nodes and edges, as well as to adjust the styling, and to select all
8687 items of a type.
@@ -103,10 +104,10 @@ up to 10 nodes that contain this text in one of these attributes
1031044 . Select one or more nodes from the list on the left-hand side.
1041055 . Optional: You can inspect the attributes of the selected nodes on the
105106 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** .
107+ ({{< icon "caret-left" >}}, {{< icon "caret-right" >}}) to switch between nodes.
108+ 6 . Click ** Add # nodes** .
1081097 . To see the neighbor nodes and the edges that connect them, right-click a node,
109- click ** Expand (_ n _ )** and then ** All (_ n _ )** .
110+ click ** Expand (# )** and then ** All (# )** .
110111
111112![ A screenshot of the dialog for adding nodes with two persons selected] ( ../../images/graph-visualizer-add-nodes.png )
112113
@@ -178,6 +179,25 @@ The query has access to the current selection via special bind variables.
178179
179180![ A screenshot of the context menu for a node showing the available Canvas Actions] ( ../../images/graph-visualizer-menu-canvas-action.png )
180181
182+ ### Explore connections
183+
184+ You can explore the connections between entities of your graph in the following
185+ ways:
186+
187+ - ** Expand a node** : Right-click a node, then click ** Expand (#)** and ** All (#)** .
188+ This adds the direct neighbor nodes as well as the connecting edges to the canvas.
189+
190+ - ** Shortest Path** : Select exactly two nodes, right-click one of them, and click
191+ ** Shortest Path** . If there is a path between both nodes, the nodes and edges
192+ of one shortest path between them are added to the canvas.
193+
194+ - [ ** Queries** ] ( #add-nodes-and-edges-using-a-query ) and
195+ [ ** Canvas Actions** ] ( #add-nodes-and-edges-using-a-query-based-on-a-selection ) :
196+ You can run AQL graph queries (also based on the selection) to add connected
197+ nodes to the canvas. For example, you can use traversals to expand multiple
198+ levels of a node at once, or use path searches like ` ALL_SHORTEST_PATHS ` .
199+ This can be selective if you use ` FILTER ` operations.
200+
181201### Remove nodes from the canvas
182202
183203You can dismiss nodes to show less nodes and edges on the canvas to focus on the
@@ -190,7 +210,7 @@ dismissed nodes and their edges back to the canvas later on.
190210 - Right-click a single node to select only this node.
191211 - Hold the {{< kbd "Shift" >}} or {{< kbd "Ctrl" >}} key and click multiple nodes or drag the
192212 mouse to perform a box selection, then right-click one of the selected nodes.
193- 2 . In the context menu, click ** Dismiss _ n _ nodes** to hide the selected nodes,
213+ 2 . In the context menu, click ** Dismiss # nodes** to hide the selected nodes,
194214 or click ** Dismiss other nodes** to only keep the selection.
1952153 . The canvas updates to only display the remaining nodes, with no dangling edges.
196216
@@ -305,23 +325,45 @@ You can delete individual nodes which deletes the corresponding document.
3053252 . Click ** Delete Edge** .
3063263 . Confirm the deletion by clicking ** Delete** .
307327
308- ## Visual customization
328+ ## Legend
329+
330+ ### Visual customization
309331
310- You can adjust how the graph data is displayed, like the color, opacity, and
311- labels. All styling changes are visual-only and do not affect the underlying data.
332+ You can adjust how the graph data is displayed, like the colors and labels.
333+ All styling changes are visual-only and do not affect the underlying data.
312334
313- 1 . Optional: Reset to default styling if desired.
314- 2 . Click the _ palette_ icon in the top right to open the ** Customization** panel
335+ 1 . Click the ** Legend** button in the top right to open the ** Legend** panel
336+ if it's closed.
337+ 2 . Select the ** Nodes (#)** tab and click one of the node collections.
338+ You can filter by name if there are many.
339+ 4 . You have the following theming options for nodes:
340+ - ** Color**
341+ - ** Icon**
342+ - ** Display** : What attribute to use for the label and what information
343+ to show in the tooltip when hovering a nodes.
344+ 5 . Select the ** Edges (#)** tab and click one of the edge collections.
345+ You can filter by name if there are many.
346+ 6 . You have the following theming options for edges:
347+ - ** Line Styling** : Color, thickness, and arrow styling.
348+ - ** Display** : What attribute to use for the label.
349+ 7 . To save the changes, open the drop-down menu next to ** Legend** , click
350+ ** Add new theme** , enter a ** Name** , leave ** Start with** set to
351+ ** Current theme** , and then ** Save** . After additional customizations, you
352+ can save the changes to the existing theme you created ({{< icon "save" >}}).
353+ 8 . You can revert unsaved customizations of a specific collection via the
354+ collection list or customization panel ({{< icon "reset" >}}), or revert all
355+ unsaved changes via the theme drop-down menu ({{< icon "reset-all" >}}).
356+
357+ ### Select all nodes or edges of a type
358+
359+ 1 . Click the ** Legend** button in the top right to open the ** Legend** panel
315360 if it's closed.
316- 3 . Adjust the styling for nodes or edges:
317- - Select a ** Label Attribute** to display a custom top-level field
318- (e.g. ` name ` or ` type ` ) instead of ` _id ` .
319- - Assign a specific ** Color** to highlight and distinguish elements.
320- - Adjust how transparent elements are with the ** Opacity** .
321- - Set the ** Line Thickness** (edges only).
322- - Choose different ** Arrowhead Styles** (edges only).
323- 4 . You can also do the following:
324- - Clear the styling modifications.
325- - See the number of nodes respectively edges on the canvas (by collection).
361+ 2 . Select the ** Nodes (#)** or ** Edges (#)** tab.
362+ 3 . You can see the number of nodes and edges (per collection) that are on the canvas.
363+ 4 . You can sort the collection list by number instead of name by clicking the icon
364+ in the filter input field ({{< icon "swap" >}}) and selecting ** Count** .
365+ 5 . Click the icon ({{< icon "select-all" >}}) next to the number to select all
366+ nodes or edges that belong to the respective collection. This clears any
367+ previous selection.
326368
327369![ A screenshot of the Customization panel with a popover dialog for edge styling open] ( ../../images/graph-visualizer-customization.png )
0 commit comments