-
Notifications
You must be signed in to change notification settings - Fork 0
User Guide
DigitalRCS edited this page Aug 5, 2026
·
2 revisions
- Open a Grafana dashboard and select Add visualization.
- Choose the datasource and configure its query.
- Select DigitalRCS-TimeOverlay-Panel from the visualization picker.
- Confirm the query returns a Grafana time field and at least one numeric field.
- Save the dashboard.
Series names are taken from the numeric fields returned by the query. They do not need to follow a fixed naming convention. Names such as USTX01, UXVA01, or any other dynamically returned field are supported.
| Control | Behavior |
|---|---|
| Select | Drag horizontally over the plot to zoom to the selected time interval. |
| Zoom in | Reduces the displayed time window by 50 percent around its center. |
| Zoom out | Expands the displayed window by 50 percent without exceeding the original dashboard range. |
| Zoom all | Restores the original dashboard time range. |
| Range | Enables creation of a persistent highlighted duration range. |
| Note | Adds an editable note over the plot. |
| Delete | Removes the currently selected range or note. |
The toolbar is automatically omitted from Grafana render routes used for image and report generation.
- Select Range.
- Drag from the desired start time to the desired end time.
- The highlighted overlay displays the elapsed duration.
- Select and drag the overlay to move it without changing its length.
- Select the overlay and drag either edge handle to adjust its start or end.
- Save the dashboard to persist it.
Duration labels automatically use milliseconds, seconds, minutes, hours, or days as appropriate.
- Select Note.
- Click in the note text area and enter the desired text.
- Drag the note by its header to reposition it.
- Drag its lower-right handle to resize it.
- Save the dashboard to persist it.
Notes use positions and sizes relative to the plot area, helping them remain aligned when the panel is resized or rendered.
When point markers are enabled, hover over a point to display its timestamp and the values for the visible series at that time. The legend uses each numeric field's Grafana display name.
- Ranges, notes, and appearance settings are stored in the panel options inside the dashboard JSON.
- The dashboard must be saved after adding, moving, resizing, editing, or deleting an overlay.
- PNG and PDF output requires a correctly configured Grafana image-renderer or reporting service.
- The renderer must be able to load the same plugin version and reach the same datasources as the Grafana instance.
- Always test the organization's actual export route before relying on it for reporting.
DigitalRCS-TimeOverlay-Panel