Historical Chart Widget
Copyright © 2019 EarthSoft, Inc • Modified: 04 Mar 2019
The EQuIS Live - Historical Chart widget provides visual interaction with a high volume of data over an extended period of time. (Note that the Historical Chart widget was previously named the Advanced Time Series widget.)
The widget contains two parts: A legend and a chart.
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. 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.
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.
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;
•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
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.
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.
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.
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 () in the top-right corner of the chart. The Chart Context Menu allows the user to:
•Download CSV – Download a comma-separated values (CSV) file. A CSV file is a plain-text format used to represent tabular data.
•Download CSV (Raw) – Download a comma-separated values (CSV) file of the raw data.
•Download PNG – Download the visible chart as PNG (Portable Network Graphic) image.
•Download JPEG – Download the visible chart as JPG/JPEG (Joint Photographics Experts Group) image.
•Download PDF – Download the visible chart as PDF (Portable Document Format).
•Download SVG – Download the visible chart as SVG (Scalable Vector Graphic) image.
•Print – Send the visible chart to the printer.
•Add Remark – Add a flag on data at a certain point to indicate an anomaly or to distinguish that data area.
•Add Qualifier – Highlight specific portions of data via a selected color.
•Remove Qualifiers – Remove qualifiers for currently visible data points.
Use the Widget Editor to add series to the chart, edit existing series, and change other options for the chart. Select the More Options icon in the upper right corner of the Historical Chart widget to open the drop-down menu and then select the Edit menu option. The widget properties are divided into three tabs: Series, Options, and Qualifiers.
Widget Title – By default, the widget title is EQuIS Live - Historical Chart. The title can be modified.
Widget Color – The color of the widget can be changed using the Change Widget Themeicon to the left of the widget title.
Cancel – Select the Close without Saving button to exit the Widget Editor without saving changes.
Save – Changes will be applied to the widget by clicking on the Save button. The Widget Editor screen will close after the save operation is complete.
The grid at the bottom of the Series tab allows the user to view, edit, or delete the series currently displayed in the Live Historical Chart widget. The order of the series in the view grid is the display order for the widget legend. Use the Columns drop-down menu to determine which columns are displayed in the view grid.
To add a logger series:
1.Select a Facility (if the intended logger belongs to a facility).
2.If any loggers in this facility are tied to locations, optionally select the Location from the field that appears after selecting the facility.
3.Select a Logger.
4.Select a Series within the logger.
5.Select a Frequency on which to aggregate the series' data.
a.For example, display weekly summaries of a series whose raw data have a daily frequency.
b.Select None to show raw data.
6.If an aggregating Frequency is chosen, select a Calculation method.
Note: The "None" option will aggregate data using the Average calculation of the data, EXCEPT when there are values that fall outside of the typical range set in DT_LOGGER_SERIES. If any values in the set to be aggregated fall below TYPICAL_MIN_VALUE, the series will use the Minimum calculation on that data set. If any values in the set exceed TYPICAL_MAX_VALUE, the series will use the Maximum calculation.
7.Select a Series Type (Line, column, or candlestick).
8.Select a LineType (Solid, ShortDot, LongDash, etc.).
9.Select which Axis this series should use. Series using the "Shared" axis will all reference the same axis. Adding multiple series with "Own" axes will result in several left or right axes plotted on the chart. These series will be color-coded and marked in the chart legend to match the series to which it belongs.
10.Select whether or not the Plot Band will be shown for this series.
11.Select a Series Color for the series on the chart.
12.Optionally, set the Min/Max values for the series as displayed in the chart. These values are used for the series' plot band and for filtering out values if the Hide smaller values or Hide larger values options are enabled. If no minimum or maximum are set, they will be automatically populated with DT_LOGGER_SERIES.TYPICAL_MIN_VALUE and DT_LOGGER_SERIES.TYPICAL_MAX_VALUE, respectively, if they are not null.
13.Select a Start Date for the data (defaults to the earliest date in the series). Enter a date or use the date picker.
14.Select which Qualifiers to make available for display in the series. Note that qualifiers can be assigned to series by using the Out-of-Range agent or by following the "To Add a Qualifier" steps below.
16.The series will appear in the view grid at the bottom of the tab window.
Each logger series can be edited from the view grid. To edit a series, select the series in the view grid and then click the Edit icon on the toolbar of the view grid frame. Change properties for the series as desired. Click the Save icon on the toolbar to save changes. Otherwise, click the Cancel icon on the toolbar to return to the series list.
To reorder series within the chart's legend, select a logger series in the view grid and then use the Up and Down icons on the toolbar of the view grid frame.
To delete a logger series, select the series in the view grid and then click the Delete icon on the toolbar of the view grid frame.
The following parameters for the chart can be set on the Options tab:
•Show/hide the Legend, Navigator and Scroll Bar.
•Set Chart Height.
•Add labels to chart axes:
oShow X-Axis Label – Especially helpful to show what time zone is chosen using the Time Zone options.
oShow Y Axis Labels (Own) – When series are plotted with distinct (or "own") Y axes, displays labels by each axis. The series name becomes the label.
oY Axis (Left/Right) – Label applied to the "shared" left or right Y axes.
•Show Data Gaps – Gaps in data series will be displayed without lines joining them.
•Highlight Data Gaps – Gaps in data series will be highlighted with a vertical shaded region.
•Show Data Points – Individual data points will be plotted.
•Add/remove Min/Max Y Axis lines.
•Add/remove major and minor tick lines.
•Time Zone Override
oNone – Displays logger's local time.
oLocal – Displays user's local time.
oCustom – Displays with UTC offset entered in the adjacent box (e.g., entering "-6" will display in UTC-6:00).
•Max Decimal Digits – Decides how many decimal places will be used when displaying individual data points in the tooltip that appears in the main chart area.
•Stack Series – If column series are used, the series will be stacked on each other if this option is enabled.
•Fixed Start Date – Enter a number of days back that the data should be plotted. This will display all data series starting at that date, regardless of what each series start date was when added to the widget. Set "0" to turn this feature off.
Add qualifiers to Live data through the Historical Chart widget. These 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).
1.Open the Widget Editor.
2.On the Qualifiers tab, Click the Add icon on the toolbar and enter a qualifier name (up to four characters).
3.Select a color for the qualifier. To make data 'invisible', select 'Transparent' as the color.
4.Click the Save icon on the toolbar.
5.Select the Series tab.
6.Create a new series, selecting which of the qualifiers created in Step 2 should be shown in the series. If the series already exists, select the Edit icon on the toolbar and then select the Qualifier.
7.Click the Save icon on the toolbar.
8.Click the Save button on the Widget Editor header to close the Widget Editor and return to the chart.
9.Click on the chart to zoom to an area with of the series where you want to add a qualifier.
10.Select Add Qualifier from the Chart Context Menu () in the top-right corner of the chart.
11.Choose a qualifier from the drop-down menu.
13.The chart will reload with the qualifier applied. The qualifier will appear next to the series name in the widget tooltip.
Note: The qualifiers will also be applied to the DT_LOGGER_DATUM.DATUM_QUALIFIER field for the selected date range.
1.Zoom to a region of data.
2.Click the Chart Context Menu () in the top-right corner of the chart.
3.Select Remove Qualifiers.
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.
1.Edit the logger series and ensure "Show Remarks" is checked.
2.On the chart, zoom to a section of the series where you want to add the remark. The remark will appear in the center of the selected data.
3.Click the Chart Context Menu () in the top-right corner of the chart and select Add Remark from the drop-down menu.
4.Enter a name for the remark.
6.The chart will reload with the remark applied.
1.Refresh the widget (only if the widget has not been refreshed since the last addition of a remark).
2.Click on the text inside the remark.
3.Click OK to the prompt to delete the remark.