Entities table
Displays a list of entities that match the selected alias and optional filter. Provides the ability for full-text search and pagination, except for columns with post-processing or cell content functions. Highly customizable using widget styles, data source keys, and widget actions.
Who it’s for
Anyone who needs the fleet as a list — every device on a site with its key readings, every asset in a group with its status, filtered and searchable. The table is the index a dashboard is built around, and clicking a row is usually how the rest of it gets driven.
What it does
The Entities table lists the entities an alias resolves to, one row each, with a column per data key. Columns can carry entity fields, attributes and telemetry together, so a device’s name, its location attribute and its latest temperature sit on one row, with full-text search and pagination over the result.
- The alias defines the list, so the same table serves a site, a group or a filtered subset without being rebuilt.
- Columns mix entity fields, attributes and telemetry, which is what makes one row a complete summary of a device.
- Full-text search and pagination work server-side, which is what keeps the table usable on a large fleet.
- Row actions and widget actions turn the table into navigation — clicking a row can drive the rest of the dashboard.
- A row style function colors rows from their own values, so an outlier is visible without being read.
- Column display can be chosen by the reader, so one table serves people who need different subsets.
- The Entities table’s search and pagination do not cover columns using post-processing or cell content functions, so a computed column is displayed but not searched or sorted on.
How to set up
Data keys
The Entities table takes one column per data key.
| Key | Role | Type | Description |
|---|---|---|---|
Entity name | One column | Entity field | Entity fields such as name, label and type are available as keys. |
| Any telemetry key | One column | Timeseries | Attributes work equally well and can be mixed in. The key’s label is the column heading. |
Point the alias at the set the table is meant to list, then add only the columns a reader actually needs. Every additional key is fetched for every row, and a wide table on a large fleet is noticeably slower than a narrow one.
Table
| Setting | Default | Effect |
|---|---|---|
| Entities table title | Entities | The caption above the table |
| Default sort order | displayName | Which column the table opens sorted by |
| Enable search | On | Full-text search across the rows |
| Enable select columns to display | On | Lets the reader hide and show columns |
| Display entity name / label / type column | Off | Adds those built-in columns |
| Always display header | On | Keeps the header visible while scrolling |
| Display pagination | On | Shows the pager, with configurable page size and steps |
How to customize
- To highlight rows needing attention — turn on Use row style function and return styling from the row’s own values.
- To name the columns for readers — edit each data key’s label, which is the column heading.
- To add the built-in identity columns — turn on Display entity name, label or type.
- To make the table drive the dashboard — add a row action that opens a state for the clicked entity.
- To fit the tile — set the Default page size and the page step settings.
- To open on what matters — set the Default sort order to the column that ranks rows by urgency.
- To simplify a fixed board — turn off search and column selection.
Tips
- Sort by the column that answers “which one first” rather than by name. A fleet table sorted alphabetically is a directory; the same table sorted by last-reported-time is a work list.
- Avoid cell content functions on columns readers will want to search or sort. Those columns display correctly and are excluded from both, and a search that silently ignores a column is worse than one that is obviously unavailable.
Share Your Widget with the Community
Built a custom widget? Export it as a JSON from ThingsBoard and publish it to the IoT Hub through a simple 4-step wizard (Upload, Listing, Readme, Review & Submit). Share it with thousands of ThingsBoard developers worldwide and get featured in the catalog.