Heatmap Calendar

The Calendar Heatmap control allows you to view a single dataset from a single type of measurement as a coloured calendar. To configure this shortcode, you must specify the following settings:

  • Period type and Period: hese two parameters are used to specify the display time period. When the period type is set to a fixed period, the period you specify will always be the same regardless of the display conditions. On the other hand, when the period type is set to a sliding period, the period you specify will be relative to the current date. For example, to display the chart that always matches the previous season (relative to the current date), choose “Sliding Season” and “Season – 1”. For daily charts, these settings are not visible: the display time period is always the current day.
  • Module: just select a module attached to your station, it must be a real or a virtual module (identified by a name in square brackets).
  • Measurement: select from a list of all available measurement types.
  • Dataset: choose here the dataset related to the compilation operation.
  • Mode: choice of the display for the data series.
  • Values display: allows you to materialize each value of the series by a dot or a circle.
  • Line style and Line size: when the mode is “Line” or “Array and Line”, you can fine-tune the line layout settings.
  • Template: this is the chart layout template, choose “Neutral” for a template to be formatted by yourself via CSS, or choose a predefined template.
  • Color scheme: specifies the colors to use for lines and surfaces. These color sets all use the ColorBrewer standard developed by Cynthia Brewer except, of course, the one that is specific to the template.
  • Color thresholds: specifies the number of steps to use.
  • Day format: indicates that the color markers indicating the values will be squared, squared with rounded corner or a circle.
  • Legend: allows you to position the legend at different points of the control.
  • Height: the height starts at XS (150 pixels) up to XL (555 pixels).
  • Value Scale: Specify how the Y axis scales of the graph behave.
  • Data: the data loading setting specifies how the control accesses the data it displays. “Inline” indicates that the data is loaded inside the page source (this data will be refreshed only when the page is refreshed). “Ajax Preload” gives the control the ability to load data via ajax, but it will not attempt to refresh them on a regular basis. “Ajax Refresh” allows the control to refresh regularly the data it displays.
Shortcode for Calendar Heatmap

   After you have set the parameters as you wish, click on the "copy" button then paste the shortcode into the page or the post, where you want the control to appear.

d

Displayable Data

This chart displays historical values.

Refreshing Mode

Refresh occurs at page load (with or without ajax preload) or automatically every 1 hour.