Lists

Introduction

A list displays multiple system records in a unified visual form. Lists enable you to limit the number of records displayed to create such dashboards as the “Top ten most productive managers by the number of closed deals”, for example. Learn more about the lists in the The “List” dashboard component article. List settings are described in the How to set up the “List” dashboard component article.

Fig. 1. A “list” dashboard

List functional classes

DashboardGridViewModel – list view model.

DashboardGridViewConfig – generates list view configuration.

DashboardGridModule – module designed to work with lists.

DashboardGridDesigner – list editing page schema.

List settings

To configure a list, you need to add the JSON configuration object with list properties to the widget module configuration. The widget module configuration is defined by the Items property of the SysDashboard object. Learn more about the SysDashboard object and its properties in the “Dashboard widgets” article.

Set the “DashboardGrid” value of to the widgetType property in the JSON configuration object with widget settings. In addition, assign the parameters property to the object with necessary parameters. Possible list parameters are listed in table 1.

Table 1. List settings

Name	Type	Details
caption	string	List header.
sectionBindingColumn	string	Section link column.
filterData	object	Filter settings.
sectionId	string	Section id.
entitySchemaName:	string	List object.
style	string	List color.
orderDirection	number	Sorting options (1 - ascending, 2 - descending).
orderColumn	string	List sorting column.
rowCount	number	The number of rows to display.
gridConfig	object	List configuration.