Skip to content
This repository has been archived by the owner on Oct 7, 2021. It is now read-only.

Commit

Permalink
Merge pull request #45 from cshinn/graph-controls
Browse files Browse the repository at this point in the history
Add designs for graph controls
  • Loading branch information
abonas authored Jan 3, 2019
2 parents 289cd05 + a7fadb9 commit 0976ab8
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions service-graph/design.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,36 @@
# Service Graph

## Graph Zoom Tool
## Graph Controls

![zoom tool on the service graph](img/graph-controls.png)

### Display Settings
The display settings control which graph elements are shown and hidden on the graph
![display settings dropdowns](img/display-settings.png)
- **Application Groups:** Toggles between showing workloads only and showing workloads as well as labeled applications **Note:** If a workloads-only view is deemed unnecessary, this checkbox could be removed as it would effectively always be checked in this case.
- **Application Versions:** Shows all applications as collapsed shapes when unchecked, and shows application versions inside of application rectangles when checked.

### Edge Labels
Controls what information is shown on the graph's edges

![Edge Labels dropdown](img/edge-labels.png)

### Fetching Settings
Controls how much and how often data is retrieved. Also enables the user to manually fetch data.

![fetching settings](img/fetching-settings.png)

### Zoom Tool
The graph zoom tool contains buttons that enable the user to zoom the graph in and out as well as fit the zoom to the current view. This tool may optionally contain a trigger for the graph legend as well as a graph layout selector.
![zoom tool on the service graph](img/zoom-tool-full.png)

### Zoom Tool Actions
![zoom tool](img/zoom-tool.png)
- **Zoom in:** Zooms the graph by a factor of 2 (e.g. 50% => 100%, 100% => 200%)
- **Zoom out:** Zooms the graph by a factor of .5 (e.g. 200% => 100%, 100% => 50%)
- **Zoom to fit:** Zooms the graph to fit the current viewport size
- **Legend:** Shows and hides the graph legend

#### Optional Actions
![zoom tool](img/zoom-tool-display-buttons.png)
- **Graph layout toggle:** The graph zoom tool could optionally include buttons to toggle the graph layout. This should only be done if all available graph layouts are able to be described by icons or some other extremely short identifier.


## Legend
The graph legend appears when the legend trigger button is clicked and contains a brief overview of the possible items that a user may encounter on the graph. If technically possible, this legend should be draggable around the viewport so that it does not obscure important details. If that is not technically possible, the legend should be fixed in the bottom left corner of the viewport.
![graph legend](img/legend.png)
Expand All @@ -26,7 +42,8 @@ The graph legend appears when the legend trigger button is clicked and contains
1. **Close Button:** Dismisses the legend. Clicking on the legend trigger button again will also dismiss the legend
1. **Key:** Contains all of the shapes and colors that have meaning on the graph and labels each with a succinct, descriptive phrase.

## Service Representation Colors
## Graph Nodes and Edges

Nodes in the service graph are colored according to their health. Borders are 1px wide for unselected nodes and 3px for selected nodes. Graph edges are colored similarly, with 1px lines when unselected, and 3px lines when selected. There is no separate hover state for graph edges, but items not directly connected to the hovered edge should be blurred into the background.

### Healthy
Expand Down
Binary file added service-graph/img/display-settings.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 service-graph/img/edge-labels.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 service-graph/img/fetching-settings.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 service-graph/img/graph-controls.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 removed service-graph/img/zoom-tool-display-buttons.png
Binary file not shown.
Binary file removed service-graph/img/zoom-tool-full.png
Binary file not shown.
Binary file modified service-graph/img/zoom-tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0976ab8

Please sign in to comment.