Skip to content
View as markdown Ask ChatGPT Ask Claude

Entity Info#

Overview#

The Entity Info widget displays quick information on a given entity instance, with a primary and a secondary property available to be displayed.

Entity Info widget showing a selected entity and its primary and secondary property values.

General#

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

  1. In any UI Page in Build mode, select the Entity Info 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. You can also select the navigation mode behavior: open a new page, replace the current page, or none.

Entity Info widget general settings page showing the configuration options for a selected entity.

Style#

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

Diagram showing a widget customization interface with options for border width and color.

Setup#

In the Setup tab, provide the Entity Settings:

  • Entity Type - Select the Entity Type to be displayed.
  • Entity - Select the Entity instance to be displayed.
  • Show Entity Icon - Choose if the widget should display the entity icon.
  • Show Entity State Colors - Choose if the widget should display the state color.
  • Entity Icon Size - Choose the size of the entity icon (Small or Large).

Entity Info setup screen for selecting the entity type, instance, icon visibility, and display properties.

Additionally, define a Primary Property and/or a Secondary Property to be displayed, along with the Font and Font Size in which to render them. If the properties selected are not user defined, a dropdown control is available for you to select the Value of the desired property. The secondary property will be enclosed in parentheses. If the user defined flag is set, you can access contextual properties associated to a given Entity (for example, if a Material entity is selected and you want to display the name of the Product, entering Product.Name will display the required value.)

Entity Info property configuration showing the primary and secondary fields and their formatting options.

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

Screenshot showing a widget customization page with links to other UI elements.

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