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.

Breakpoints

List of dashboard's breakpoints used for responsive rendering. Each breakpoint is defined by a certain screen width. Every dashboard component can have a list of its styles and property values applied at every breakpoint. Property value defined for "None" breakpoint are applied at screen width higher than defined by any other breakpoint.

Variable Name:	breakpoints
Records:	1...unlimited

Record Format:

Field Name	Field Type	Description
name	String	Name of the breakpoint which is the breakpoint's unique ID that is later selected via Current Breakpoint property
description	String	Human-readable description of the breakpoint. It's used to select the breakpoint in the Web UI Builder's top toolbar during the editing process.
value	String	Maximum screen width in pixels at that the breakpoint is applied. There are some predefined selection values to simplify the choice:
		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.

Current Breakpoint

Name of the dashboard's active breakpoint. Must match a name defined in the Breakpoints table. During dashboard editing, this property is auto-adjusted when a breakpoint is selected from the Web UI Builder's top toolbar. During dashboard normal operation, this property is auto-adjusted when the dashboard is started and when the browser window is resized.

Variable Name:	currentBreakpoint
Records:	1

Record Format:

Field Name	Field Type	Description
name	String	Name of the currently active breakpoint

Default Breakpoint

Name of a breakpoint (as defined in Breakpoints table) that will be used to define styles and property values for a component that doesn't define custom styles and property values for breakpoint specified in Current Breakpoint property. Normally, this property points to None breakpoint. Note, that if a component don't have styles and property values pointed by both Current Breakpoint and Default Breakpoint, the component is completely hidden from the dashboard.

Variable Name:	defaultBreakpoint
Records:	1

Record Format:

Field Name	Field Type	Description
name	String	Name of the breakpoint assigned as default

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. This number must not exceed the maximum number of concurrent bindings. Higher values are automatically clamped to the maximum.

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. By default, this limit is set to 100.

Variable Name:	maximumConcurrentBindings
Records:	1

Record Format:

Field Name	Field Type	Description
maximumConcurrentBindings	Integer	Maximum Concurrent Bindings

Maximum Unprocessed Bindings Queue Length

The maximum number of binding processing tasks that can get queued. If the 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

Page Settings

Contains page configuration used for Printable Dashboard rendering. It is used in printable page settings. For an overview of printable dashboards, see Printable Dashboards.

Variable Name:	pageSettings
Records:	1

Record Format:

Field Name	Field Type	Description
pageFormat	String	Paper format. Page size is resolved by the system from the selected format. The Page Width and Page Height values are automatically updated when the format changes. The Custom format allows setting the page dimensions manually in the Page Width and Page Height fields. Default: `A4`. Supported values:
		Format	Width, cm	Height, cm
		A0	84.1	118.9
		A1	59.4	84.1
		A2	42.0	59.4
		A3	29.7	42.0
		A4	21.0	29.7
		A5	14.8	21.0
		A6	10.5	14.8
		B4	25.0	35.3
		B5	17.6	25.0
		Letter	21.59	27.94
		Legal	21.59	35.56
		Tabloid	27.94	43.18
		Custom	user-defined	user-defined
orientation	Integer	Page orientation. Supported values: `0` - Portrait `1` - Landscape.
pageWidth	Integer	Page width in pixels. Automatically calculated from the selected paper format. Set manually when the Custom format is selected.
pageHeight	Integer	Page height in pixels. Automatically calculated from the selected paper format. Set manually when the Custom format is selected.
scaleMode	Integer	Scaling mode applied to the dashboard when printing. Supported values: `0` - Normal (no scaling, default) `1` - Fit to Width `2` - Fit to Height `3` - Fit to Page `4` - Custom Number (the scale percentage is taken from the scalePercent field).
scalePercent	Integer	Custom scale percentage. Used when scaleMode is set to `4`.
marginLeft	Integer	Left page margin in pixels.
marginRight	Integer	Right page margin in pixels.
marginTop	Integer	Top page margin in pixels.
marginBottom	Integer	Bottom page margin in pixels.
dataset	Data Table	DataTable assigned to the printable dashboard. Components inside band bindings can reference columns by short name: `{columnName}` resolves to the dataset column at the current row (row 0 for Summary and other no-row contexts; the per-row index for Detail clones). Use `{columnName[N]}` to read an explicit row. Data table assigned to the printable dashboard. Components within band bindings can reference columns by their short names. For example, `{columnName}` resolves to the value of the specified column in the current row: row `0` for Summary bands and other contexts without a current row, or the corresponding row for each Detail band instance. Use `{columnName[N]}` to reference a specific row explicitly. Default: empty.
summaryNewPage	Boolean	If enabled, the Summary band always starts on a new page after Detail content. Default: disabled.
summaryWithPageHeaderFooter	Boolean	If enabled, dedicated Summary pages repeat the Page Header and Page Footer bands. Default: disabled. Dedicated Summary pages contain only the Summary band itself.

Printable

This property indicates that the current dashboard is in printable mode.

Variable Name:	printable
Records:	1

Record Format:

Field Name	Field Type	Field Description
printable	Boolean	Indicates that the current dashboard is in Pprintable mode.

Public Functions

[?]

Page Sizes From Format

This function converts a paper format code into page dimensions. It is used in printable page settings. For an overview of printable dashboards, see Printable Dashboards.

Function Name:	pageSizesFromFormat
Permissions:	Accessible at Operator permission level
Input Records:	1
Input Format:	Name	Type	Description
Input Format:	pageFormat	String	Paper format code. Supported values include `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `B4`, `B5`, `Letter`, `Legal`, `Tabloid`, and `Custom`. The value is used to resolve printable page dimensions.
Output Records:	1
Output Format:	Name	Type	Description
	pageWidth	Integer	Page width in pixels.
	pageHeight	Integer	Page height in pixels.

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.
newTab	Boolean	Indicates whether the redirect operation was configured to open in a new browser tab. Default value is `False`.
download	Boolean	Indicates whether the redirect operation was configured to download the resource at the redirect URL instead of navigating to it. Default value is `False`.
parameters	Data Table	This table includes all parameters provided for the redirect operation call, one parameter per row.
componentLocation	Data Table	Indicates the component location applied to the dashboard when it was opened. Fields are defined in Component Location.

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.

DPF_EXPORT_V5.8.8 / TIME_1787752621 / 2026-08-26 13:57:01 / STRLEN_92615 / STRLEN_HTML_73609

{VERSION}

Was this page helpful?