Difference between revisions of "GUI"

From 3forge Documentation
Jump to navigation Jump to search
Line 13: Line 13:
 
[[File:GUI.GettingStarted.03.jpg|800px]]
 
[[File:GUI.GettingStarted.03.jpg|800px]]
  
On the dashboard you will see 1) a '''Layout Editor''' toggle button in the upper right corner, 2) a menu bar at the top, and 3) the work area below where you add layout components
+
On the dashboard you will see 1) a '''Layout Editor''' toggle button in the upper right corner, 2) a menu bar at the top, and 3) the workbook area below where you add layout components
  
 
1. Layout Editor Toggle Button
 
1. Layout Editor Toggle Button
Line 40: Line 40:
  
 
(Clicking on the 3Forge icon will open up 3Forge's website in a new tab)
 
(Clicking on the 3Forge icon will open up 3Forge's website in a new tab)
 +
 +
3. The Workbook
 +
 +
This is where the dashboard is presented as it is built or loaded
 +
 +
=Creating Your First Visualization=
 +
 +
Creating a visualization can be summarized into 3 steps:
 +
 +
1. Create a window to put your visualization in
 +
2. Connect to the data using the Data Modeler
 +
3. Select how you want to visualize your data

Revision as of 20:25, 31 March 2021

Getting Started

Log into AMI with the provided user name and password (default user/password is demo/demo123)

GUI.GettingStarted.01.jpg

After logging into AMI, choose a layout style (Default Style is shown)

GUI.GettingStarted.02.jpg

After selecting a style, you will move onto the new dashboard

GUI.GettingStarted.03.jpg

On the dashboard you will see 1) a Layout Editor toggle button in the upper right corner, 2) a menu bar at the top, and 3) the workbook area below where you add layout components

1. Layout Editor Toggle Button

GUI.GettingStarted.04.jpg

(Hotkey: CTRL + D)

AMI dashboard builder has two modes. When the Layout Editor is turned on, you have access to tools and functionality for editing the dashboard.

Note: if you do not see the Layout Editor Button, your user account is not entitled for building layouts.

  • The Windows menu will have an option to add New Windows and to Manage Windows
  • There will be a new Dashboard menu item for accessing tools
  • All existing panels will have a green button for accessing that panel's settings

2. The Menu

GUI.GettingStarted.05.jpg

  • File: manage saving and loading of dashboards
  • Account: control your personal settings and preferences
  • Windows: access, manage, and create windows
  • Help: get AMI version, Runtime settings, and list of available script methods, etc.
  • Dashboard (in Layout Editor mode): access tools and functionality for building out the dashboard

(Clicking on the 3Forge icon will open up 3Forge's website in a new tab)

3. The Workbook

This is where the dashboard is presented as it is built or loaded

Creating Your First Visualization

Creating a visualization can be summarized into 3 steps:

1. Create a window to put your visualization in 2. Connect to the data using the Data Modeler 3. Select how you want to visualize your data