Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Insights app: add dashboard refresh timer and fix broken refresh button (#2596)

Wouter Voorberg5ca33ba9c2c0
diff --git a/ui/app/insights/src/pages/page-view.ts b/ui/app/insights/src/pages/page-view.ts
index 22c60b35d..754a215c9 100644
--- a/ui/app/insights/src/pages/page-view.ts
+++ b/ui/app/insights/src/pages/page-view.ts
@@ -5,8 +5,8 @@ import {EnhancedStore} from "@reduxjs/toolkit";
import {when} from "lit/directives/when.js";
import {styleMap} from 'lit/directives/style-map.js';
import {guard} from "lit/directives/guard.js";
-import {Dashboard, Realm} from "@openremote/model";
-import {registerWidgetTypes} from "@openremote/or-dashboard-builder";
+import {Dashboard, DashboardRefreshInterval, Realm} from "@openremote/model";
+import {registerWidgetTypes, intervalToMillis, OrDashboardPreview} from "@openremote/or-dashboard-builder";
import manager from "@openremote/core";
import {DashboardMenu} from "../components/dashboard-menu";
import {InputType} from "@openremote/or-mwc-components/or-mwc-input";
@@ -65,9 +65,14 @@ export class PageView extends Page<AppStateKeyed> {
@state() // boolean that is put to true if a fresh render should take place. Similar to the one used in or-dashboard-builder.
private rerenderPending: boolean = false;
+ private _refreshTimer?: ReturnType<typeof setInterval>;
+
@query('#dashboard-menu')
private dashboardMenu: DashboardMenu;
+ @query('or-dashboard-preview')
+ private dashboardPreview?: OrDashboardPreview;
+
static get styles() {
return [style];
}
@@ -112,6 +117,12 @@ export class PageView extends Page<AppStateKeyed> {
this._updateRoute(this._selectedId, !this.viewDashboardOnly, false);
}
+ // Update refresh timer when the selected dashboard changes
+ if(changedProps.has("_selectedId") || changedProps.has("_loadedDashboards")) {
+ const selected = this._loadedDashboards?.find((d) => d.id === this._selectedId);
+ this._setRefreshTimer(intervalToMillis(selected?.template?.refreshInterval || DashboardRefreshInterval.OFF));
+ }
+
// Clear loadedDashboards when people switch between realms or viewing modes.
// For example, if 'view this dashboard only' is active, we only fetch that specific dashboard.
// When switched to 'view all dashboards', or the other way around, we should fetch all dashboard(s) of that realm again.
@@ -228,7 +239,7 @@ export class PageView extends Page<AppStateKeyed> {
`
})}
<div style="flex: 1; ${styleMap(pageStyles)}">
- ${getDashboardHeaderTemplate(!this.viewDashboardOnly, selected, () => this.dashboardMenu?.toggleDrawer(), () => this.rerenderPending = true)}
+ ${getDashboardHeaderTemplate(!this.viewDashboardOnly, selected, () => this.dashboardMenu?.toggleDrawer(), () => this.dashboardPreview?.refreshWidgets())}
<div style="flex: 1;">
${guard([this._selectedId, this._loadedDashboards, this.rerenderPending], () => html`
${when(this._selectedId && selected !== undefined, () => html`
@@ -313,6 +324,27 @@ export class PageView extends Page<AppStateKeyed> {
}
+ disconnectedCallback() {
+ super.disconnectedCallback();
+ this._clearRefreshTimer();
+ }
+
+ protected _setRefreshTimer(millis: number | undefined) {
+ this._clearRefreshTimer();
+ if(millis !== undefined) {
+ this._refreshTimer = setInterval(() => {
+ this.dashboardPreview?.refreshWidgets();
+ }, millis);
+ }
+ }
+
+ protected _clearRefreshTimer() {
+ if(this._refreshTimer) {
+ clearInterval(this._refreshTimer);
+ this._refreshTimer = undefined;
+ }
+ }
+
// Util method for updating URL
protected _updateRoute(id?: string, showMenu?: boolean, silent: boolean = true) {
let path = "view";
@@ -329,6 +361,7 @@ export class PageView extends Page<AppStateKeyed> {
}
function getDashboardHeaderTemplate(showMenu = true, selected?: Dashboard, onopen?: (ev: Event) => void, onrefresh?: (ev: Event) => void): TemplateResult {
+ const refreshInterval = selected?.template?.refreshInterval || DashboardRefreshInterval.OFF;
return html`
<div id="fullscreen-header">
<div id="fullscreen-header-wrapper">
@@ -340,11 +373,13 @@ function getDashboardHeaderTemplate(showMenu = true, selected?: Dashboard, onope
<div id="fullscreen-header-title">
<span>${selected?.displayName}</span>
</div>
- <div>
- <div>
+ <div id="fullscreen-header-actions">
+ <div id="fullscreen-header-actions-content">
<or-mwc-input id="refresh-btn" class="small-btn" .disabled="${(selected == null)}" type="${InputType.BUTTON}" icon="refresh"
@or-mwc-input-changed="${onrefresh}"
></or-mwc-input>
+ <dashboard-refresh-controls .interval="${refreshInterval}" .readonly="${true}"
+ ></dashboard-refresh-controls>
</div>
</div>
</div>
diff --git a/ui/component/or-dashboard-builder/src/index.ts b/ui/component/or-dashboard-builder/src/index.ts
index 63bfd7aca..f95622272 100644
--- a/ui/component/or-dashboard-builder/src/index.ts
+++ b/ui/component/or-dashboard-builder/src/index.ts
@@ -25,6 +25,8 @@ import {WidgetManifest} from "./util/or-widget";
import {ChartWidget} from "./widgets/chart-widget";
import {GaugeWidget} from "./widgets/gauge-widget";
import {IntervalSelectEvent, intervalToMillis} from "./controls/dashboard-refresh-controls";
+export {intervalToMillis} from "./controls/dashboard-refresh-controls";
+export {OrDashboardPreview} from "./or-dashboard-preview";
import {ImageWidget} from "./widgets/image-widget";
import {KpiWidget} from "./widgets/kpi-widget";
import {MapWidget} from "./widgets/map-widget";