Common Container Properties

This section lists and describes properties shared by most dashboard containers.

Resizable

If enabled, allows to resize components added to this container changing column and row numbers they occupy in the grid.

Variable Name:	resizable
Records:	1

Record Format:

Field Name	Field Type	Description
resizable	Boolean	Resizable

Movable

If enabled, allows to move components added to this container changing their position in the grid.

Variable Name:	movable
Records:	1

Record Format:

Field Name	Field Type	Description
movable	Boolean	Movable

Row Height

Height of single row in grid, in pixels.

Variable Name:	rowHeight
Records:	1

Record Format:

Field Name	Field Type	Description
rowHeight	Integer	Row Height

Background Image

Image to be displayed in the container behind all other elements.

Variable Name:	backgroundImage
Records:	1

Record Format:

Field Name	Field Type	Description
imageType	Integer	Choose whether to use data from the imageData field or the imageURL field. 0 - Image Data 1 - URL
imageData	Data Block	Image data.
imageUrl	String	Image URL.

Gap

Defines cell grid line width, in pixels.

Variable Name:	gap
Records:	1

Record Format:

Field Name	Field Type	Description
gap	String	Gap

Show Grid Background

Configures display of grid cells. This property has several selection values:

None
Rows
Columns
Rows And Columns

Variable Name:	showGridBackground
Records:	1

Record Format:

Field Name	Field Type	Description
showGridBackground	String	Show Grid Background

Grid Type

The grid type defines the dashboard behaviour when content do not fit into the screen. This property has two selection values:

Dockable - a dashboard content will be fit to the browser screen
Scrollable - a vertical scroll bar will appear when content overflows screen

Variable Name:	gridType
Records:	1

Record Format:

Field Name	Field Type	Description
gridType	String	Grid Type

Layout

Defines container layout type. This property has three selection values:

Grid - see grid layout for more information
Absolute - see absolute layout for more information
Dockable - see dockable layout for more information

Variable Name:	layout
Records:	1

Record Format:

Field Name	Field Type	Description
layout	String	Layout

Grid Step

Applicable when the Snap to Grid property is enabled. Indicates the number of pixels between each column and row of the snap-to grid.

Variable Name:	gridStep
Records:	1

Record Format:

Field Name	Field Type	Description
gridStep	String	Grid Step

Snap to Grid

Available in containers configured with Absolute layout. When enabled, overlays an invisible snap-to grid on the canvas, and components positioned in the container will automatically be aligned with the nearest horizontal and vertical lines of the snap-to grid. The size of the snap-to grid is determined by the Grid Step property.

Variable Name:	snapToGrid
Records:	1

Record Format:

Field Name	Field Type	Description
snapToGrid	Boolean	Snap to Grid

Grid Columns Information

This variable describes number of grid columns and their size.

Variable Name:	gridCols
Records:	0..unlimited

Record Format:

Field Name	Field Type	Description
template	String	Template. The numeric value of the grid column size.
unit	String	Unit. Measure unit, in fr (frames) or px (pixels).

Grid Rows Information

This variable describes number of grid rows and their size.

Variable Name:	gridRows
Records:	0..unlimited

Record Format:

Field Name	Field Type	Description
template	String	Template. The numeric value of the grid row size.
unit	String	Unit. Measure unit, in fr (frames) or px (pixels).

Top Indent

Container top indent, in pixels (e.g. 10px).

Variable Name:	indentTop
Records:	1

Record Format:

Field Name	Field Type	Description
indentTop	String	Top Indent

Bottom Indent

Container bottom indent, in pixels (e.g. 10px).

Variable Name:	indentBottom
Records:	1

Record Format:

Field Name	Field Type	Description
indentBottom	String	Bottom Indent

Left Indent

Container left indent, in pixels (e.g. 10px).

Variable Name:	indentLeft
Records:	1

Record Format:

Field Name	Field Type	Description
indentLeft	String	Left Indent

Right Indent

Container right indent, in pixels (e.g. 10px).

Variable Name:	indentRight
Records:	1

Record Format:

Field Name	Field Type	Description
indentRight	String	Right Indent

Layout Storage

Determines how dockable layouts should be persisted between users and user sessions. Applies only to containers with dockable layout.

Variable Name:	layoutStorage
Records:	1

Record Format:

Field Name

Field Type

Description

layoutStorage

String

Options for storing dockable layouts:

Shared: The layout will be shared between users. If one user makes a change to the layout, this will be applied to all users.
For Every User: Each user will have their own layout saved, which will persist between sessions.
For Every Login: The dashboard layout will be persisted during a single session, but when the user logs out, the layout will return to the default.
Do Not Store: The layout will revert to its default each time the user navigates away from the dashboard.

Dock Layout Structure

This table defines the structure of a dockable layout, outlining the properties of each element within the layout. Applies only to containers with a dockable layout.

Variable Name:	dockLayoutStructure
Records:	0…Unlimited.

Record Format:

Field Name	Field Type	Description
id	String	Unique identifier for the element.
parentId	String	ID of the parent element.
orderId	Integer	Order of the element within its parent container.
mode	String	The mode of the element (e.g., 'dock', 'float').
size	Integer	Size of the element.
x	Double	X-coordinate of the element (for floating elements).
y	Double	Y-coordinate of the element (for floating elements).
z	Integer	Z-index of the element (for floating elements). Elements with a larger Z-index will obscure elements with a lower Z-index.
h	Integer	Height of the element (for floating elements).
w	Integer	Width of the element (for floating elements).
dockLocationParentId	String	If this element was previously docked, this is the ID of the panel it was docked to before it became a floating element.
dockLocationTabIndex	Integer	If this element was previously docked as a tab, this is its index within the parent tab container before it became a floating element.
dockLocationPanelIndex	Integer	If this element was previously docked as a panel, this is its index within the parent panel container before it became a floating element.

Dynamic Contents

The Dynamic Contents group of properties govern the automatic generation and modification of component layouts and content within the container. See the Containers with Dynamic Content for a guide on how to get started with dynamic content.

Enable Dynamic Contents

Enables the creation of dynamic contents within the container. The container must contain exactly one component (or a hierarchy of components with a single root component). This component/hierarchy will be replicated for each row in the Dynamic Contents table.

Variable Name:	dynamicContentsEnabled
Records:	1

Record Format:

Field Name	Field Type	Description
dynamicContentsEnabled	Boolean	When enabled, the single component tree in the container will be replicated once for each row of the Dynamic Contents table.

Static Format

When True, the format of the Dynamic Contents data table will be defined by the Format property. When both Static Format is enabled and the Format property is defined, data can be entered in the Dynamic Contents data table via the properties editor.

Variable Name:	dynamicContentsUseStaticFormat
Records:	1

Record Format:

Field Name	Field Type	Description
dynamicContentsUseStaticFormat	Boolean	Static Format

Format

Defines the format of the Dynamic Contents data table. When both Static Format is enabled and the Format property is defined, data can be entered in the Dynamic Contents data table via the properties editor.

Variable Name:	dynamicContentsFormat
Records:	1

Record Format:

The same as Table Format.

Dynamic Contents

When Enable Dynamic Contents is true and there is a single component in the container, this component with all its subcomponents will be replicated in the container once per every row in the Dynamic Contents data table. Data from each row of the Dynamic Contents data table is available in each dynamically created component, and the cell value of a given field can be referenced by the variable reference {fieldName}, while the index of the current row can be referenced as {#row}.

Except when being initialized by a startup binding, the Dynamic Contents property should only be changed after the Dynamic Contents Refreshed event has fired for the container. Updating the Dynamic Contents property before all components have been refreshed can introduce conflicts to the dynamic container.

In practice, this means that:

The initial value of Dynamic Content must be provided via an On Startup binding.
Successive updates to Dynamic Content must come only after the Dynamic Contents Refreshed event has been received for the previous update. This can be achieved by triggering updated bindings with the binding property On Event set to True, and the Activator property set to dynamicContentsRefreshed.

Variable Name:	dynamicContentsSource
Records:	0…Unlimited

Record Format: dynamic

Component Name Suffix Expression

An expression used to generate custom suffixes for the names of dynamically created components. By default the contexts are named <originalComponentName>{#row}.

Variable Name:	dynamicContentsSuffix
Records:	1

Record Format:

Field Name	Field Type	Description
dynamicContentsSuffix	String	Must evaluate to a string
		Component Name Suffix Expression Resolution Environment:
		Default Data Table	Dynamic Contents
		Default Context	None.
		Default Row	Currently processed row of the default table.
		Environment Variables	Standard variables only.

Positioning

Indicate whether the dynamic content will be automatically positioned in the container, or whether data from the Dynamic Contents table will be used to specify the position of each component in the container.

Variable Name:	dynamicContentsPositioning
Records:	1

Record Format:

Field Name

Field Type

Description

dynamicContentsPositioning

string

Possible selection values are:

Automatic - Indicates that dynamic content will be positioned automatically, depending on the container type:
- Grid layout: Components are cloned from left to right and from top to bottom, expanding the grid vertically if needed.
- Absolute layout: Components are cloned in a cascade.
- Dockable layout: Cloned components are placed along the main horizontal or vertical plane.
Manual - Indicates that the location of each instance of the dynamic content will be manually specified by bindings targeting the layout properties of the dynamic content. If no such bindings exist, the cloned components will be placed on the same position overlapping each other.

Items Per Page

Number of dynamically created containers to display per page. If the number of dynamically created components exceeds this number, a paginator appears in the container, otherwise the components are displayed without pagination. Each page contains a unique set of components.

Variable Name:	pageSize
Records:	1

Record Format:

Field Name	Field Type	Description
pageSize	Integer	Initial number of items to display per page.

Show ‘Items Per Page’ Selector

Gives the user the option to select the number of items to display per page, with selection values taken from Custom ‘Items Per Page’ Selection Values.

Variable Name:	showPageSizeSelector
Records:	1

Record Format:

Field Name	Field Type	Description
showPageSizeSelector	Boolean	Enables combo box or button group selector to the user, allowing them to choose the number of items to display per page.

‘Items Per Page’ Selector Type

Indicate what kind of selector to display to the user, allowing them to select the number of items to display per page.

Variable Name:	pageSizeSelectorType
Records:	1

Record Format:

Field Name

Field Type

Description

pageSizeSelectorType

String

Selection options:

Combo Box - displays the ‘Items per Page’ selector as a combo box
Button Group - displays the ‘Items per Page’ selector as a button group.

Custom ‘Items Per Page’ Selection Values

Indicate what values of ‘Items Per Page’ will be offered to the user when Show ‘Items Per Page’ Selector is enabled.

Variable Name:	pageSizeOptions
Records:	0…Unlimited

Record Format:

Field Name	Field Type	Description
value	Integer	Selection value for ‘Items Per Page’ selector

DPF_EXPORT_V5.8.8 / TIME_1743710540 / 2025-04-03 20:02:20 / STRLEN_40661 / STRLEN_HTML_44866

{VERSION}

Was this page helpful?