Calendar view

A Calendar view shows the report window as a grid of day or hour cells. Each cell can show a value and take its text, background, and border colors from report parameters, for example the daily energy use colored by a fault state. Authors add it with Add calendar under Setup → Reports; viewers open it on the report page.

Settings

Setting	Field	Values	Default
Compact	compact	On or off. Smaller cells.	Off
Show titles	showTitles	On or off. Hover text on each cell.	On
Interactive	interactive	On or off. Clicking a cell sets the report window.	On
Layout	showAs	Month days (month-days), Week days (week-days), Week hours (week-hours), Year days (year-days)	Month days
Day value	dayValueParameter	A numeric report parameter, or None (null)	None
Per-day value	perDayValue	First (first), Latest (latest), Average (average), Delta (delta), Sum (sum), Min (min), Max (max). Shown when Day value is set.	Latest
Decimal places	decimalPlaces	0–12. Shown when Day value is set.	2
Text color	dayTextColorParameter	A numeric or integer report parameter, or None (null)	None
Background color	dayBgColorParameter	A numeric or integer report parameter, or None (null)	None
Border color	dayBorderColorParameter	A numeric or integer report parameter, or None (null)	None

In the API, perDayValue and decimalPlaces sit inside dayValueParameter ({ parameterId, type: "numeric", perDayValue, decimalPlaces }), and each color slot is { parameterId, type } with type numeric or integer. The same parameter can fill more than one slot. Removing a report parameter used here asks for confirmation and clears the slots that used it; the calendar stays.

On the report page

Layouts

The calendar shows only the days or hours that overlap the window; it does not fill out the rest of the month or year. Weeks are ISO weeks starting on Monday. Days of a week outside the window, and hours outside the window, are empty placeholder cells.

Layout	Grid
Month days	One block per month with a YYYY-MM header and weekday labels
Week days	One continuous seven-column grid, each week labeled YYYY-Www
Year days	Rows Monday to Sunday, one column per ISO week, YYYY-MM marks on the week that contains the 1st; scrolls sideways
Week hours	24 columns 00 to 23, one row per day labeled YYYY-MM-DD, grouped by ISO week. When the clock goes back, both 02:00 hours count as hour 2.

Day layouts use local days in the report timezone. The current day counts its completed hours; the open hour and the future are not included. In Week hours, the current and future hours of the window are empty cells.

Values and colors

The day value appears in each cell with its Decimal places and units. Text, background, and border colors are independent. An integer parameter colors the cell with its value color, else its Default color. A numeric parameter uses the zone color that contains the value (zone limits included), else its Default color. A cell without readings for that slot gets no color from it. Backgrounds are a light tint so the day and value stay readable.

With Compact on and no Day value, the calendar is a dot grid without day numbers. Each dot takes the background color, else the text color, else the border color; without any, dots are empty.

Hover and click

With Show titles on, hovering a cell shows YYYY-MM-DD (or YYYY-MM-DD HH:00 in Week hours) and the value with units. Shared snapshots include the same hover text.

With Interactive on, clicking a cell sets the report window to that whole local day, or that hour in Week hours. When the report has Lock time range on, clicks do not navigate; hover text still shows.

Hidden parameters clear the slots that use them. The grid, headers, and labels always show; when every slot is empty or hidden, the calendar shows only the grid. Errors are shown inside the view. The calendar has no live updates or comment markers.

Related

• Report settings
• Report page
• Chart, table, time bars, histogram, hourly matrix, state duration, Sankey
• Readings API: readings.days for day layouts, readings.cadence at 1h for Week hours (readings procedures)