# Summary Chart

This widget displays graphs of summaries provided by the platform.

## How it works

{{< staticImage "ux/SummaryCharts/Widget/SummaryChartWidget.png" "Summary Chart widget" >}}

This widget facilitates the graphical visualization of summarized data.

Data can be displayed graphically, in table form, or both simultaneously.

### Widget Menu

{{< staticImage "ux/SummaryCharts/Widget/SummaryChartWidgetActions.png" "Summary Chart Actions" >}}

From this section, the following actions can be performed:

{{% ux-widget-menu-actions %}}

### Widget Filter

{{< staticImage "ux/SummaryCharts/Widget/SummaryChartWidgetFilter.png" "Summary Chart Filters" >}}

With the filter, one can narrow down the number of results and obtain new metrics.

There are three types of filters: basic, advanced, or linked.

- **Basic** allows the entry of any text and will filter by predetermined fields.
- **Advanced** allows configuring a custom filter based on the displayed graph.
- **Linked** ties the filter with that of another compatible widget, inheriting its query and refreshing both simultaneously.

## Configuration

{{% ux-widget-configuration %}}

- **Summary type** allows selection among different types of summaries.
- **Summary format** specifies the type of representation: graphical, table, or mixed (both simultaneously).
- **Table position** allows specifying the table’s position in mixed mode.
- **Legend** enables or disables the display of graph legends and their position.
- **Columns number** tells the widget into how many columns the graphs should be distributed.
- **Style pie chart** instructs the widget whether to display pie charts in donut format or regular (no format).

{{< staticImage "ux/SummaryCharts/Configuration/SummaryChartConfigGeneral.png" "Summary Chart General Configuration" >}}

Finally, one must configure the data streams to summarize. The following must be indicated for each:

- **Column 1** specifies the type of graph to represent for the selected data stream.
- **Column 2, field** allows choosing a field within a complex data stream.
- **Column 3, alias** allows specifying the name of the data stream on the graph.
- **Formatter tool** is a tool that allows formatting and altering the information returned by the platform to meet specific needs.
- **Remove** will remove the column from the configuration.

When the _summary type_ is "Entities Values," additional configuration parameters will be activated. This is because this option calculates graph data based on a sample of the overall entities.

{{< staticImage "ux/SummaryCharts/Configuration/SummaryChartConfigEntitiesValues.png" "Summary Chart Entities Values summary" >}}

The global _chart type_ field will be activated, and a new panel appears where the following will be configured:

- **Generated summary title** is the name to display on the generated graph.
- **Statistics: count strategy** specifies the operation to perform on the read data: total, median, mean, maximum, minimum, variance, and standard deviation.
- **Statistics: max samples** specifies the number of samples to take for generating the graph.

The list of data streams will indicate on which data the indicated count strategy will act.

### Advanced

From here, internal filters that would always apply regardless of user actions can be configured.

{{< staticImage "ux/SummaryCharts/Configuration/SummaryChartConfigAdvanced.png" "Summary Chart Advanced" >}}

- **Private filter** will always execute unless there is a _template filter_.
- **Template filter** allows configuring a filter that will overwrite the private one when the dashboard opens in a temporary template.
- **Share filter** tells the widget to share the private/template filter when this widget is selected in another widget via _linked filter_.

{{% children sort="weight" depth="10" %}}

---