Console UI Overview
Navigate the Synnax Console UI.
The Synnax Console provides a flexible environment to display and interact with data stored and streamed through a Synnax cluster. It’s interface is designed around two main UI elements: the central layout mosaic and side toolbars.
The central mosaic displays visualizations such as line plots and schematics, while the toolbars exists to provide access to resources, data ranges, tasks, and visualization controls.
Toolbars
To kick things off, we’ll walk you through each of the toolbars and their functionality.
Resources
The resource toolbar displays a file tree with folders for channels, ranges, users, and workspaces.
| Resource | Description |
|---|---|
| Channels | Channels are the sensor channels that you can track and plot. |
| Devices | Devices are the list of devices that are connected to the cluster. |
| Ranges | Ranges are saved times that you can use when loading data to view. |
| Tasks | Tasks are the current read and write tasks happening on devices connected to the cluster. |
| Users | Users are a list of all users registered in the cluster. The workspaces created by the users can be found underneath their name. |
| Workspaces | Workspaces list all created workspaces in the cluster. This tree includes workspaces created by all users. |
Ranges
The range toolbar allows you to create, view, and access the ranges you’re interested in visualizing.
Tasks
The task toolbar allows you to view, pause, and resume the current tasks happening on the cluster.
Visualizations
The visualization toolbar allows you to edit the properties of line plots and schematics.
Clusters
The cluster toolbar allows you to switch the current cluster that you are connected to and add new clusters.
Mosaic
Synnax can be easily manipulated to help choose the exact display you want.
You can easily open and close toolbars on Synnax:
You can close toolbars either by touching their respective icon or resizing it to the edge:
You can also have multiple visualizations displayed at the same time:
Getting Help
The Synnax documentation website can be opened from within the console by clicking the icon.
Search and Command Palette
The search and command palette at the top can be used to search for resources or to
activate commands. Searching for resouces can be done by searching or pressing
+P (Windows) / +P (MacOS). As an
example of searching for resources, you could search for a test range and then
automatically add it as the active range:
The search and command palette can run commands by entering a > into the toolbar or by
pressing ++P (Windows) /
++P (MacOS). This allows you to run
commands such as toggling the color theme, creating a visualization, adding a range, or
opening the documentation: