VIEW_INSPECT.MD

   1 # Sparky - Inventory UI Service\r
   2 \r
   3 ### _View & Inspect_ Overview\r
   4 \r
   5 _View & Inspect_ provides a graph based view of elements within AAI. A single entity is the entry point into each graph, and from that base element a graph is generated based off relationships. \r
   6 \r
   7 ### Navigation to _View & Inspect_\r
   8 \r
   9 The _View & Inspect_ view can be reached by two means:\r
  10 \r
  11 1. Main navigation menu\r
  12 2. Selecting a search result related to an entity instance (e.g. an entity called readme-entity)\r
  13 \r
  14 ### Using _View & Inspect_\r
  15 \r
  16 _View & Inspect_ is driven by using the search bar at the top of the UI to find and select entity instances. Once an instance has been slected, a request is proccessed in _Sparky's_ backend component that generates a graph representation of the selected entity. The graph data is returned to _View & Inspect_ and rendered on screen.\r
  17 \r
  18 #### Node Details\r
  19 \r
  20 Upon node selection, the selected graph node details will appear in a panel to the right of the graph titled, _Node Details_.\r
  21 \r
  22 ### Interacting with the Graph\r
  23 \r
  24 The graph can be panned by clicking and holding empty space amongst the graph and moving the mouse. This will pan the entire graph.\r
  25 The graph can be zoomed in and out by using a mouse scroll wheel.\r
  26 Nodes in the graph can be select by clicking on them.\r
  27 Nodes in the graph can be moved by clicking, holding, and dragging them using the mouse.