diff --git a/site/content/3.13/graphs/Graph_visualizer/_index.md b/site/content/3.13/graphs/Graph_visualizer/_index.md new file mode 100644 index 0000000000..3021a790eb --- /dev/null +++ b/site/content/3.13/graphs/Graph_visualizer/_index.md @@ -0,0 +1,264 @@ +--- +title: Graph Visualizer +menuTitle: Graph Visualizer +weight: 85 +description: >- + Visualize and interact with your ArangoDB graphs in an intuitive and + interactive interface +--- + +The **Graph Visualizer** provides an interactive interface to explore graph +connections in your ArangoDB database. It allows users to navigate edges, inspect +vertices, and visually understand the data structure. + +{{< info >}} +Graph creation is **not** performed within the Graph Visualizer. Graphs must be +created in the **Graphs** section, accessible from the second-level navigation in +the web interface. Once created, graphs automatically appear in the Graph +Visualizer, ready for exploration and visualization. +{{< /info >}} + +Once your graph is created through the main interface, you can use the Graph +Visualizer to: + +- Traverse nodes and edges to see how entities are connected. +- Click on vertices or edges to inspect their properties. +- Filter specific collections to focus on a subset of your graph. +- Rearrange nodes manually for better visual clarity. +- Use zoom and pan to explore large graphs more easily. + + +## View and 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 Vertices(Nodes) + +You can add a vertex to one of the graph's document collections directly from the +canvas. This allows you to expand your graph structure: + +To add a new vertex to a graph: + +1. In the **Graphs** section of the ArangoDB web interface, select your graph. +2. Right-click on the canvas and choose **Create Node**. +3. In the dialog: + - 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. + +![Create Node](../../../images/Graph-visualizer-CreateNode_1.PNG) + +### Add New Edges + +To add a new edge 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. Note: the +order is not based on your selection sequence, but may depend on internal ID +orting. +{{< /info >}} + +![Create Edge](../../../images/Graph-visualizer-CreateEdge_1.png) + +### Delete Nodes or Edges + +To delete a node or edge: + +1. Click on the node or edge to select it. +2. Right-click to open the context menu. +3. Choose **Delete** from the menu. + +{{< tip >}} +To select and move multiple nodes, hold down the `Ctrl` key (or +`Cmd` on macOS) and drag a selection box around them. However, context menu +actions like **Delete** only work for single selections. +{{< /tip >}} + +- **Select Node and Right-click** + +![Delete Node](../../../images/Graph-visualizer-DeleteNode.PNG) +- **Select Edge and Right-click** +![Delete Edge](../../../images/Graph-visualizer-DeleteEdge.PNG) + +### View Node Properties + +To view properties: + +- Click on a node or edge to open its properties pop-up. + +- **Select a node to display its properties.** + +![Node Properties](../../../images/Graph-visualizer-Propertiesofnode.png) + +## Graph Visualization + +The core function of the Graph Visualizer is to provide an intuitive canvas for +exploring graph structures. + +### List All Graphs + +ArangoDB supports the following types of **named graphs**, which are available +for visualization: + +- General Graphs +- Smart Graphs +- Satellite Graphs +- Disjoint Smart Graphs + +{{< warning >}} +Anonymous (adhoc) graphs are not supported in the Graph Visualizer. +{{< /warning >}} + +### Select and Load a Graph + +After selecting a graph from the list, it may not be immediately visualized on +the canvas. In cases such as: + +- Using the **Clear Canvas** option +- Reopening the Graph Visualizer after a previous session +- Selecting a graph with no initial nodes displayed + +You may see a message prompting you to use the **Explore** button. +To view the graph: + +- Click **Explore** and search for a node by name or ID. +- Alternatively, use the **New Query** or **Saved Query** buttons to display part +of the graph. + +![Loaded Graph](../../../images/Graph_visuaizer_Load_Graph.png) + +{{< tip >}} +Use the **Explore** button to run AQL queries and render results directly on the +graph. You can also save your queries for future use. +{{< /tip >}} + +## Search & Filter Data + +The top-left section of the Graph Visualizer includes powerful search and query +tools for interactive exploration. + +### Search + +To find specific vertices or edges: + +1. Click the **Explore** button in the top-left panel of the Graph Visualizer. +2. Use the search box to look up a node by name or ID. +3. Matching nodes will be highlighted or loaded onto the canvas. + +{{< tip >}} +You can also use the **New Query** or **Saved Query** buttons to load +specific subgraphs using AQL queries. +{{< /tip >}} + +![Search](../../../images/Graph_Visualizer_Search_Response.png) + +### Saved Queries + +To run a saved query: + +1. Click the **Explore** button at the top-left of the Graph Visualizer. +2. In the panel that opens, click the **Saved Queries** tab. +3. Each saved query has options to: + - **Run** it again + - **Copy** to modify + - **Delete** if no longer needed + +![Saved Queries](../../../images/Graph_Visualizer_savedquery.png) + +### New Queries + +To run a custom query: + +1. Click the **Explore** button at the top-left of the Graph Visualizer. +2. In the panel that opens, click the **New Query** tab. +3. Enter your AQL query in the editor. +4. Click **Run** to visualize the result on the graph canvas. + +![New Queries](../../../images/Graph_Visualizer_new_Query.png) + +- **Response of the NewQuery** + +![Response of the NewQuery](../../../images/Graph_Visualizer_NewQuery_response.png) + + +## Visual Customization + +Click the **Style** panel (bottom-right) to: + +- Change node/edge colors +- Adjust opacity +- Select a **Label** attribute to display a custom field (e.g., “name” or “type”) + on nodes instead of `_id` +- Reset to default styling after making changes + +**Reset Button:** Click **Reset** in the style panel to restore nodes and +edges to their original colors, opacity, and labels. +**Node Count:** The **“Nodes in Graph”** indicator at the top of the panel +shows how many vertices are currently loaded or visible. It updates automatically +when you run queries, apply filters, or add/delete elements. + +### Vertice Styling Options + +You can modify styling attributes of selected **nodes** for emphasis, +categorization, or clarity. + +- **Color**: Assign a specific color to highlight elements +- **Opacity**: Make elements more or less transparent +- **Label Attribute**: Choose a field (e.g., `name`, `title`) to show instead of + `_id` +- **Reset**: Clear all styling modifications + +![Styling Options](../../../images/Graph_Visualizer_Styling_Options.png) + +### Edge-Specific Options + +You can modify styling attributes of selected **Edges** for emphasis, +categorization, or clarity. +In addition to the shared styling settings, edges offer further customization: + +- **Line Thickness**: Set thickness to reflect edge weight or significance +- **Arrowhead Styles**: Choose different arrow types for **source** and **target** + directions +- **Label Attribute**: Select an edge field to display as a label on the edge + +> Note: All styling changes are visual-only and do not affect the underlying data. + +![Edge-Specific Options](../../../images/Graph_Visualizer_Edge-Specific_Options.PNG) + +## Layouts and Navigation Tools + +**Graph Layout Tools**: + +- **Mini-map**: Small overview to navigate the graph. + +![Mini-map](../../../images/Graph_Visualizer_minimap.PNG) + +- **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 better see clusters or flows. + +![Layout Algorithms](../../../images/Graph_Visualizer_Layout_Algorithms.PNG) + +These features allow better spatial understanding of node clusters, hierarchies, +and relationship flows. diff --git a/site/content/images/DynamicGraph_By_Saved_Query.PNG b/site/content/images/DynamicGraph_By_Saved_Query.PNG new file mode 100644 index 0000000000..7a3b83d72f Binary files /dev/null and b/site/content/images/DynamicGraph_By_Saved_Query.PNG differ diff --git a/site/content/images/Example-graph.png b/site/content/images/Example-graph.png new file mode 100644 index 0000000000..a24a9405f9 Binary files /dev/null and b/site/content/images/Example-graph.png differ diff --git a/site/content/images/Graph-visualizer-CreateEdge_1.png b/site/content/images/Graph-visualizer-CreateEdge_1.png new file mode 100644 index 0000000000..5a196cff72 Binary files /dev/null and b/site/content/images/Graph-visualizer-CreateEdge_1.png differ diff --git a/site/content/images/Graph-visualizer-CreateNode_1.PNG b/site/content/images/Graph-visualizer-CreateNode_1.PNG new file mode 100644 index 0000000000..2eaeb87a8a Binary files /dev/null and b/site/content/images/Graph-visualizer-CreateNode_1.PNG differ diff --git a/site/content/images/Graph-visualizer-DeleteEdge.PNG b/site/content/images/Graph-visualizer-DeleteEdge.PNG new file mode 100644 index 0000000000..8815650d6b Binary files /dev/null and b/site/content/images/Graph-visualizer-DeleteEdge.PNG differ diff --git a/site/content/images/Graph-visualizer-DeleteNode.PNG b/site/content/images/Graph-visualizer-DeleteNode.PNG new file mode 100644 index 0000000000..6bc5716e06 Binary files /dev/null and b/site/content/images/Graph-visualizer-DeleteNode.PNG differ diff --git a/site/content/images/Graph-visualizer-Propertiesofnode.png b/site/content/images/Graph-visualizer-Propertiesofnode.png new file mode 100644 index 0000000000..8c318aa990 Binary files /dev/null and b/site/content/images/Graph-visualizer-Propertiesofnode.png differ diff --git a/site/content/images/Graph_VisualizerList_All_Graphs.png b/site/content/images/Graph_VisualizerList_All_Graphs.png new file mode 100644 index 0000000000..bb97f81237 Binary files /dev/null and b/site/content/images/Graph_VisualizerList_All_Graphs.png differ diff --git a/site/content/images/Graph_Visualizer_Edge-Specific_Options.PNG b/site/content/images/Graph_Visualizer_Edge-Specific_Options.PNG new file mode 100644 index 0000000000..6932c49719 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Edge-Specific_Options.PNG differ diff --git a/site/content/images/Graph_Visualizer_Edge-Specific_Options.png b/site/content/images/Graph_Visualizer_Edge-Specific_Options.png new file mode 100644 index 0000000000..00a4885965 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Edge-Specific_Options.png differ diff --git a/site/content/images/Graph_Visualizer_Layout_Algorithms.PNG b/site/content/images/Graph_Visualizer_Layout_Algorithms.PNG new file mode 100644 index 0000000000..3015c5e165 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Layout_Algorithms.PNG differ diff --git a/site/content/images/Graph_Visualizer_NewQuery_response.png b/site/content/images/Graph_Visualizer_NewQuery_response.png new file mode 100644 index 0000000000..bbf89fe744 Binary files /dev/null and b/site/content/images/Graph_Visualizer_NewQuery_response.png differ diff --git a/site/content/images/Graph_Visualizer_Re-run Layout_Icon.PNG b/site/content/images/Graph_Visualizer_Re-run Layout_Icon.PNG new file mode 100644 index 0000000000..65865d7e06 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Re-run Layout_Icon.PNG differ diff --git a/site/content/images/Graph_Visualizer_Search_Response.png b/site/content/images/Graph_Visualizer_Search_Response.png new file mode 100644 index 0000000000..c3d4c425f3 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Search_Response.png differ diff --git a/site/content/images/Graph_Visualizer_Styling_Options.png b/site/content/images/Graph_Visualizer_Styling_Options.png new file mode 100644 index 0000000000..a52125c3f6 Binary files /dev/null and b/site/content/images/Graph_Visualizer_Styling_Options.png differ diff --git a/site/content/images/Graph_Visualizer_minimap.PNG b/site/content/images/Graph_Visualizer_minimap.PNG new file mode 100644 index 0000000000..ccaf667dce Binary files /dev/null and b/site/content/images/Graph_Visualizer_minimap.PNG differ diff --git a/site/content/images/Graph_Visualizer_new_Query.png b/site/content/images/Graph_Visualizer_new_Query.png new file mode 100644 index 0000000000..3775db81f3 Binary files /dev/null and b/site/content/images/Graph_Visualizer_new_Query.png differ diff --git a/site/content/images/Graph_Visualizer_savedquery.png b/site/content/images/Graph_Visualizer_savedquery.png new file mode 100644 index 0000000000..781847fe56 Binary files /dev/null and b/site/content/images/Graph_Visualizer_savedquery.png differ diff --git a/site/content/images/Graph_visuaizer_Load_Graph.png b/site/content/images/Graph_visuaizer_Load_Graph.png new file mode 100644 index 0000000000..153c8a26e4 Binary files /dev/null and b/site/content/images/Graph_visuaizer_Load_Graph.png differ diff --git a/site/content/images/new-query.png b/site/content/images/new-query.png new file mode 100644 index 0000000000..4928117c38 Binary files /dev/null and b/site/content/images/new-query.png differ diff --git a/site/content/images/new-query_saving.PNG b/site/content/images/new-query_saving.PNG new file mode 100644 index 0000000000..d65b32a783 Binary files /dev/null and b/site/content/images/new-query_saving.PNG differ diff --git a/site/content/images/savedquery.PNG b/site/content/images/savedquery.PNG new file mode 100644 index 0000000000..641b263b05 Binary files /dev/null and b/site/content/images/savedquery.PNG differ diff --git a/site/content/images/search.png b/site/content/images/search.png new file mode 100644 index 0000000000..b48013ab59 Binary files /dev/null and b/site/content/images/search.png differ