HeatMap

Used as

• Card

 

Summary

This card displays a heatmap based on a period. It takes only one history, if there is more than one history it will take the first one.

 

Implementation

• Add a card from the settings bar, and choose in the list Heatmap
• Fill-in a title
• You can leave blank the selection and drag&drop an history from the nav tree (not in edition mode)
• Or you can select the query to retrieve the records from. The query should be in a Selection from the BtibService. There are two types of queries you can make:
  • On histories. Example: station:|history:|select id where dimension = 'Energy'
  • On extensions (absolute or relative). Example: slot:|bql: select * from history:HistoryExt
    
• Select a default Time Range to apply. TimeRange are set up in the BtibService.

The system will choose the right aggregation, the right type of charts, the right color automatically based on tags. To prepare your data for it, you can follow this tutorial: Configuring General Resources for histories

When the FlexView isn't in Edit mode, it is possible to drag and drop an history, a point or an historyExtension from the navigation tree to visualize the values from the history. After a refresh, the drag & dropped values will no longer been displayed.

Flex Widget Properties

• Title: The title of the card
   SFormat is supported.
• HistoryDefaultSelection: A list of selection retrieved from the Selection folder in the BtibService. The selection needs to target histories (history:) or historyExtensions (slot:)
• HistorySelectionPolicy: 
  • Stand Alone: The card will use the default history selection
  • Slave: The history selection is given by another card like the HistoryListSelector
• TimeRangeDefaultSelection: The default period (a TimeRangeDefinition) applied on the first display. If nothing is provided, it will display the last 24 hours
• TimeRangePolicy: 
  • Stand Alone: The widget displays a dropdown to select a period (month to date, last year...)
  • Slave: The period is given by another widget like a period selector.
• HeatmapType: 
  • DailyAnalysis: Make an aggregation for each day of the year over the years based on the selected period
  • WeekDayAnalysis: Make an aggregation for each weekday based on the selected period
• Time Limit:
  • Start Time: starting time of the day to display data (export will contain everything)
  • End Time: ending time of the day to display data
• PlotBands: Color to apply for a particular range. Make sure to fill them with good values to have a good rendering.
  
• AutomaticLegend: whether to activate the automatic legend based on the minimum and maximum displayed values
• MinInfColor: The minimum value associated color for the automated legend
• MaxInfColor: The maximum value associated color for the automated legend
• Export Date Format: Date format when exporting in csv (%Y-%m-%d %H:%M:%S by default)
  
• Chart Background: Background color of the chart
• Legend Foreground: Foreground of legends and axis
• Tooltip Foreground: Foreground color for the tooltip displayed on the chart

Export feature:

Additional Features

You can drag&drop an history from the nav tree (both Workbench and Web browser) to create a new chart. In this case the new history isn't saved after refreshing the page.