Metrics

The “Metric” dashboard (Fig. 1) displays the number (or date) received by inquiring system data, for example, a total number of company’s employees. Learn more about analytics in the “The “Metric” dashboard component” article. Analytics settings are described in the “Setting up the “Metric” dashboard component” article.

(Fig. 1). A “metric” dashboard

Functionality implementation classes of the “Metric” dashboard

IndicatorViewModel – metric view model.

IndicatorViewConfig – generates the configuration of the metric view model.

IndicatorModule – a module designed to work with metrics.

IndicatorDesigner – view model schema of the metric edit page.

Metric settings

To configure a metric, you need to add the JSON configuration object with Metric 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 “Metric” value 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 metric parameters are listed in table 1.

Table 1. Metric settings

Name	Type	Details
caption	string	Metric header
sectionId	string	Section id.
entitySchemaName:	string	Metric object.
sectionBindingColumn	string	Section link column.
columnName	string	Name of aggregating column.
format	object	Metric format.
filterData	object	Filter settings.
aggregationType	number	Type of aggregating function.
style	string	Metric color.