Console UI Overview

Learn how to 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, and visualization controls.

Toolbars

To kick things off, we’ll walk you through each of the toolbars and their functionality.

Resources

The resources 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.
Ranges	Ranges are saved times that you can use when loading data to view.
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

This toolbar allows you to create, view, and access the data ranges you’re interested in visualizing.

Visualizations

This toolbar can be opened by clicking the button in the bottom-right corner of the console. It allows you to edit the properties of the currently selected visualization in the Mosaic.

Clusters

The list of clusters that you are connected to is found by clicking on the cluster () icon in the bottom-right. This opens up a list of all available clusters. You can add new clusters from here. Also, you can switch your current active cluster. The text in the corner indicates whether you are connected, disconnected, or have a failed connection with the cluster. More information about clusters can be found in the page about connecting a cluster.

The Central Mosaic

The Synnax Console 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 the respective icon or resizing it to the edge:

You can also have multiple visualizations displayed at the same time:

Getting Help

The Synnax documentation can be opened from within the Synnax Console by clicking the icon.

The search toolbar at the top can be used to search for resources or to toggle commands. Searching for resouces can be done by searching or pressing ctrl+P.As an example of searching for resources, you could search for a test range and then have it automatically added as an active range:

The search toolbar can run commands by entering a “>” or pressing ctrl+shift+P.This allows you to run commands such as toggling the color theme, creating a visualization, adding a range, or opening the documentation: