The "Integral" component allows you to calculate and visualize the cumulative values of a metric, such as consumption or flow, over a given period.
To illustrate how it works, let’s take the example of real-time electrical consumption. We want to calculate the daily electrical consumption and then convert it into euros to determine the cost.
General Information
Start by providing the necessary general information to configure the component:
Title : Give a title to your component.
Description (optional) : Add details to clarify the context of the component.
Time interval of the data involved :
If you wish to apply a time offset between the time range selected for the entire dashboard and the period for the component, you can enter a time offset value here. For further details, please refer to the dedicated section.
Alternatively, if you want to apply a completely different time range to the component, ignoring the one selected for the dashboard, you can use the "Lock" button.
The "Lock" button allows you to override the global dashboard time range and force this component to always use its own specific period.
To do this, click the "Lock" button, and then select the time range you wish to use:
Choice of Display Mode
Determine how the cumulative data will be displayed:
A single value representing the cumulative total for the selected period.
A histogram to visualize the cumulative evolution over the selected period.
To do this, move the slider to select either "Value" or "Histogram":
Note: You can edit the display name of the selected metrics in this component.
Choice of Metric
You can now select the metric to be used by clicking on the "Search for a Metric" button.
The usual metric search window of io-base will open.
Several tabs allow you to search by hierarchy, metadata, or metric name. Once the desired metric is found, click the button to add it. The selected metrics will appear in the table on the right.
You can remove metrics from the right-hand table using the delete icon.
Note : For an integral component, only one metric can be added.
To confirm your selection, click "Select".
A preview of the graph will appear on the right.
To confirm your selection, click "Select".
A preview of the component will appear on the left.
Integration time unit
Next, you need to define the time unit for integration.
This parameter sets the interval over which the data will be aggregated or integrated to produce a cumulative measure. It is essential because it determines how raw data is grouped and used to calculate totals or volumes over a specific period.
For example, if you enter “1h”, the integration will calculate the cumulative total for hourly intervals. This means each cumulative value is based on data collected over the course of an hour.
Add a Coefficient
A coefficient can be applied to the result to obtain an adjusted cumulative total based on your needs.
Using our example : If you want to convert the consumption into euros, you can apply a coefficient corresponding to the unit price of electricity per kWh (e.g., 0.15 €/kWh).
You can specify the coefficient in two ways:
Fixed value: For example, a constant price of 0.15 €/kWh.
Metric: A conversion metric can be used if the price changes over time.
Note : The selected multiplier value will be the average of the values returned by the metric during the selected period.
Modify the Unit
You can modify the unit displayed on the graph.
In our example, we want to express the data in euros.
To do this, simply go to the "Unit" field and enter your desired unit.
Once all the fields are configured, click on "Save":
Your component will appear in the dashboard :
You can modify the selected period to update your component :
Note : Here’s how the display looks in histogram form :
