Live Historical Chart Widget

<< Click to Display Table of Contents >>

Navigation:  Live > Widgets >

Live Historical Chart Widget

The EQuIS Live - Historical Chart widget provides visual interaction with a high volume of data over an extended period of time. Remarks and qualifiers can be displayed on the widget. Users with editor permissions to the dashboard and the widget can add, edit, and delete remarks and qualifiers. (Note that the Historical Chart widget was previously named the Advanced Time Series widget.)

 

Live-Historical_Chart_Widget-Output

The widget contains two parts: A legend and a chart.

 

Legend

 

The legend displays information about the plotted series and allows the user to show or hide the series on the chart. The name of each series and logger source are denoted. If the series has a value for DT_LOGGER_SERIES.SERIES_UNIT, the series unit is displayed in parentheses.

 

Toggle the Show check box for each series to show or hide that series on the chart. The Nav column decides which series will be shown in the Navigator at the bottom of the chart. Click the series name in the legend to show or hide the typical range for the given series (the "plot band"). This range is defined in DT_LOGGER_SERIES.TYPICAL_MIN_VALUE and DT_LOGGER_SERIES.TYPICAL_MAX_VALUE, but can also be set manually for each series in the Widget Editor.

 

Chart

 

The chart portion of the widget displays the logger data as a time series graph. The header of the chart contains a Chart Context Menu and navigation options. The user can hover over individual data points in the data series to see values. Remarks and qualifiers can be added to the chart.

 

Chart Navigation

 

The chart can be navigated by a variety of options:

Using Zoom options (one day's worth of data, one week's etc.);

Entering start and end dates and time;

Using the Navigator; or

Selecting a region of the chart to zoom in.

 

The Zoom buttons (top-left corner of chart) allow the user to quickly and easily zoom into a particular date range as follows:

1d – One day

1w – One week

1m – One month

1y – One year

All – All of the data included in the widget

Live-Chart-Zoom_Options

 

The dates to the right of the Zoom buttons (i.e., From and To) display the currently visible date range. For example, the series may have data from an entire year, but the user may be zoomed in to just two months. The From and To dates will display the start and end date of the time period that is currently visible on the chart.

Live-Chart-Zoom_Range

 

If enabled in the widget properties, the chart Navigator will appear at the bottom of the chart. The Nav column decides which series will be shown in the chart Navigator. Use the Navigator to navigate the date range that is displayed within the chart. The Navigator shows the entire date range for the chart, with the currently visible date range selected as shown in the scroll bar. Use the bottom scroll bar to scroll through the date range. Click and drag the selected range to increase or decrease the visible date range.

Live-Chart-Navigator

 

Tooltip

 

Hovering the mouse over the chart will display a tooltip. The top line of the tooltip contains the date/time value at the current point on the time axis (i.e., X-axis). The date/time will be displayed based on the culture specified in the current browser settings. Following the date/time value, each series will be listed (assuming the series has a value for the current date/time). The series name will be followed by the value. The values will be displayed with the number format based on the culture specified in the current browser settings.

 

Chart Context Menu

 

Options for downloading data (as seen in the chart), printing or exporting chart images, and applying remarks or qualifiers can be found from the Chart Context Menu (Live-Chart_Context_Menu-Icon) in the top-right corner of the chart. The Chart Context Menu allows the user to:

Download – When selected, the download options are displayed (defined below).

Print – Send the visible chart to the printer.

Search – User can search qualifiers and remarks between date range. Users with editor permissions can edit or delete remark from list that will refresh on chart.

Add Remark – Add a flag on data at a certain point to indicate an anomaly or to distinguish that data area. Will only be displayed for users with appropriate permissions.

Add Qualifier – Highlight specific portions of data via a selected color. Will only be displayed for users with appropriate permissions.

Remove Qualifiers – Remove qualifiers for currently visible data points. Will only be displayed for users with appropriate permissions.

 

Download options include:

CSV – A comma-separated values (CSV) file. A CSV file is a plain-text format used to represent tabular data.

CSV (Raw) – A comma-separated values (CSV) file of the raw data.

PNG – Downloads the visible chart as PNG (Portable Network Graphic) image.

JPEG – Downloads the visible chart as JPG/JPEG (Joint Photographics Experts Group) image.

PDF – Downloads the visible chart as PDF (Portable Document Format).

SVG – Downloads the visible chart as SVG (Scalable Vector Graphic) image.

 

Remarks

 

Remarks allows a flag to be added on the data at a certain point to indicate an anomaly or to distinguish that data area in any way desired. Users with editor permissions to the dashboard and the widget can add, edit, and delete remarks. Clicking on a remark displays a dialog that allows user to edit or delete the remark. Use the Search functionality in the Chart Context Menu to find specific remarks.

 

Add a Remark

1.Edit the logger series and ensure Show Remarks is checked.

2.On the chart, zoom to a section of the series where the remark will be added. The remark will appear in the center of the selected data.

3.Click the Chart Context Menu (Live-Chart_Context_Menu-Icon ) in the top-right corner of the chart and select Add Remark from the drop-down menu.

4.A dialog box will appear with two tabs (Remark and Series). On the Remark tab, type the remark.

5.To change the date range for the remark, click on the Edit Date Range button and additional fields will appear to edit the start and end date times.

6.On the Series tab, choose which series to apply the remark. If a series is charted more than once (e.g., Daily Max and Hourly Average), they will be grouped together. A grouped series will be selected by default if one or more are displayed on the chart.

Live-Historical_Chart_Widget-Add_Remark

7.Click OK. The chart will reload with the remark applied.

Live-Historical_Chart_Widget-Output-Remark

 

Edit a Remark

1.Click on the text inside the remark. A dialog box will appear asking if you want to edit or delete the remark.

Live-Historical_Chart_Widget-Edit_Remark

2.Click the Edit button.

3.A new dialog box will appear to edit the remark text and date range for the remark.

Live-Historical_Chart_Widget-Edit_Remark2

4.Click Update when done editing.

 

Remove a Remark

1.Click on the text inside the remark. A dialog box will appear asking if you want to edit or delete the remark.

Live-Historical_Chart_Widget-Edit_Remark

2.Click the Delete button.

 

 

Qualifiers

 

Qualifiers can be used to highlight specific portions of data via a selected color. If a 'transparent' color is selected, then this can be used to hide sections of data, if desired (e.g., if a logger was found to be faulty for a certain period). Users with editor permissions to the dashboard and the widget can add, edit, and delete qualifiers.

Live-Historical_Chart_Widget-Output2

 

Add a Qualifier

1.Edit the logger series and ensure the desired qualifier is added to the series.

2.On the chart, zoom to a section of the series where the qualifier will be added.

3.Click the Chart Context Menu (Live-Chart_Context_Menu-Icon ) in the top-right corner of the chart and select Add Qualifier from the drop-down menu. To add a qualifier to the drop-down menu or to change the color for the qualifier, go to the Qualifier tab in the Widget Editor (see section below).

4.A dialog box will appear with three tabs (Qualifier, Date Range, and Series). On the Qualifier tab, select the qualifier to add from the drop-down menu.

5.On the Date Range tab, adjust the start and end date times for the qualifier if needed.

6.On the Series tab, choose which series to apply the qualifier. If a series is charted more than once (e.g., Daily Max and Hourly Average), they will be grouped together. A grouped series will be selected by default if one or more are displayed on the chart.

Live-Historical_Chart_Widget-Add_Qualifier

7.Click OK. The chart will reload with the qualifier applied.

 

Remove Qualifiers

1.Zoom to a region of data.

2.Click the Chart Context Menu (Live-Chart_Context_Menu-Icon) in the top-right corner of the chart.

3.Select Remove Qualifiers.

 

 

Configure Remark Dialog

 

The Live Historical Chart widget can be configured to automatically display a remark dialogue box after a user adds, edits, or removes a qualifier from the widget.  

Live-Historical_Chart_Widget-Force_Remark_Dialogue_Box

To use this feature, the database's ST_CONFIG table must have a row with the following values:

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

STRING_VALUE

EarthSoft.Live.Widgets

qualifier

force_remarks

true

 

 

Widget Properties

 

Use the Widget Editor to change the properties of the Live Historical Chart widget. The widget properties are divided into four tabs (Series, Options, Qualifiers, and Default Options) in the Widget Editor and are each described in the linked help article.