Time bars view
A Time bars view draws one bar per completed time interval for numeric parameters, for example
energy used per hour. Bars follow each other in time, each starting at its interval start. To
average repeating slots such as hours of the day instead, use the histogram.
Authors add it with Add time bars under Setup → Reports; its key and API
type are time-buckets. Viewers open it on the report page.
Settings
Section titled “Settings”| Setting | Field | Values | Default |
|---|---|---|---|
| Height | height | Main plot height in pixels, 40–4000. The navigation strip adds 56 px below it. | 280 |
| Legend | legend | None (none), Non-interactive (non-interactive), Interactive (interactive) | Interactive |
| Show tooltips | showTooltips | On or off | On |
| Chart display | chartDisplay | Fixed (frozen), Movable (movable) | Movable |
| Navigation strip | navStrip | None (none), Fixed (frozen), Movable (movable) | Movable |
| Time interval | cadence | 1m, 5m, 15m, 30m, 1h, 4h, 1d | 1h |
| Display as | displayAs | Grouped bars (neighbour-bars), Stacked bars (stacked-bars), Stacked fills (stacked-fills) | Grouped bars |
Grouped bars stand side by side in parameter order, left to right. Stacked bars and fills stack in parameter order, bottom to top. Comments always show above the plot; there is no setting for them.
A 4h bar covers four consecutive completed hours aligned to whole hours.
Parameters
Section titled “Parameters”Under Parameters, Add numeric parameters lists numeric report parameters that are not already in this view; each can appear once. Move up and Move down reorder them.
| Setting | Field | Values | Default |
|---|---|---|---|
| Value per interval | perCadenceValue | First (first), Latest (latest), Average (average), Delta (delta), Sum (sum), Min (min), Max (max) | Delta |
| Decimal places | decimalPlaces | 0–12 | 2 |
| Scale multiplier | scaleMultiplier | Any number | 1 |
| Scale shift | scaleShift | Any number | 0 |
Delta is the latest value in this interval minus the latest value in the previous interval of the same length. When the previous interval has no readings, the first value of this interval is used instead. For a counter such as an energy meter, Delta is the amount counted in each interval.
Removing a report parameter used here asks for confirmation and removes it from the view; an empty view stays.
On the report page
Section titled “On the report page”Bars and detail
Section titled “Bars and detail”Each completed interval with readings is one bar or stack segment. An interval without readings is a gap, not zero. The interval that is still open is not shown. The Y axis always includes zero.
When the visible window holds fewer than 1000 intervals of the chosen Time interval, the view shows one bar per interval. Wider windows, and the parts of the data range outside the window, show one bar per local day (the current day counts its completed hours). The Y axis fits the bars that start in the window.
Moving through time
Section titled “Moving through time”With Movable display and an unlocked time range, dragging pans the window and the mouse wheel zooms around the cursor, down to one interval. The window can extend past the data. A click that is not a drag sets the report window to that bar: one interval, or one local day for a daily bar. If that day holds 1000 or more intervals, the window becomes 1000 intervals centered on the click. Clicking stops following the current time.
The navigation strip shows the daily bars of the whole data range. It works as on the chart: shown unless None, 56 px below the plot, a shaded overlay for the window, selection with Movable, and Movable acting as Fixed when the report has Lock time range on. Shared snapshots leave the strip out.
Legend, tooltips, colors
Section titled “Legend, tooltips, colors”The legend sits below the plot, above the navigation strip, and shows a swatch, label, and units. With Interactive, clicking a parameter hides or shows it in every view of the report. Tooltips show the interval start and each visible value in its own units with its Decimal places, without scale multiplier or shift. Bars use the parameter’s Default color; zone colors are not used.
Scale multiplier and Scale shift change only the drawing; tooltips and CSV export keep the original values. The view does not receive live values.
Comments and errors
Section titled “Comments and errors”Comments that overlap the window show as stripes above the plot, as on the chart. Errors are shown inside the view.
Related
Section titled “Related”- Report settings
- Report page
- Chart, table, histogram, calendar, hourly matrix, state duration, Sankey
- Comments
- Readings API:
readings.cadence,readings.days,readings.timeExtent(readings procedures)