Sub-dashboard
The Sub-dashboard component is a container that is used to display a dashboard inside another dashboard. See the tutorial Using Sub-Dashboards and the Implant and Sub-Dashboard Comparison for more detailed information on usage. |  |
Public Variables (Properties)
[?]
Common variables and variable groups: Name, Advanced Properties, Container Properties, Styles, Preloader, Events, Bindings.
Reference
Path of a web dashboard context matching the dashboard to load and display inside this component.
Variable Name: | reference |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
reference | String | Reference |
Default Context
Path of a context that will become the default context for the subdashboard.
Variable Name: | defaultContext |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Default Context |
Content
Indicates that this sub-dashboard component is located in a template dashboard, and will be used to display content from a content dashboard. The Reference property of this sub-dashboard must be empty.
Variable Name: | content |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
content | Boolean | Content |
Load Separately from Parent
Controls whether the sub-dashboard component loads concurrently with the parent dashboard, or waits to load until after the parent dashboard has fully loaded. Can affect dashboard loading speed when many sub-dashboards are being used.
Variable Name: | startupConcurrency |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
startupConcurrency | Boolean |
|
Public Functions
Update Source
Updates the source and/or default context of the sub-dashboard component dynamically.
Function: | updateSource | ||
Input Records: | 1 | ||
Input Format: | Field | Type | Description |
reference | String (nullable) | Target subdashboard reference to set. | |
defaultContext | String (nullable) | Default context to open for the new subdashboard. | |
Output Records: | 0 | ||
Output Format: | — | ||
 | After both fields are updated silently, the controller fires the sourceUpdated event carrying the same values. This operation does not trigger standard variable update events during its execution. |
Public Events
[?]
Common Events: none
Shown
This event fires when a dashboard is displayed by the sub-dashboard component.
Event Name | shown |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
dashboard | String | Path of the dashboard context displayed by the sub-dashboard component. |
Source Updated
Event emitted after the updateSource function successfully updates sub-dashboard values.
Event Name | sourceUpdated |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
reference | String | Applied dashboard reference. |
defaultContext | String | Applied default context. |
Was this page helpful?