Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:








IULocgo


Embedded View

Description

The Embedded view component allows you to include an entire view inside another. Using this component allows you to select a view to display, and to pass parameters into the view. Because of this, views can easily act as templates for information.

For example, you could create a tank view and embed several into another, larger view that shows an overview of the facility.

The embedded view is different than a container because you cannot alter the contents of a view using the Embedded View. A new container would allow you to create a new grouped set of components.

Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
pathPath of the view to load in wrapper.value: string
params

Parameters for the view. If passing parameters into the embedded view, the names here must match the parameters on that view.

The following feature is new in Ignition version 8.1.4
Click here to check out the other new features

As of 8.1.4 a dropdown list of parameters is available when the user clicks the  Add   Object Member    icon. This makes it easy to add parameters from the embedded view.  See also Embedded Views.

object
useDefaultViewWidthUse of view's default width instead of adjusting based on the content's width.value: boolean

useDefaultViewHeight


Use of view's default height instead of adjusting based on the content's width.

value: boolean


loading

The following feature is new in Ignition version 8.1.5
Click here to check out the other new features

View loading settings.
NameDescriptionProperty Type
order

Controls when the embedded view loads: alongside the parent view loading (with-parent), or after the parent view finishes loading (after-parent). Default is with-parent.

Generally speaking, with-parent is more efficient for the browser, but in some cases can feel slower overall. Alternatively, after-parent is generally less efficient for the browser and can add to the overall load time. However, since it allows the parent view to load first, after-parent may feel quicker since the topmost layer of views get started up sooner.

value: boolean
object
styleSets a style for this component. Full menu of style options is available. You can also specify a style class.  object
Example

In this example, there is a Map component and a Carousel component on the top of the page. Underneath them, we've placed an Embedded View component. The idea was to embed this overview to give users a quick visual reference to bigger picture trends for the site. This example assumes you have a view already created named "Pressure Trend Overview". Here are the properties for just the Embedded View:

PropertyValueStyle Category
props.pathPressure Trend OverviewN/A
props.style.backgroundColor#FFE8CCbackground
props.style.borderStylegrooveborder
props.style.borderWidth6pxborder


  • No labels