Embedded Trend (4.6.2)

This article applies to version 4.6.2 of P2 Explorer. For the latest help, see Embedded Trend.

Overview

The Embedded Trend component is used to embed a simplified trend within an Explorer page, and is used for quick and simple diagnostics of time series data.

The embedded trend works without any configuration, as many of the options are selected by default. Its purpose is to provide a place for users to add or remove data in Display Mode.

Users can drag and drop time series data labels from the page onto the trend, or drag tags and attributes from the Navigators. Right-clicking on the embedded trend opens a full Trend display.

Users can also add hairlines to the embedded trend (if these are enabled) by clicking the graph, and add comments to tags at a point in time.

This article describes how to configure an embedded trend.

Related: Using an Embedded Trend, Styling an Embedded Trend


Quick Start

You can add an embedded trend to a page with no configuration whatsoever - simply drag and drop it onto the canvas and save the page.

Watch this video [1:35] to see how to add items to an embedded trend in Studio. You can drag and drop, or type into the Search box to add attribute values, tags, calculation tags, and ad hoc calculations.


Configuration

If you would like to configure the embedded trend, here are the options:

Data items You can add data in Design Mode, which is added to in Display Mode. Either drag and drop tags and attributes into this area, from the Navigators, or search for data in the Search edit box.
Trend appearance

Show Legend: Selected by default. If you deselect the check box, the trend won't have a legend. Note: Tags added during page design appear in the legend in the order they were added to the component. Tags that are added in display mode appear at the end of the legend items.

Show x-axis: Selected by default. If you deselect the check box, the trend won't have the horizontal x-axis, showing time.

Show y-axis: Selected by default. If you deselect the check box, the trend won't have the vertical y-axis, showing values.

Auto Range: Selected by default. Auto Range manipulates the y-axis so that all values appear on the trend.

Data sampling

Start Time: The start of the trend range. The default value here is the page default for startTime.

End Time: The end of the trend range. The default value here is the page default for endTime.

Sample Interval: The method (e.g. average) that P2 Server uses to collect the trend data. The default value here is the page default for pageSampleMethod.

Sample Method: The interval (e.g. 1 week) that P2 Server uses to collect the trend data. The default value here is the page default for pageSampleInterval.

Hairline options

Hairline Mode: The number of hairlines allowable on the embedded trend (Single, Dual, Multiple or None). The default is None.

Hairline Start: The time of the line at the left-most hairline. If the Hairline Mode is Single, Hairline Start and Hairline End will have the same value. The default is the variable, hairlineStart.

Hairline End: The time of the line at the right-most hairline. The default is the variable, hairlineEnd.

Hairline Display Options: Select what labels, if any, to show with the hairline.

Entity Context Set the Entity Context if you have an ad hoc calculation as part of the embedded trend data. selectedEntity will update for the selected entity on the Hierarchy Navigator, if you open the page from the entity's Table of Contents ribbon tab.

Tutorial

If you're unfamiliar with the process of building pages, read the article Building an Explorer Page.

In this tutorial, we'll show you how to add an embedded trend to a page in Studio, and configure it to show hairlines. We will also add interactive controls on the page to mimic those on the Trend.

Note: This configuration uses the Sample Data table and datasets that can be optionally made available during initial installation and setup. If you don't have access to this data, you will need to adjust the configuration to suit your data at your site.

 

Step 1. Prepare a Studio Page

Before you start, click the New Page button on the Home tab of the ribbon. Choose the Grid layout.

 

Step 2. Add an Embedded Trend

Drag and drop the Embedded Trend component onto a grid cell. The Embedded Trend is in the Chart chartsicon_sm group.

You can save the page now and the embedded trend will be ready to use. However we will configure the page further.

 

Step 3. Configure the Embedded Trend

  • Open the Hierarchy Navigator, and drag and drop the current Choke Position for the Beardy entity, onto the Embedded Trend component editor.
  • Change Hairline Mode to Single.

 

Step 4. Add and Configure a Combo Box

In this step, we will add a combo box component to provide options for changing the sample method of the embedded trend.

Drag and drop the Combo Box component onto a grid cell. The Combo Box is in the Control Controls group.

Configure the following settings:

  • Option Values: Add the following values: Average, Last Known Value, Linear Interpolate, Adaptive Raw.

  • Selected Option: Type pageSampleMethod into the box. We will use this variable to link the combo box to the Sample Method setting for the Embedded Trend.

 

Step 5. All done!

Congratulations! You now have an Embedded Trend showing an attribute value, for which you can change the sample method and add a hairline.

  • Click the preview preview button on the Studio toolbar to see what your page will look like in display mode.
  • Select different options from the combo box and observe the changes in the embedded trend.
  • Click on the trend to see a hairline.

save Remember to save your page!

 


Release History

  • Embedded Trend 4.6.2 (this release)
    • New Hairline setting: Hairline Display Options
  • Embedded Trend 4.5.5
    • Hairline format has changed
    • Comments marker has changed
    • Tags added during page design appear in the legend in the order they were added to the component. Tags that are added in display mode appear at the end of the legend items
  • Embedded Trend 4.5.4
    • You can now drag a data label for an ad hoc calculation onto an embedded trend
    • You can drag a data label from a different page onto an embedded trend
    • Trace colours improved
    • The editor now shows a calculator icon for ad hoc calculation data

Comments are closed