Record Table

A Record Table widget presents a table of specific records as defined in the configuration. It helps our users to display their desired records on the dashboard.

Configure the Record Table Widget

When configuring an Record Table widget from the UI, you can specify the following settings.

Property	Description
`type`	Specifies the widget type as a record table widget.
`record`	Specifies the record type used as the table's data source.
`title`	Provides a heading for the table.
`titleStyle`	Defines the styling of the table heading, including font size, font weight, colour, and icon.
`filter`	Specifies the filter used to narrow the records displayed in the table.
`savedFilter`	Specifies a saved filter to apply to the table.
`sortBy`	Specifies the field used to sort the records.
`sortOrder`	Specifies the sort order, such as ascending or descending.
`portalKey`	Specifies the portal key used to determine the portal context for the table.
`columns`	Specifies the columns displayed in the table and their settings. 📘 Associated record columns You can also add columns from records joined to the current record. These associated record fields are shown separately when you configure your table.
`showHeader`	Indicates whether to display the table header.
`fixedHeader`	Indicates whether the table header stays fixed in place at the top of the widget while its rows are scrolled. Defaults to false.
`headerAlignment`	Specifies the alignment of the table header.
`colorCodeRows`	Indicates whether to colour-code table rows based on configured values.
`rowsPerPage`	Specifies the default number of rows displayed per page.

JSON Example

The following JSON produces the same configuration shown in the UI.

{
  "type": "record-table",
  "config": {
      "record": "backlog-items",
      "title": "Backlog items",
      "titleStyle": {
          "fontSize": "extralarge",
          "fontWeight": "light",
          "color": "default",
          "icon": "default"
      },
      "colorField": "status",
      "showHeader": true,
      "columns": [
          {  "field": "title","alignment": "left", "width": 200, "minWidth": 200},
          { "field": "date-opened", "alignment": "left" },
          { "field": "team", "alignment": "left" },
          { "field": "scope-status", "alignment": "left" }
      ],
      "order": {
          "id": "date-opened"
      },
      "savedSearchId": 292427,
       "filter": [
                      {
                        "subject": 9854,
                        "type": "array",
                        "operator": "any_of",
                        "value": [
                          "248050"
                        ]
                      }
                    ],
      "maxEntries": 5
  }
}

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.