DOC-752 | Graph Visualizer UI

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

@@ -0,0 +1,204 @@
+---
+title: Graph Visualizer
+menuTitle: Graph Visualizer
+weight: 102
+description: >-
+  Explore your ArangoDB graphs with an intuitive and interactive interface
+---
+The **Graph Visualizer** is a browser-based tool integrated into the web interface
+of the ArangoDB Platform. It lets you explore the connections of your named graphs
+to visually understand the structure as well as to inspect and edit the attributes
+of individual nodes and edges. It also offers query capabilities and you can
+create new nodes (vertices) and relations (edges).
+
+{{< info >}}
+Graph creation is **not** performed within the Graph Visualizer. Graphs must be
+created in the **Management** section under **Graphs** of the second-level
+navigation in the web interface. Once created, you can select a graph
+from the list for for exploration and visualization.
+{{< /info >}}
+
+You can use the Graph Visualizer to do the following:
+
+- Filter and view specific nodes to focus on a subset of your graph.
+- Dynamically expand nodes to show more of their neighborhood to see how
+  entities are connected.
+- Inspect the properties of nodes and edges.
+- Modify existing or create new nodes and edges.
+- Rearrange nodes automatically or manually for better visual clarity.
+- Use zoom and pan to explore large graphs more easily.
+
+## View a graph
+
+The core function of the Graph Visualizer is to provide an intuitive canvas for
+exploring graph structures. You can visualize any type of **named graph**
+(General Graphs, SmartGraphs, EnterpriseGraphs, SatelliteGraphs).
+
+{{< warning >}}
+Anonymous graphs using adhoc sets of document and edge collections are not
+supported by the Graph Visualizer.
+{{< /warning >}}
+
+### Select and load a graph
+
+1. In the ArangoDB Platform web interface, select the database your named graph
+   is stored in.
+2. Click **Graphs** in the main navigation.
+3. Select a graph from the list.
+4. The viewport of the Graph Visualizer opens for exploring the graph.
+
+The main area of the viewport may initially be empty in the following cases:
+
+- You opened a graph for the first time and nothing is selected for displaying yet
+- You used the **Clear Canvas** option
+<!-- TODO: Doesn't it preserve the last state? Can it be lost?
+- Reopening the Graph Visualizer after a previous session
+-->
+
+### The viewport
+
+The Graph Visualizer interface is comprised of the following components:
+
+- **Canvas**: The main area of the viewport.
+- **Explore**:
+  A widget in the top left corner that opens a dialog for selecting nodes and
+  edges to display.
+- [**Customization**](#visual-customization):
+  A sidebar on the right-hand side to adjust the styling.
+- [**Layout and Navigation**](#layouts-and-navigation-tools):
+  A minimap and multiple tools for the canvas in the bottom right corner.
+
+### Add nodes to the canvas
+
+You can add individual nodes to the canvas in addition to what is already
+displayed.
+
+1. Click **Explore**.
+2. On the **Search** tab, select a **Vertex type**. This is the name of the
+     collection that stores the node you want to select.
+3. Enter a value into the **Search** field. <!-- TODO: Which attributes?! -->
+4. Select one or more nodes from the list on the left-hand side.
+5. Optional: You can check the attributes of the selected nodes on the
+   right-hand side. Use the buttons at the bottom to switch between nodes.
+6. Click **Add _n_ vertices**.
+7. To see the neighbor nodes and the edges that connect them, right-click a node,
+   click **Expand (_n_)** and then **All (_n_)**. <!-- TODO: What other options exist? -->
+
+### Display a subgraph using a query
+
+You can run an AQL query to view a subset of the graph.
+It replaces the current content of the canvas.
+
+1. Click **Explore**.
+2. On the **New query** tab, enter an AQL query that returns edges or paths
+   (e.g. a graph traversal query).
+3. The edges and their nodes appear on the canvas.
+
+{{< tip >}}
+You can save queries for future use: 
+
+1. Click **Explore**.
+2. On the **New query** tab, click **Save as**, enter a name and optionally a
+   description, then click **Save**.
+3. To run a saved query, click **Explore**.
+4. On the **Saved Queries** tab, you can see a list of saved queries, and the
+   following actions are available for each:
+  - **Run** the query.
+  - **Copy** the query string to the clipboard.
+  - **Delete** a no longer needed query.
+{{< /tip >}}
+
+### View node and edge properties
+
+You can inspect the document attributes of node or edge as follows:
+
+- Double-click a node or edge to open a dialog with the properties.
+- Right-click a node to open the context menu and click **View Node** to open
+  the dialog with the properties.
+
+### Layouts and navigation tools
+
+These features allow you to clear, zoom, and pan the canvas, as well as rearrange
+the displayed graph data for a better spatial understanding of node clusters,
+hierarchies, and relationship flows.
+
+- **Minimap**: Small overview to navigate the graph.
+
+- **Zoom Controls**: Zoom in/out or set specific zoom.
+
+- **Fit to Screen**: Resize and center the graph view.
+
+- **Re-run Layout**: Automatically rearranges nodes.
+
+- **Layout Algorithms**: Choose between layouts to arrange the nodes.
+
+## Edit graph data
+
+While the Graph Visualizer is primarily designed for exploring graph data, you
+can also create and modify nodes and edges directly from the canvas.
+
+### Add new nodes
+
+You can add nodes to the the graph's document collections directly from the
+canvas. This allows you to expand your graph structure.
+
+1. In the **Graphs** section of the ArangoDB web interface, select your graph.
+2. Right-click on the canvas and choose **Create Node**.
+3. A dialog opens with the following options:
+   - Select the target collection (**Node Type**).
+   - Optionally specify a unique identifier (**Node ID**).
+4. Click **Create** to add the node to the canvas and database.
+
+### Add New Edges
+
+You can add edges to the graph's edge collections directly from the canvas.
+This allows you to create additional connections between nodes.
+
+1. In the **Graphs** section of the ArangoDB web interface, select your graph.
+2. Right-click on the canvas and choose **Create Edge**.
+3. In the dialog:
+   - Select the target collection (**Edge Type**, which corresponds to an edge collection).
+   - Set the `_from` and `_to` fields by selecting the source and target nodes.
+   - Optionally specify a unique identifier (**Edge ID**).
+4. Click **Create** to add the edge to the canvas and database.
+
+{{< info >}}
+If you select two nodes before right-clicking to open the edge creation
+dialog, the `_from` and `_to` fields are automatically pre-filled.
+The order is not based on your selection sequence but the document key.
+{{< /info >}}
+
+### Delete nodes
+
+You can delete individual nodes which deletes the corresponding document.
+
+1. Right-click a node to open the context menu.
+2. Click **Delete Node**.
+3. Any edges connected to this node are deleted by default to ensure graph
+   consistency. To keep the edges, untick **Delete connected edge(s)**.
+4. Confirm the deletion by clicking **Delete**.
+
+### Delete edges
+
+1. Right-click an edge to open the context menu.
+2. Click **Delete Edge**.
+3. Confirm the deletion by clicking **Delete**.
+
+## Visual customization
+
+You can adjust how the graph data is displayed, like the color, opacity, and
+labels. All styling changes are visual-only and do not affect the underlying data.
+
+1. Optional: Reset to default styling if desired.
+2. Click the _palette_ icon in the top right to open the **Customization** panel
+   if it's closed.
+3. Adjust the styling for nodes or edges:
+   - Select a **Label Attribute** to display a custom top-level field
+     (e.g. `name` or `type`) instead of `_id`.
+   - Assign a specific **Color** to highlight and distinguish elements.
+   - Adjust how transparent elements are with the **Opacity**.
+   - Set the **Line Thickness** (edges only).
+   - Choose different **Arrowhead Styles** (edges only).
+4. You can also do the following:
+   - Clear the styling modifications.
+   - See the number of nodes respectively edges on the canvas (by collection).