SubView

About 3 mincomplex

The SubView component embeds a saved view inside another view — a reusable panel you build once and drop into other displays: a shared header, a detail pane, or a live rendering of a PI Vision display. The embedded view stays fully interactive, and its path can be driven by data so the panel follows the selected asset.

For a worked example — embedding a heat-exchanger detail panel that re-targets as the operator picks a different exchanger — see Organizing Displays → Subviews. This page is the settings reference.

A SubView embedding a saved view as a panel inside another display

Quick Start

Drag the SubView component (in the Complex group) onto the canvas — it shows "Path is not set" until you point it at a view. Open Settings → Component Specific → Configure View Path, choose the view, and click Apply.

Configuring a SubView's view path

Generic Settings

Each IOTA component shares a set of generic settings. Expand each section below:

Workspace

These settings are applicable to the whole view.

Grid Properties

The grid is provided for convenience when developing dashboards as visual guides and snapping capability.

By default the work area grid is enabled and can be customized or even disabled in this menu.

Property Name	Description
Grid Color	Color of the grid
Grid Size	Size of the grid step
Snap to Grid	Enable/Disable snapping to the grid
Show Grid Lines	Show the grid as lines
Show Grid Dots	Show the grid as dots

Align Controls

The Align controls provides a means to align and distribute selected objects on the display.

Align Objects

You can align several components horizontally using the Align-left, Align-center or Align-right controls
You can align several components vertically using the Align-top, Align-vertical-center or Align-bottom controls

Distribute Objects

You can distribute several components on the vertical/horizontal axis by selecting them (select at least 3 components) and pressing Align-vertical/Align-horizontal
You can make all the selected components the same width/height by selecting them and pressing Adjust Width/Adjust Height

Tips

Hold the Ctrl button to select several components. The oldest component is used as a reference.

Anchor Points Options

The anchor points are eight squares around an object that allow you to resize the object. The anchor point options allow you to define the appearance of the anchor points.

Property Name	Description
Reference Point Color	Sets the color of the reference point (see Rotation and Position for more details)
Anchor Points Color	Sets the color of the rest of the seven anchor points
Point Options Color	Sets the color of the point options (only for Line and Bezier Curve)
Show Point Options	Show/Hide the point options

Locked View Options

These options define the appearance of the component border in the locked view for the selected component.

Property Name	Description
Active Border Fill	Sets the fill color of the border
Active Border Width	Sets the width of the border

Variable

Every component has a unique variable name. This variable name can be used to reference the component in multi-state configurations and other scripts.
On creation, every component is given a default name. This can be overwritten to be more user-friendly. To do so simply overwrite the value in the variable input field.

Arrange / Remove

Send Backward - move object one layer down
Bring Forward - move object one layer up
Send to Back - place object under all layers
Bring to Front - place object above all layers
To send/bring objects to the front/back use the first four buttons.
Any set of components can be deleted by either using the button or delete/del keyboard keys.

Rotation and Position

Reference Anchor Point - allows you to select one of the anchor points as a reference so that you can set an Angle (clockwise) of incline relative to this point.
By default the reference anchor point is the top left corner. You can also rotate the component by dragging one of the yellow corner points.
You can set the position of the component by setting the X and Y coordinates relative to theReference Anchor Point and the top-left corner of the work area.
You can drag any of the anchor points to change the width and height of the component, or you can set it manually by editing the Width and Height boxes.
Set Lock Aspect Ratio so that while changing width and height, the component width to height ratio stays the same
Transform allows you to view the component as a mirror or a reflection of itself

Actions

Actions or multi-states are programmable conditional states handled by user-generated code.

Note

Actions that have script handlers are marked with a circle

in the top right corner.

The currently supported actions are described in the table below:

Action	Trigger
OnCreate	When the component is created
OnFocus	When the component is selected
onClick	When the component is clicked or the selection is changed
onData	Each time the data changes for assigned channels
onTick	20 times per second
onDblClick	On mouse double click
onHover	When the mouse is over the component (and not when the mouse is not)

Properties

The properties menu for Channels allows you:

to modify the Label of the DataSource
to set UOM, lower and upper values
to choose number format and displayed digits
to adjust the line formatting for trend line components
to configure the additional regression lines that can be plotted for supported components

Title settings are suppressed

Unlike most components, the SubView has no Title / Text / Label settings — it renders another view, not a label of its own. Its size is set in Rotation and Position (see Sizing below).

SubView Settings

Visual Properties

Border Color: Defines the component's border color.
Border Width: Controls the width of the border frame. Default: 0 — invisible border.
Background Color: Defines the color of the area behind the component. Only visible before a view is loaded (or while it loads).

To pick color of your interest

To change color for specific visual property, click on the color box next to property description. The color picker dialog will be displayed.
Visual Properties: Color Picker Dialog
Pick the color of interest. The video below shows how to choose a solid, gradient or theme color.
Color Picker Dialog: Workspace
You can add Gradient Stops by double clicking and to remove - by pulling it up.
To close the color-picker dialog - click on the property color box (Step 1).
Closing color-picker dialog
Clicking on the workspace area instead of Settings Tab area -
component settings will disappear since component focus will be lost.
Color Picker Dialog: Workspace

Component Specific — Configure View Path

The Component Specific section holds a single Configure View Path button. It opens the Configure Path dialog, where you choose which view the SubView renders:

Input Mode — how the path is supplied:
- Channel — bind an attribute whose value is a view path. The SubView resolves the path from the channel's data, so feeding the component a different asset (for example with SetChannels) re-resolves the path and reloads the inner view. (Element-search channels are not offered as path attributes.)
- Custom — type a fixed Path, or click Browse Views to pick one.
Path Type:
- Absolute — the exact path to a view, independent of where the current view lives.
- Relative — resolved against the current view's location, so a SubView reused across a folder tree points at the right sibling/child view.
Path — the attribute (Channel mode) or text (Custom mode). A custom path may contain {param_name} and {assetId} placeholder tokens that are substituted from the Parameter List.
Preview — shows the assembled/resolved path so you can confirm it before applying.
Parameter List — Add Parameter to define tokens used in a custom path. Each row has a Name, Color, per-parameter Input Mode (Channel/Custom), and Value (an attribute or literal). Parameters substitute the matching {param_name} token in the path.
Apply — saves the path configuration to the component.

Warning

If the configured path resolves to the current view, the dialog shows a warning and the SubView will not load — a view cannot embed itself.

Sizing — native 1:1, clipped

The SubView renders the inner view at its native size (no scaling) and clips anything past its bounds — it does not shrink the inner view to fit the component. To show a whole view without scrollbars, match the two sizes:

SubView size — set Width × Height in Settings → Rotation and Position.
Inner view size — open the embedded view and set its workspace size in Edit → Background.

Matching the SubView Width and Height to the inner view in Rotation and Position

See Match the SubView size to the inner view for the full walkthrough.

Behavior

The inner view stays interactive — components inside the SubView respond to clicks, selections, and their own scripts, exactly as they would on their own view.
Scripts run — the embedded view's saved scripts execute when it loads.
Editor overlay — when the view is unlocked, a transparent overlay sits over the SubView so you can select and move it in the editor instead of clicking through to the inner components.
Error states surface as text in the component: "Path is not set", view-not-found, and failed-to-load; an in-progress bar shows while a view loads.

Organizing Displays → Subviews — worked example, PI Vision rendering, and absolute-vs-relative guidance
Passing Context — carry a selection into the embedded view
Navigation Between Displays — when to navigate instead of embed
IFrame — embed an external web page instead of a saved view