Gauge widgets
From SpinetiX Support Wiki
This page is related to data-driven widgets and was updated for Elementi 2018 - the information below might not apply for older versions.
Contents
Introduction
These widgets have been designed to represent spreadsheet data as gauge graphics. They can be found within the "Gauges" collection of Elementi widget library, starting with Elementi 3.1.0. They are grouped below depending on the type of gauge they are generating.
The following spreadsheet data source types (further called "channels") are supported:
- CSV spreadsheet file
- This is a delimited text file that uses a comma (other separators can be used as well) to separate values. Almost all spreadsheets and database management systems can export data as CSV file - some examples include: Microsoft Excel, Google Sheets, OpenOffice.org Calc, LibreOffice Calc, Numbers (spreadsheet), etc. The CSV file can either be imported into the Elementi project (total autonomy) or be located on a web server and retrieved from there by the HMP via Ethernet; it cannot be located on your PC or on a network shared folder.
- Google Sheets (added in Elementi 2016)
- This is part of a free, web-based software office suite offered by Google within its Google Drive service. The suite allows users to create and edit documents online while collaborating with other users in real-time. The Google Sheet data is retrieved from Google servers by the HMP via Ethernet.
- Microsoft Excel file (added in Elementi 2016)
- This is part of the Microsoft Office suite of applications, servers, and services developed by Microsoft; a web-based version is also available. Both newer and older Excel file formats are supported as data source. The data is retrieved by Elementi from the Excel source file and included (in CSV format) with the content at the time of publish on the HMP; to synchronize further changes within the Excel file, you need to re-publish the project on the HMP. The Excel file itself cannot be used by the HMP, thus it cannot be imported into the Elementi project, nor be referenced from a web server.
- Excel Online (added in Elementi 2017)
- This is part of the Microsoft Office Online suite of applications, servers, and services developed by Microsoft; This allows users to create and edit documents online while collaborating with other users in real-time. The Excel Online data is retrieved from Microsoft servers by the HMP via Ethernet; only xlsx online documents are supported.
- SharePoint Online Lists (added in Elementi 2018)
- This is part of the Microsoft SharePoint Online platform that integrates with Microsoft Office 365. A list in SharePoint Online is a collection of data that gives you and your co-workers a flexible way to organize items, create calendars, to-do lists, and time lines. The SharePoint Online List data is retrieved from Microsoft servers by the HMP via Ethernet.
Getting started
Getting started is easy - download Elementi software, launch it and create away! Just follow the 4 quick steps below:
- Open your Elementi project.
- Click on the "Widgets" tab within the browse panel.
- Open the Gauges folder and pick a widget.
- Include that widget into your project and configure it.
Gauge widgets
Circular gauges
A basic circular gauge represents a single data item by rotating an indicator along a circular path to point to the current data value.
- Meter Circular
- Displays a circular meter and rotates an indicator to point to the current value, which can be extracted from the data source or entered manually.
- Meter Semicircular
- This is a variant of the "Meter Circular" widget, where the meter is drawn on a semicircle.
- Meter Circular Thresholds
- This is a variant of the "Meter Circular" widget, where different thresholds can be defined on the "Thresholds" tab.
- Meter Semicircular Thresholds
- This is a variant of the "Meter Semicircular" widget, where different thresholds can be defined on the "Thresholds" tab.
A circular bar gauge represents one or more data item values by filling a progress bar with a solid color or a gradient from the baseline to the current value along a circular path.
- Solid Circular
- Displays a circular solid bar and fills a part of it with the selected color to point to the current value, which can be extracted from the data source or entered manually.
- Solid Semicircular
- This is a variant of the "Solid Circular" widget, where the solid bar is drawn on a semicircle.
- Solid Circular Thresholds
- This is a variant of the "Solid Circular" widget, where the filling color is selected based on the different thresholds defined on the "Thresholds" tab.
- Solid Semicircular Thresholds
- This is a variant of the "Solid Semicircular" widget, where the filling color is selected based on the different thresholds defined on the "Thresholds" tab.
Linear gauges
A basic linear gauge represents a single data item by positioning an indicator along a vertical or horizontal line to point to the current data value.
- Meter Horizontal
- Displays a horizontal meter and moves an indicator to point to the current value, which can be extracted from the data source or entered manually.
- Meter Vertical
- This is the vertical variant of the "Meter Horizontal" widget.
- Meter Horizontal Thresholds
- This is a variant of the "Meter Horizontal" widget, where different thresholds can be defined on the "Thresholds" tab.
- Meter Vertical Thresholds
- This is a variant of the "Meter Vertical" widget, where different thresholds can be defined on the "Thresholds" tab.
A linear bar gauge represents one or more data item values by filling a progress bar with a solid color or a gradient from the baseline to the current value along a vertical or horizontal line.
- Solid Horizontal
- Displays a horizontal solid bar and fills a part of it with the selected color to point to the current value, which can be extracted from the data source or entered manually.
- Solid Vertical
- This is the vertical variant of the "Solid Horizontal" widget.
- Solid Horizontal Thresholds
- This is a variant of the "Solid Horizontal" widget, where the filling color is selected based on the different thresholds defined on the "Thresholds" tab.
- Solid Vertical Thresholds
- This is the vertical variant of the "Solid Horizontal Thresholds" widget.
- LED Horizontal
- Displays a horizontal LED bar and lights up part of the LEDs to point to the current value, which can be extracted from the data source or entered manually. The colors of the LEDs are defined on the "Thresholds" tab.
- LED Vertical
- Displays a vertical LED bar and lights up part of the LEDs to point to the current value, which can be extracted from the data source or entered manually. The colors of the LEDs are defined on the "Thresholds" tab.
Configuration
Each of the widgets above can be customized using the options provided under "Properties" tab.
To edit the properties related to the data source, click on the button. This opens the "Data Properties" dialog, which offers different parameters depending on the selected channel:
- CSV File (default)
- Excel File
- Google Sheets
- Excel Online
- SharePoint Online
See also
- Chart widgets
- Excel Chart widget
- Spreadsheet widgets
- Data feeds
- Data-driven widgets
- jSignage Graph plugin documentation for more advanced details about how these widgets were built.