Dashboard Properties
Dashboard's Properties table defines basic options of a dashboard. Those options significantly differ for web and desktop dashboards.
These properties may be accessed via the childInfo variable.
Web Dashboard Properties
Settings of web dashboards are explained below.
Field Description | Field Name | |
Name. Name of the dashboard context, required to refer to this dashboard from other parts of the system. It should satisfy the context naming conventions. | name | |
Description. Textual description of the dashboard. This is also the description of the dashboard context. | description | |
Destination. Set to Web in this case. | destination | |
Type. Type of the dashboard: Absolute, Relative, or Class Instance. | type | |
Storage Context. Indicates a Class associated with the dashboard. Applicable only to Class Instance dashboards. | storageContext | |
Table. Indicates the storage table of the Class associated with the dashboard. Applicable only to Class Instance dashboards. | storageClass | |
Validity Expression. Determines which context(s) may be "understood" by the dashboard. See Resource Validity for more information. | validityExpression | |
Validity Update Rules. A list of context masks and event names. If event specified by Event field of this table occurs in any context matching the mask specified by Mask field in the same record, Validity Expression will be recalculated for this context. This allows the dashboard to be validated or invalidated for a certain context if some changes occur in it. | validityListeners | |
Allow Validity For Remote Contexts. When the flag is enabled, the dashboard can be attached not only to local contexts, but also to remote contexts connected over distributed architecture. | allowValidityForRemoteContexts | |
Launch as Default Action. Applies to Relative dashboards. When enabled, the Open Dashboard Action will become the default action for any context which the dashboard is attached to. | launchAsDefault | |
Template Processing Expression. This expression is evaluated during dashboard startup. It accepts dashboard's elements table as the default table. The expression is supposed to modify elements table (which effectively constitutes dashboard template) on-the-fly and return updated version. | templateProcessingExpression | |
Template Processing Expression Resolution Environment: | ||
|---|---|---|
Context for which the relative dashboard is being opened. | ||
Dashboard's elements table. | ||
0 | ||
Standard variables only. | ||
Template. Indicate a dashboard context containing a sub-dashboard component with an undefined Reference property and the Content property set to | template | |
Enable Caching. Enables caching for this dashboard. This option will only have effect if caching is enabled in Web UI plugin global configuration. | cacheEnabled | |
Header Expression. This expression is evaluated during dashboard startup. It accepts dashboard's elements table as the default table. If the expression returns a string, the string is set as the dashboard’s header. | headerExpression | |
Header Expression Resolution Environment: | ||
Context for which the relative dashboard is being opened. | ||
Dashboard's elements table. | ||
0 | ||
Standard variables only. | ||
Desktop Dashboard Properties
Settings of desktop dashboards are explained below.
Field Description | Field Name | |
Name. Name of the dashboard context, required to refer to this dashboard from other parts of the system. It should satisfy the context naming conventions. | name | |
Description. Textual description of the dashboard. This is also the description of the dashboard context. | description | |
Title Expression. Dashboard title that appears on the top of the dashboard window. If a title is not specified, its Description is used instead. Title can be a plain string or an expression. If it's an expression, it's evaluated into a string to allow titles of relative dashboards display values from contexts whose data is displayed on dashboard.
| title | |
Title Expression Resolution Environment: | ||
|---|---|---|
Context for that a relative dashboard is opened. | ||
None. | ||
0 | ||
Standard variables only. | ||
Layout. Dashboard layout, dockable or scrollable. | layout | |
Column Count. Number of columns, relevant for scrollable dashboards only. | columns | |
Type. Type of the dashboard: Absolute or Relative. | type | |
Validity Expression. Determines which context(s) may be "understood" by the dashboard. See Resource Validity for more information. | validityExpression | |
Validity Update Rules. A list of context masks and event names. If event specified by Event field of this table occurs in any of context matching to the mask specified by Mask field in the same record, Validity Expression will be recalculated for this context. This allows to make dashboard valid/invalid for a certain context if some changes occur in it. | validityListeners | |
Allow Validity For Remote Contexts. When the flag is enabled, the dashboard can be attached not only to local contexts, but also to remote contexts connected over distributed architecture. | allowValidityForRemoteContexts | |
Closable. Defines whether the dashboard can be closed. Non-closable dashboards often play role of main dashboards in a custom operator UI. | closable | |
Close Dashboard On Reopen. Defines whether the dashboard will be closed before reopening.
| closeDashboardOnReopen | |
Launch via Manage Action. Defines whether the dashboard will open by a "Manage Node" action, e.g. Manage Device action. | launchViaManage | |
Layout Control Panel. This flag defines the visibility of the bottom panel (Save/Load layout and other buttons). | layoutControlPanel | |
Example: Assuming we are creating a dashboard that shows device power status, we may set Title Expression to 
Using Was this page helpful?