Data Grid

Last update: Edit

1 Introduction

shows a list of objects in a table format. For example, a data grid can show customer’s name, grade, and all the orders a customer has placed:

Using controls provided by the data grid you can browse, search, and edit those objects.

2 Components

A data grid contains the following components:

  • Columns – allows you to set properties for a data grid column
  • Control bar – allows you to control the objects displayed in the data grid by means of buttons
  • Search bar – allows end-users to search for objects in the data grid
  • Sort bar – allows you to sort items in the data grid

3 Properties

An example of data grid properties is represented in the image below:

Data grid properties consist of the following sections:

3.1 Common Section

For more information on properties of this section, see the Common Section section in Properties Common for Widgets.

3.2 Data Source Section

The data source determines which objects will be shown in a list view. For general information on data sources, see Data Sources.

3.2.1 Type

The list view supports the following types of data sources:

The database and XPath sources retrieve objects from the database and supports searching and sorting.

3.3 General Section

3.3.1 Show Control Bar Buttons

This property indicates whether the control bar buttons will be visible in the end user interface.

Default value: True

3.3.2 Show Paging Buttons

This property indicates with the buttons to page through the information in the grid are visible. Only hide these buttons if you are sure that there will never be more objects than the number of rows of the grid.

Default value: True

3.3.3 Number of Rows

With this property you can change the number of rows that will be shown in one page. See also the property ‘Show empty rows’.

Default value: 20

3.3.4 Show Empty Rows

If you choose to show empty rows there will always be the grid will always show the same number of rows (see ‘Number of rows’) even if there are less objects to show on the page.

Default value: False

3.3.5 Selection Mode

The selection mode determines whether and how the user can select items in the grid.

Value Description
No selection The user cannot select items.
Single selection The user can select a single item by clicking on it. Clicking another item will make that item the selection.
Single selection and maintain The user can select one item at a time by clicking on it. Users cannot deselect an item. By default the first item will be selected and removing a selected item will autoselect a subsequent item.
Multi-selection The user can select multiple items by clicking the first one and holding the ‘Ctrl’ key while clicking on other items. Simply clicking an item will deselect all items and make the clicked item the selection.
Simple multi-selection The user can select multiple items by simply clicking on them. This was the default multi-selection behavior prior to version 3.1.0.

Default value: Single selection

3.3.6 Select First

This property indicates whether the first item will be selected initially. This is especially useful if there is a data view listening to this grid.

Default value: False

3.3.7 Default Button Trigger

The default button can be triggered by a single or a double click on a row.

Value Description
Single click A single click triggers the default button. This cannot be used in combination with allowing the user to select rows.
Double click A double click triggers the default button.

Default value: Double click

3.3.8 Refresh Time (in Seconds)

If the refresh time is non-zero, the data grid will refresh its contents every given number of seconds. For example, a task list could be refreshed every minute so that you know when new tasks arrive. By default the refresh time is zero and this means that the grid will not automatically refresh itself.

Default value: 0

3.3.9 Tooltip Page

A tooltip page is a page that appears when you hover your mouse over a row. The tooltip page should consist of a data view on the same entity as the data grid. Besides creating and connecting a tooltip page you also have to specify on which columns the tooltip will appear. See the property ‘Show tooltip’ of data grid columns.

3.4 Visibility Section

Visibility determines whether a widget is displayed to the end-user as part of the page.

For more information on properties of this section, see the Visibility Section section in Properties Common for Widgets.

4 Performing Specific Actions

To perform actions on a data grid, select it on a page and right-click it. The list of possible actions opens. While some actions from this list, such as Select data source, Edit condition for visible, are a quick way to set the properties, the following actions are specific actions that you can perform:

  • Go to entity – opens a domain model and highlights an an entity that is used as the data source
  • **Go to data source microflow **– this action is only displayed when a microflow is set as the data source and opens this microflow
  • Go to tooltip page – opens a page select as the tooltip page in properties

5 Read More