Entity List#

Overview#

The Entity List widget displays a list of instances for a given entity type, such as a Material or a Resource. An example is shown below, where this widget is used to show all the available Resources.

General Steps#

To use the Entity List widget in a UI Page, follow the steps below:

1. In any UI Page in Build mode, select the Entity List from the widgets list located on the left side of the page; drag and drop to the desired place in the UI Page.
2. Enter the Settings section of the widget through the three vertical dots.
3. In the General tab, provide a name and a description for the widget. Use the toggle buttons to specify whether the widget should be visible, display the header, or allow full screen mode. Additionally, determine if the widget can be opened as an image in a new tab or exported as an image.

Widget Customization#

1. Optionally, in the Style tab, you can define a Border Width and Color.

   

2. In the Setup tab, provide the Selection and View mode details:

   • Selection Mode - Select the widget's selection mode: None, Single, or Multiple.
   • Display Mode - Choose how the Entities will be displayed, either in List or Icons mode.
   • Subtitle Property Path - Specify the property path for the subtitle.
   • Auto-Select First Element - Defines whether to automatically select the first item in the list. This option is set to false by default.
   • Keep Selection - Determine whether the selection should be retained when the entities in the list change or when the data source updates. This option is set to false by default.

   In the Data section, you can configure the Entity Type.

   

3. Optionally, define Inputs. You can add as many Inputs as you desire (press in the top right of the wizard to add, and to remove).

   

4. Optionally, define the Links between this widget and other elements of the UI Page.

   

5. By saving and closing the settings, the widget will be changed accordingly.

Real Use Case#

An Entity List widget can be used to present the user with a list of selectable entities and then run a query that uses the user selected entity as parameter. To accomplish this, you should follow the steps below

1. Add a task for the Entity List to the page properties. For the Entity List to start displaying a list, this first has to be made available on the page. The easiest way to do so is to add a Query as task.

   

2. Link the Query to the Entity List widget:

   

3. After saving, the Entity List widget will display a scrollable list of Materials:

   

4. Add any Query (as widget of type Query) to the UI Page that uses as parameter the Material entity and link it to the entity list:

   Note

   To use the an entity parameter in a Query requires the actual database ID to be provided via the link on the UI page. To accomplish this, a string property has to be added to the page:

   

5. This string property can then be used in the link together with the Any To Any Property converter to transfer the ID of the selected entity to the Query.

   LinkConverter

   

   

6. The final result on the UI Page should look like this: