---
tags:
- UI Page widgets
alias: user-guide-uipage-widgets-entity-info
widgetname: Entity Info
description: "This documentation details configuring a widget to display entity information and customizable properties"
---

# Entity Info

![entityInfoIcon][entityInfoIcon]

## Overview

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

![entityInfoView][entityInfoView]

## General Steps

{% include-markdown 'includes/pages/ui_widgets_general_steps_with_behavior.md' %}

![entityInfoGeneral][entityInfoGeneral]

## Widget Customization

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

    ![Diagram showing an Entity Info Style widget customization settings.](images/entity_info_style.png)

2. 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).

    ![entityInfoSetup][entityInfoSetup]

    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 (e.g., if a Material entity is selected and you want to display the name of the Product, entering `Product.Name` will display the required value.)

    ![entityInfoProperties][entityInfoProperties]

3. 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.](images/entity_info_links.png)

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

[entityInfoIcon]: images/entityinfo_icon.png
[entityInfoView]: images/entityinfo_view.png
[entityInfoGeneral]: images/entityinfo_general.png
[entityInfoSetup]: images/entityinfo_setup.png
[entityInfoProperties]: images/entityinfo_properties.png