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

Startup Concurrency

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

  • True - Load sub-dashboard without waiting for other components to load. When there are few sub-dashboards, the component will be displayed when ready. In cases where there are many sub-dashboards in the parent dashboard, this can result in race conditions while loading sub-dashboards and result in performance loss.

  • False - Load sub-dashboard within the parent dashboard, and when the parent dashboard is ready this sub dashboards will be displayed. Can result in performance improvements when many sub-dashboards are in the parent dashboard.

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.

Was this page helpful?