{"id":69259,"date":"2024-10-01T15:46:26","date_gmt":"2024-10-01T07:46:26","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=69259"},"modified":"2024-10-23T14:47:18","modified_gmt":"2024-10-23T06:47:18","slug":"embedded-trend","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/embedded-trend\/","title":{"rendered":"Embedded Trend"},"content":{"rendered":"

<\/p>\n

This article applies to version 4.10.2 and later of IFS OI Explorer. For more, see Release History<\/a>.<\/p>\n

Overview<\/h2>\n

The embedded trend component includes most of the functionality of the Explorer Trend. It is used when a trend is needed on an Explorer page, and can be opened as a full page trend if access to all of the trend features is required.<\/p>\n

Using the embedded trend component saves on browser resources and offers an integrated experience with the rest of the Explorer page, compared to embedding an Explorer trend on the page.<\/p>\n

Traces can be added to an embedded trend in the configuration and in the display mode, but can only be saved as part of the trend when added in the configuration.<\/p>\n

All trends embedded in a page will by default use the page control variables. This means that changing something like a datetime picker on the page will cause the embedded trend to re-load with this time. This will also apply when you have configured the embedded trend to use a previously saved full page trend.<\/p>\n

\"\"<\/a><\/p>\n

Related: Using an Embedded Trend<\/a>.<\/p>\n

\n

Quick Start<\/h2>\n

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.<\/p>\n

Watch:<\/strong> This video [1:59] to see how to add items to an embedded trend in Studio and in display mode. You can drag and drop, or in Studio you can also type into the Search<\/em> box, to add attribute values, tags, calculation tags, and ad hoc calculations.<\/p>\n\r\n\t\r\n\t

\n

Configuration<\/h2>\n

The default configuration can be customized to suit your application.<\/p>\n

\u200b<\/p>\n\n\n\n\n\n\n\n\n\n\n
1.<\/strong><\/td>\n\n

Embedded Trend Title<\/strong><\/p>\n

Add an optional title to the trend.<\/td>\n

\"\"<\/a><\/td>\n<\/tr>\n
2.<\/strong><\/td>\n\n

Saved Explorer Trends<\/strong><\/p>\n

Select Use Saved Trend to embed a saved full page trend onto the page.<\/p>\n

\"\"<\/a><\/p>\n

To use the saved trend control values, delete the Start Time, End Time, Sample Interval and Sample Method variable names in the embedded trend editor, and it will then obey the settings from the saved Full Page Trend. See 5. Data Sampling<\/strong> below.<\/p>\n

Note:<\/strong> Embedding a saved trend uses more browser resources and reduces performance and page integration options.<\/p>\n

Read more:<\/strong> Embed a Templated Trend<\/a><\/p>\n<\/td>\n

\n

\u00a0<\/strong><\/p>\n<\/td>\n<\/tr>\n

3.<\/strong><\/td>\n\n

Trend Data<\/strong><\/p>\n

Data can be added to an embedded trend in Design Mode and Display Mode. Either drag and drop tags and attributes from from the Tags or Hierarchy Navigators, or search for data in the Search<\/em> box.<\/p>\n

Related:<\/strong> Tag Search and Hierarchy Navigation<\/a><\/p>\n<\/td>\n

\n

\u00a0<\/strong><\/p>\n<\/td>\n<\/tr>\n

4.<\/strong><\/td>\n\n

Trend Appearance<\/strong><\/p>\n

Set Toolbar<\/a>, Controls<\/a>, Auto Range<\/a> and Trace Table <\/a>\u00a0display options.<\/p>\n

If Auto Range is selected in the configuration, it is automatically applied to each trace that is added to the chart. This applies to traces added in the configuration and in display mode.<\/p>\n

The Toolbar, Controls and Trace Table display options can also be selected in display mode.<\/p>\n<\/td>\n

\n

\u00a0<\/strong><\/p>\n<\/td>\n<\/tr>\n

5.<\/strong><\/td>\n\n

Data Sampling<\/strong><\/p>\n

Start Time<\/strong>: The start of the trend range. The default value is the page default<\/a> for startTime<\/em>.
\nEnd Time<\/strong>: The end of the trend range. The default value is the page default for endTime<\/em>.
\nSample Interval<\/strong>: The method (e.g. average<\/em>) that IFS OI Server uses to collect the trend data. The default value is the page default for pageSampleInterval<\/em>.
\nSample Method<\/strong>: The interval (e.g. 1 week<\/em>) that IFS OI Server uses to collect the trend data. The default value is the page default for pageSampleMethod<\/em>.<\/td>\n

\n

\u00a0<\/strong><\/p>\n<\/td>\n<\/tr>\n

6.<\/strong><\/td>\n\n

Hairlines<\/strong><\/a><\/p>\n

Hairline Mode<\/strong>: The number of hairlines allowable on the embedded trend (None, Single, Dual or Multiple). The default is None<\/em>.
\nHairline Start<\/strong>: The time of the left-most hairline. If the Hairline Mode is Single<\/em>, Hairline Start and Hairline End will have the same value. The default is the variable,\u00a0hairlineStart<\/em>.
\nHairline End<\/strong>: The time of the right-most hairline. The default is the variable, hairlineEnd<\/em>.
\nHairline Display Options<\/strong>:<\/a> Select to display the timestamp, value and\/or trace name on the hairline.<\/td>\n

\u00a0<\/td>\n<\/tr>\n
7.<\/strong><\/td>\n\n

Entity Context<\/strong><\/p>\n

Set the Entity Context if you have an ad hoc calculation as part of the embedded trend data.\u00a0selectedEntity<\/em>\u00a0will update for the selected entity on the Hierarchy Navigator, if you open the page from the entity's\u00a0Table of Contents<\/a>\u00a0ribbon tab.<\/td>\n

\n

\u00a0<\/strong><\/p>\n<\/td>\n<\/tr>\n

8.<\/strong><\/td>\nThe top left cell of a page is specified as Column 0, Row 0.<\/p>\n

Related:<\/strong> Grid Layout<\/a>.<\/p>\n<\/td>\n

\u00a0<\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

Embed a Templated Trend<\/h2>\n

To use a Templated Trend as the Saved Trend:<\/p>\n

1. Set the Entity Context in the embedded trend configuration to Variable and choose a variable<\/p>\n

\"\"<\/a><\/p>\n

2. In Page Properties under Entity Mapping, select the same variable as above<\/p>\n

\"\"<\/a><\/p>\n

Read More:<\/strong> Opening Page Properties<\/a>, Templated Trends<\/a><\/p>\n

\n

Tutorial<\/h2>\n

If you're unfamiliar with the process of building pages, read the article Building an Explorer Page<\/a>.<\/p>\n

In this tutorial, we'll add an embedded trend to a page in Studio, add a trace from a navigator, and configure the trend to show the toolbar, and to have the option of adding a hairline.<\/p>\n

Note<\/strong>: This configuration uses the Sample Data <\/em>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.<\/p>\n

Step 1. Prepare a Studio Page<\/strong><\/p>\n

To start, click the New Page<\/strong> button on the Home tab of the ribbon. Choose the Grid layout.<\/p>\n

\"\"<\/a><\/p>\n

Step 2. Add an Embedded Trend<\/strong><\/p>\n

Drag and drop the Embedded Trend component onto a grid cell. The Embedded Trend is in the Chart \"chartsicon_sm\" group.<\/p>\n

\"\"<\/a><\/p>\n

The page can now be saved<\/a> and used with the default values and configuration.<\/p>\n

Default values:<\/em><\/p>\n

\"\"<\/a><\/p>\n

Read more: Default Values Panel<\/a><\/p>\n

Step 3. Configure the Embedded Trend<\/strong><\/p>\n

To add a trace to the trend from a navigator:<\/p>\n

1. Click Hierarchy<\/strong> on the shortcut menu to open the Hierarchy Navigator<\/a>.<\/p>\n

2. Select a hierarchy and an entity.<\/p>\n

3. Open the Attributes Panel<\/a> and click on the required attribute.<\/p>\n

4. Drag and drop the attribute value onto the data panel and close the hierarchy navigator.<\/p>\n

\"\"<\/a><\/p>\n

Follow the same steps using the Tags Navigator, to add a tag to an embedded trend.<\/p>\n

Select Show Toolbar in the configuration to display the toolbar.<\/p>\n

\"\"<\/a><\/p>\n

Open the Hairline Mode dropdown menu and select Single\u00a0<\/strong>to enable the ablility to add a single hairline to the trend.<\/p>\n

\"\"<\/a><\/p>\n

Step 5. All done!<\/strong><\/p>\n

Congratulations! You now have an Embedded Trend showing an attribute value and the Toolbar, and to which you can add a hairline.<\/p>\n