Appearance
Interface Overview
Understanding the ErgoPlanner user interface
Main Layout
ErgoPlanner uses a flexible panel-based layout with four main areas:
┌─────────────────────────────────────────────────────────────┐
│ Header Bar │
├──────────┬──────────────────────────────────┬──────────────┤
│ │ │ │
│ Stencil │ Drawing Canvas │ Properties │
│ Panel │ │ Panel │
│ │ │ │
│ │ │ │
├──────────┴──────────────────────────────────┴──────────────┤
│ Results Panel │
└─────────────────────────────────────────────────────────────┘Header Bar
The header bar provides access to main functions:
| Element | Description |
|---|---|
| Navigation toggle | A single button in the header collapses or expands the sidebar (on a narrow window it opens and closes the navigation drawer). Its tooltip reads "Collapse navigation" or "Expand navigation". The open phone drawer also has its own Close navigation button, and closing it returns focus to the header toggle. |
| Logo | Return to dashboard |
| Project Name | Current project title (click to rename) |
| File Menu | New, Open, Save, Export options |
| Edit Menu | Undo, Redo, Cut, Copy, Paste |
| View Menu | Toggle panels, zoom controls |
| Simulation | Run, stop, configure simulations |
| Help | Documentation, tutorials, support |
| User | Account settings, logout |
Stencil Panel (Left)
The stencil panel contains all available process units organized by category:
Categories
| Category | Description | Units |
|---|---|---|
| Preliminary Treatment | Screens, grit chambers | 9 |
| Primary Treatment | Clarifiers, settlers | 3 |
| Biological Treatment | Reactors, biofilm systems | 24 |
| Secondary Treatment | Secondary clarifiers | 4 |
| Tertiary Treatment | Filtration, disinfection | 11 |
| Sludge Treatment | Thickening, digestion | 19 |
| Chemical Dosing | All chemical systems | 24 |
| Auxiliary Equipment | Pumps, blowers, etc. | 20+ |
Using the Stencil Panel
- Expand Category: Click the category header
- Find Unit: Use the search box at the top
- Add Unit: Drag from stencil to canvas
- View Info: Hover over unit for tooltip
Drawing Canvas (Center)
The main work area where you build process flow diagrams.
Canvas Controls
| Control | Action |
|---|---|
| Scroll | Pan the canvas |
| Ctrl + Scroll | Zoom in/out |
| Click + Drag | Select multiple items |
| Double-click | Edit unit properties |
| Right-click | Context menu |
Grid and Snap
- Grid: Toggle with View > Show Grid
- Snap to Grid: Toggle with View > Snap to Grid
- Grid Size: Adjust in Settings > Canvas
Zoom Controls
- Zoom In: Ctrl + Plus (+)
- Zoom Out: Ctrl + Minus (-)
- Fit to Screen: Ctrl + 0
- 100%: Ctrl + 1
Mini-map
Enable the mini-map (View > Mini-map) for navigation in large diagrams.
Properties Panel (Right)
Shows properties of the selected item:
Unit Properties
When a process unit is selected:
| Section | Content |
|---|---|
| General | Name, ID, calculation mode |
| Design | Physical dimensions, capacity |
| Operating | Setpoints, parameters |
| Performance | Results, efficiencies |
Connection Properties
When a connection (stream) is selected:
| Section | Content |
|---|---|
| Stream Type | Liquid, Gas, Sludge, Chemical |
| Flow | Volumetric flow rate |
| Composition | Water quality parameters |
| Mass Flow | Mass balance values |
Multi-Selection
When multiple items are selected:
- Shows common properties only
- Changes apply to all selected items
- Count of selected items displayed
Results Panel (Bottom)
Displays simulation results and analysis:
Tabs
| Tab | Content |
|---|---|
| Mass Balance | COD, N, P, TSS tracking |
| Performance | Unit efficiencies and margins |
| Energy | Power consumption breakdown |
| Emissions | GHG and carbon footprint |
| Logs | Simulation messages and warnings |
Mass Balance Table
Columns:
- Parameter: COD, TSS, TN, TP, etc.
- Influent: Input loading
- Effluent: Output loading
- Removed: Mass removed
- Efficiency: Percentage removal
Expanding/Collapsing
- Drag the panel border to resize
- Double-click to maximize/minimize
- Close individual tabs with X
Toolbar
Quick access buttons above the canvas:
| Icon | Function | Shortcut |
|---|---|---|
| ↩️ | Undo | Ctrl + Z |
| ↪️ | Redo | Ctrl + Y |
| ✂️ | Cut | Ctrl + X |
| 📋 | Copy | Ctrl + C |
| 📄 | Paste | Ctrl + V |
| 🗑️ | Delete | Delete |
| ▶️ | Run Simulation | F5 |
| ⏹️ | Stop Simulation | Shift + F5 |
| 💾 | Save | Ctrl + S |
Status Bar
The bottom status bar shows:
| Element | Description |
|---|---|
| Simulation Status | Running, Stopped, Error |
| Time | Current simulation time (dynamic mode) |
| Progress | Convergence progress |
| Zoom Level | Current zoom percentage |
| Selection | Number of selected items |
Panel Customization
Resizing Panels
- Drag panel borders to resize
- Minimum and maximum sizes enforced
- Reset to default with View > Reset Layout
Hiding Panels
- Toggle panels in View menu
- Use keyboard shortcuts:
- Ctrl + 1: Stencil Panel
- Ctrl + 2: Properties Panel
- Ctrl + 3: Results Panel
Docking
Panels can be:
- Docked: Attached to main window
- Floating: Independent window
- Tabbed: Multiple panels in one area
Touch devices
On a touch-primary device (a phone or tablet whose main pointer is a finger), the Draw editor enlarges its chrome so it can be used without a mouse: every button in the menu bar, toolbar, footer and stencil panel is at least 44 by 44 pixels, and the stencil category rows are 44 pixels tall. The toolbar stays on one row and shows only the first eight controls (Save, Undo, Redo and the Select, Pan, Connector, Line and Rectangle tools); every other tool and action, including Import, BOM and Template, is in the More menu. The footer's dense status readouts (save state, connection, cursor position and zoom) collapse into a single status button that opens a small panel, which also holds the Drawing setup and Delete drawing actions for the active drawing tab. Grid options and Page setup are available from the expanded toolbar ribbon. A mouse or trackpad keeps the dense desktop layout unchanged.
Themes
ErgoPlanner supports multiple themes:
| Theme | Description |
|---|---|
| Light | Default bright theme |
| Dark | Dark mode for low light |
| System | Match OS preference |
| High Contrast | Accessibility theme |
Change theme in Settings > Appearance > Theme
Accessibility
ErgoPlanner includes accessibility features:
- Keyboard Navigation: Full keyboard support
- Screen Reader: ARIA labels throughout
- High Contrast: Enhanced visibility theme
- Zoom: UI scales with browser zoom
Next Steps
- Keyboard Shortcuts - Work faster with shortcuts
- Quick Start Guide - Create your first simulation
- Building Process Diagrams - Detailed guide