Root Panel
Root Panel is the main dashboard container for all other components and containers. |  |
Public Variables (Properties)
[?]
Common variables and variable groups: Name, Advanced Properties, Styles, Preloader, Events, Bindings.
Inherited Variables (Properties)
Root panel component is a container, so it inherits shared container properties.
Layout Width
Layout width for absolute layout, in pixels.
Variable Name: | layoutWidth |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
layoutWidth | Integer | Layout Width |
Current Breakpoint
Indicates the breakpoint which is currently being applied.
Variable Name: | currentBreakpoint |
Records: | 1 |
Record Format:
Field Name | Field Type | Description | |
name | String | Name of the currently active breakpoint | |
description | String | Description of the breakpoint | |
value | Data Table | Value of the breakpoint. Default value is None, which doesn’t create any CSS @media queries and styles should apply at any screen resolution. Custom values can be indicated in pixels. Pixel values can be selected by label from the following table: | |
Label | Breakpoint width | ||
|---|---|---|---|
None | 0px | ||
Mobile | 320px | ||
Tablet | 800px | ||
Laptop | 1366px | ||
Full HD | 1920px | ||
QHD | 2560px | ||
Ultra HD | 3840px | ||
enabled | Boolean | Indicates that the breakpoint is enabled. | |
Default Screen Resolution
Indicates which breakpoint to use by default for the root panel.
Variable Name: | defaultBreakpoint |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
name | String | Name of the breakpoint assigned as default |
Layout Height
Layout height for absolute layout, in pixels.
Variable Name: | layoutHeight |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
layoutHeight | String | Layout Height |
Custom Properties
This variable allows to add custom properties (variables) to the root panel.
Variable Name: | customProperties |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
name | String | Name. Custom property name. |
format | Data Table | Format. Format of custom property. See table format for more information. |
description | String | Description. Custom property description. |
help | String | Help. Custom property help message. |
Bindings
This variable contains all bindings available for the dashboard. See Bindings section for more information.
Variable Name: | bindings |
Records: | 0..unlimited |
Record Format:
Field Name | Field Type | Description |
target | String | Target. Binding target. |
expression | String | Expression. Binding expression. |
activator | String | Activator. Binding activator. |
condition | String | Condition. Binding condition expression. |
onstartup | Boolean | On Startup. If enabled, the binding will be executed when dashboard is fully loaded. See dashboards lifecycle for more information. |
onevent | Boolean | On Event. If enabled, the binding will be executed when event specified in Activator field of Bindings variable is fired. |
periodically | Boolean | Periodically. If enabled, the binding will be continuously executed after the period of time specified in the Period field of Bindings variable. |
period | Long | Period. Time period for periodical binding execution. |
Startup Bindings Concurrency
If enabled, each binding will be processed in separate thread. See binding performance for more information.
Variable Name: | startupBindingsConcurrency |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
startupBindingsConcurrency | Boolean | Startup Bindings Concurrency |
Normal Concurrent Bindings
The maximum number of binding processing tasks under normal circumstances. If more than this number of tasks should start execution, further tasks are getting queued for later execution once execution threads get free.
Variable Name: | normalConcurrentBindings |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
normalConcurrentBindings | Integer | Normal Concurrent Bindings |
Maximum Concurrent Bindings
The absolute maximum number of threads in a binding processing pool. If this maximum number is reached and there are even more tasks to be executed right now, their execution will either fail or block until the pool gets some free resources.
Variable Name: | maximumConcurrentBindings |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
maximumBindingQueueLength | Integer | Maximum Concurrent Bindings |
Maximum Unprocessed Bindings Queue Length
The maximum number of binding processing tasks that can get queues. If queue gets full, additional binding processing threads will be created in the pool until the Maximum Concurrent Bindings limit is reached.
Variable Name: | maximumBindingQueueLength |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
maximumBindingQueueLength | Integer | Maximum Unprocessed Bindings Queue Length |
Show Empty Dashboard Message
Determines whether a message will be shown to users when viewing a dashboard that has no components on it. The behavior is as follows:
True (Default): Displays a message when a dashboard contains no components. This helps users understand the state of the dashboard and encourages them to start adding content.
False: No message is displayed on empty dashboards, resulting in a blank dashboard when no components are present.
Variable Name: | showEmptyDashboardMessage |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
showEmptyDashboardMessage | Boolean | Show Empty Dashboard Message |
Public Events
[?]
Common Events: Mouse Clicked
Shown
This event is fired right after a web dashboard was shown during its startup or after it was retrieved from cache. See dashboard lifecycle for more information.
Event Name | shown |
Records: | 0 |
Invalidated
This event is used during dashboard editing only. It should not be used for controlling normal dashboard operations.
Event Name | invalidated |
Records: | 0 |
Redirected
This event is fired once a redirect operation is executed from a binding.
Event Name | redirected |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
dashboard | String | Path of a dashboard context the redirect operation lead to. |
mode | String | Dashboard operation mode: edit, preview or run. |
historyUrlChanged | Boolean | Defines whether URL in the browser history was changed by the redirect. |
parameters | Data Table | This table includes all parameters provided for the redirect operation call, one parameter per row. |
Action Launched
This event is generated once an action was launched from the dashboard.
Event Name | actionLaunched |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
reference | String | A reference used to launch the action. |
parameters | Data Table | Action's parameters. |
actionId | String | Action's ID. |
Binding Processed
This event is fired once a dashboard binding is successfully processed. Currently, this event is only fired in dashboard preview mode.
Event Name | bindingProcessed |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
timestamp | Date | Processing date/time. |
bindingNumber | Integer | Binding's number within the binding list, effectively binding's ID. |
target | String | Binding target. |
expression | String | Binding expression. |
method | Integer | Binding evaluation method: startup, event, or periodic. |
cause | String | Binding's cause. |
evaluationOptions | String | Binding evaluation options that include binding's activator and condition. |
result | String | Binding evaluation result. |
Binding Error
This event is fired once a dashboard binding is processed with an error. Currently, this event is only fired in dashboard preview mode.
Event Name | bindingError |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
timestamp | Date | Processing date/time. |
bindingNumber | Integer | Binding's number within the binding list, effectively binding's ID. |
target | String | Binding target. |
expression | String | Binding expression. |
method | Integer | Binding evaluation method: startup, event, or periodic. |
cause | String | Binding's cause. |
error | String | Binding error text. |
stacktrace | String | Stack trace of the error. |
Default Context Changed
Fires when the default context of the dashboard is changed, and returns the context path of the new default context as a string.
Event Name | defaultContextChanged |
Records: | 1 |
Record Format:
Field Name | Field Type | Description |
value | String | String representing the context path of the new default context of the dashboard. |
Was this page helpful?