Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
foesa-yang committed Sep 1, 2021
1 parent 83a9890 commit c4c96e6
Show file tree
Hide file tree
Showing 28 changed files with 208 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Explorer has these features:

- Flexible: Explorer supports querying data through VID, Tag, Subgraph.

- Multiple operations: Explorer supports operations such as expanding operations on multiple points, querying the common neighbors of multiple points, and querying the path between the start vertex and the end vertex.
- Multiple operations: Explorer supports operations such as expanding operations on multiple vertexes, querying the common neighbors of multiple vertexes, and querying the path between the start vertex and the end vertex.

- Various display: Explorer supports modifying the color and icon of the vertex in the canvas to highlight key nodes. You can also freely choose the data display mode in `dagre`, `force`, and `circular`.

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before connecting to the Nebula Graph database, you need to confirm the followin

!!! note

If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/{{nebula.release}}/).
If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/).

## Procedure

Expand All @@ -36,7 +36,7 @@ To connect Explorer to Nebula Graph, follow these steps:

- If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.

![The Config Server page shows the fields to be configured for connection](../figs/st-ug-050.png "Config Server")
![The Config Server page shows the fields to be configured for connection](../figs/ex-ug-050.png "Config Server")

2. After the configuration, click the **Connect** button.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

When Explorer is still connected to a Nebula Graph database, in the toolbar, select Settings ![icon](../figs/nav-setup.png) > clear connect, as shown in the below:

![clean](../figs/st-ug-004.png)
![clean](../figs/ex-ug-004.png)

After that, if the **configuration database** page is displayed on the browser, it means that Explorer has successfully disconnected from the Nebula Graph.
File renamed without changes
File renamed without changes
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-006.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-009.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-011.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-012.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-013.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-014.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-015.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-016.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-017.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-018.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-023-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-024-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-025.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-026.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-explorer/figs/ex-ug-027.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
30 changes: 30 additions & 0 deletions docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# canvas operation

This topic describes operation in canvas.

## Display vertexes and edges

Move the mouse to the vertex or edge to view in detail. The following shows the detailed information of the vertex with `VID 107`:
![show](../figs/ex-ug-024-1.png)

## Batch selection

Explorer supports batch selection and views the data of multiple vertexes and edges. The detailed data can be opened and viewed in the vertexes and edges overview at the lower-left corner of the canvas. It also supports exporting CSV files of selected vertexes or edges.
![review](../figs/ex-ug-027.png)

### Frame selection

After clicking the ![frameselect](../figs/nav-frameSelect.png) icon, hold down the left button to drag and select multiple vertexes and edges. Examples are as follows:
![slect](../figs/ex-ug-023-1.png)

### Click to select multiple vertexes and edges

Click the ![singleselect](../figs/nav-singleSelect.png) icon or hold down Shift, click and select multiple vertexes and edges with the mouse, and click the blank space to cancel the selection. Examples are as follows:
![select](../figs/ex-ug-025.png)

## Quick operation

You can select one or more vertexes and edges, and right-click in the blank area to expand the vertexes, search the path between two vertexes, and show or hide their property on the canvas. The number of vertexes and edges you choose will affect the operations that can be performed. For more information, see [Graph Exploration Expansion](../operation-guide/ex-ug-graph-exploration.md).
![quick](../figs/ex-ug-026.png)

Click **Fit Selection** to move the selected data to the center of the canvas for users to view.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Graph exploration and expansion

Graph exploration and expansion is divided into the following four parts:

- Expand
- Common neighbor
- Search path
- Inspect property

## Expand

In the sidebar, click the ![expand](../figs/rightclickmenu-expand.png) icon to open the **Expand** window. You can double-click a vertex to expand directly. You can also select multiple vertexes in the canvas, modify the edge type in the operation bar, select the inflow and outflow of the edge, modify the color of the vertex, specify the number of expansion steps and custom filter conditions.

!!! Note

After the configuration in the panel is modified, the current configuration will be saved, and the current configuration will be expanded when double-clicking or right-clicking to quickly expand.

![expand](../figs/ex-ug-013.png)

## Common neighbor

In the sidebar, click the ![commonneighbor](../figs/rightclickmenu-commonNeighbor.png) icon to open the **Common Neighbor** window. You can select two or more vertexes on the canvas and query their common neighbors. When the selected vertexes have no common neighbor, the default returns **There is no data**.

![common_neighbor](../figs/ex-ug-014.png)

## Search path

In the sidebar, click the [findpath](../figs/rightclickmenu-findPath.png) icon to open the **Search path** window. You can select two vertexes in the canvas. By default, the first vertex selected is the starting point, and the second vertex is the ending point. You can customize the type and direction of the edge, specify the number of expansion steps, and choose to query the following three paths: `All path`, `Shortest path` and `Noloop path`.

![find_path](../figs/ex-ug-015.png)

## Inspect property

In the sidebar, click the ![propertyview](../figs/nav-propertyView.png) icon to open the **Inspect property** window. You can choose to show or hide the property of vertexes or edges in the canvas. After clicking confirm, the property will be displayed on the canvas only when the zoom ratio is greater than 100%, and automatically hidden when the zoom ratio is less than 100%.

![show_property](../figs/ex-ug-016.png)
89 changes: 89 additions & 0 deletions docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Page Overview

This topic describes Explorer main page.

## Overview

![Explorer](../figs/ex-ug-006.png)
The main page of Explorer is divided into five parts:

- Tab bar
- Sidebar
- Canvas
- Minimap
- Relationship list

## Tab bar

- Export: Export a CSV or SVG file of the current view.

## Sidebar

The sidebar consists of five parts. You can click the buttons to explore the graph, modify the content of the vertexes on the canvas, etc.

- Start query: Before exploring, the user needs to query the vertexes and display them in the canvas.

- Canvas operation: Including frame selection of vertexes in the canvas, dragging the canvas, and selecting multiple vertexes and edges.

- Graph exploration and expansion: Including functions such as vertexes expansion, finding common neighbors of multiple vertexes, finding the path of two vertexes, and inspecting the property.

- Hide and undo: Hide the data displayed in the canvas and undo the previous operation.

- Settings and help: Switch graph space, find help, modify settings, etc.

### Start query

- Start: Click the ![query](../figs/nav-query.png) icon to query the data and display it on the page through VID, Tag and sub-graph.

### Canvas operation

- Frame selection mode: Click the ![frameSelect](../figs/nav-frameSelect.png) icon to support frame selection of vertexes and edges in the canvas.
- Click to select multiple vertexes and edges: Click the ![singleSelect](../figs/nav-singleSelect.png) icon, you can easily click the vertexes and edges in the canvas, and click the blank space to cancel the selection.
- Move the canvas: Click the ![moveCanvas](../figs/nav-moveCanvas.png) icon to drag the position of the canvas.
For more information, see [Canvas Operation](../operation-guide/ex-ug-canvas.md).

### Graph exploration and expansion

- Expand: Click the ![expand](../figs/rightclickmenu-expand.png) icon, select the vertexes on the page and perform custom expansion, including direction, steps, filter conditions, etc.
- Common neighbor: Click the ![commonNeighbor](../figs/rightclickmenu-commonNeighbor.png) icon, select at least two vertexes on the page and view their common neighbors.
- Search path: Click the ![findPath](../figs/rightclickmenu-findPath.png) icon to query the path of `all paths`, `Shortest path` or `Noloop path` between the start vertex and the end vertex.
- Inspect property: Click the ![propertyView](../figs/nav-propertyView.png) icon to choose whether to display the property values of vertexes or edges in the canvas.
For more information, see [Graph exploration and expansion](../operation-guide/ex-ug-graph-exploration.md).

### Hide and undo

- Dismiss: Click the ![miss](../figs/nav-miss.png) icon to hide the selected vertexes and edges in the canvas.
- Dismiss others: Click the ![missreverse](../figs/nav-missReverse.png) icon to hide all unselected vertexes and edges in the canvas.
- Undo: Click the ![Revoke](../figs/nav-Revoke.png) icon to undo the operation in the previous step.

### Settings and help

- Switch graph space: Click the ![graphSpace](../figs/nav-graphSpace.png) icon to switch the current graph space.
- Help: Click the ![help](../figs/nav-help.png) icon to see more information.
- Setting: Click the ![setup](../figs/nav-setup.png) icon to view usernames and shortcut keys, modify language settings, clear Explorer connect, etc.

## Canvas

The canvas is mainly divided into:

- canvas: Display the data queried by VID, Tag or subgraph.

- Vertexes and Edges overview: It is hidden by default and only displayed when the vertex and edge are selected on the current canvas. Click on the icon in the following, and the user can open the menu to view the detailed data of the selected vertexes and edges in the current canvas.

![review](../figs/ex-ug-027.png)

For more information, see [canvas operation](../operation-guide/ex-ug-canvas.md).

## Minimap

You can use the button on the minimap to switch the graph mode, display the vertexes in the canvas in full screen, collapse the minimap, zoom in or zoom out the canvass, etc. At the same time, the percentage of the graph in the canvas to the total graph is displayed in the lower-left corner of the minimap.

- Switch mode: You can switch the display mode of the graph in the canvas.

| icon | ![force](../figs/Thumbnail-graphView.png) | ![dagre](../figs/Thumbnail-treeView.png) | ![circular](../figs/Thumbnail-sphereView.png) |
| ---- | ---- |----| ----|
| mode | force | dagre | circular |

## Relationship list

Click the ![unfold](../figs/sidebar-unfold.png) icon on the right, you can open the menu, view the number of tags and edges in the canvas, search for tags and edges, and also support modifying the color and icon of the vertex.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Start query

In Explorer, you can choose the following query methods to display data:

- VID
- Tag
- Subgraph

## Query by VID

You can query data by entering the VIDs or other data for VID generation, and a row only supports one data. It also supports random import of data and file import of data. After confirming the addition, the data will be displayed in the canvas. An example is given below:

![VID](../figs/ex-ug-009.png)


## Query by Tag

The required values are Tag and Index. You can limit the number of output results and filter the results. The following query 10 players whose age is greater than 30 years old and not equal to 40 years old, examples are as follows:

![Tag](../figs/ex-ug-011.png)

## Query by Subgraph

The required value is VID. You can view the subgraph of one or more vertexes, and you can specify the number of steps, edge types, and the direction of inflow and outflow of the subgraph. The following is an example of an incoming edge with a VID value of 101, the number of steps of 4, and edge types of `server` and `like`:

![Query](../figs/ex-ug-012.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Relationship list

You can select vertexes and edges in the relationship list. Select 12 points where Tag is `player`, and select 9 edges where Edge is `serve`. An example is as follows:

![select](../figs/ex-ug-017.png)

At the same time, you can modify the color and icon of the Tag to make the key nodes more prominent.

By default, VID with identical tags have the same color, and it is also allowed to manually modify the color of a vertex or a group of vertexes with identical tags. For example, if the vertex label is `player`, modify the color of one of the vertexes, and you can click to view it in the relationship list. The example is as follows:

![icon](../figs/ex-ug-018.png)
12 changes: 12 additions & 0 deletions docs-2.0/nebula-explorer/operation-guide/ex-ug-shortcuts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Shortcuts

This document lists the shortcuts supported in Explorer.

| Operation | Description |
| :-- | :--|
| Shift + 'Enter' | Expand |
| Shift + '-' | Zoom out |
| Shift + '+' | Zoom in |
| Shift + 'l' | Display |
| Shift + 'z' | Undo |
| Selected + Shift + 'del' | Delete |

0 comments on commit c4c96e6

Please sign in to comment.