100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
UI updates: Migrated or-attribute-history to Apache ECharts (#1700)
Wouter Voorberg86a1a0e10871
diff --git a/ui/component/or-attribute-history/package.json b/ui/component/or-attribute-history/package.jsonindex 2ef816305..c534a4f4c 100644--- a/ui/component/or-attribute-history/package.json+++ b/ui/component/or-attribute-history/package.json@@ -24,12 +24,12 @@"@openremote/or-components": "workspace:*","@openremote/or-mwc-components": "workspace:*","@openremote/or-translate": "workspace:*",+ "echarts": "^5.6.0","jsonpath-plus": "^6.0.1","lit": "^2.0.2"},"devDependencies": {- "@openremote/util": "workspace:*",- "@types/chart.js": "^2.9.34"+ "@openremote/util": "workspace:*"},"publishConfig": {"access": "public"diff --git a/ui/component/or-attribute-history/src/index.ts b/ui/component/or-attribute-history/src/index.tsindex 704529a48..ad66d1163 100644--- a/ui/component/or-attribute-history/src/index.ts+++ b/ui/component/or-attribute-history/src/index.ts@@ -1,6 +1,7 @@// Declare require method which we'll use for importing webpack resources (using ES6 imports will confuse typescript parser)declare function require(name: string): any;-+import {ECharts, EChartsOption, init} from "echarts";+import {debounce} from "lodash";import {css,html,@@ -18,7 +19,6 @@ import "@openremote/or-mwc-components/or-mwc-input";import "@openremote/or-components/or-panel";import "@openremote/or-translate";import "@openremote/or-chart";-import {Chart, ScatterDataPoint, ChartConfiguration, TimeUnit, TimeScaleOptions} from "chart.js";import "chartjs-adapter-moment";import {InputType, OrInputChangedEvent} from "@openremote/or-mwc-components/or-mwc-input";import {MDCDataTable} from "@material/data-table";@@ -109,7 +109,7 @@ const style = css`--internal-or-attribute-history-controls-margin: var(--or-attribute-history-controls-margin, 10px 0);--internal-or-attribute-history-controls-justify-content: var(--or-attribute-history-controls-justify-content, flex-end);--internal-or-attribute-history-graph-fill-color: var(--or-attribute-history-graph-fill-color, var(--or-app-color4, ${unsafeCSS(DefaultColor4)}));- --internal-or-attribute-history-graph-fill-opacity: var(--or-attribute-history-graph-fill-opacity, 1);+ --internal-or-attribute-history-graph-fill-opacity: var(--or-attribute-history-graph-fill-opacity, 0.25);--internal-or-attribute-history-graph-line-color: var(--or-attribute-history-graph-line-color, var(--or-app-color4, ${unsafeCSS(DefaultColor4)}));--internal-or-attribute-history-graph-point-color: var(--or-attribute-history-graph-point-color, var(--or-app-color4, ${unsafeCSS(DefaultColor4)}));--internal-or-attribute-history-graph-point-border-color: var(--or-attribute-history-graph-point-border-color, var(--or-app-color4, ${unsafeCSS(DefaultColor4)}));@@ -164,7 +164,7 @@ const style = css`}#time-picker {- width: 150px;+ width: 130px;padding: 0 5px;}@@ -180,13 +180,18 @@ const style = css`}#ending-date {- width: 200px;+ width: 220px;padding-left: 5px;}+ #chart {+ width: 100%;+ height: 100%;+ }+#chart-container {position: relative;- min-height: 250px;+ min-height: 350px;}#table-container {@@ -254,21 +259,23 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {protected _tableTemplate?: TemplateResult;@query("#chart")- protected _chartElem!: HTMLCanvasElement;+ protected _chartElem!: HTMLDivElement;+ protected _chartOptions: EChartsOption = {};@query("#table")protected _tableElem!: HTMLDivElement;protected _table?: MDCDataTable;- protected _chart?: Chart<"line", ScatterDataPoint[]>;+ protected _chart?: ECharts;protected _type?: ValueDescriptor;protected _style!: CSSStyleDeclaration;protected _error?: string;protected _startOfPeriod?: number;protected _endOfPeriod?: number;- protected _timeUnits?: TimeUnit;- protected _stepSize?: number;+ protected _queryStartOfPeriod?: number;+ protected _queryEndOfPeriod?: number;protected _updateTimestampTimer?: number;protected _dataAbortController?: AbortController;-+ protected _zoomChanged: boolean = false;+ protected _zoomReset: boolean = false;protected _dataFirstLoaded: boolean = false;connectedCallback() {@@ -305,6 +312,8 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {this._type = undefined;this._data = undefined;this._loadData();+ this._zoomReset = true; //Flag to avoid retrigger of loadData from zoom eventlistener triggered by next line.+ this._chart?.dispatchAction({type: 'dataZoom', start: 0, end: 100})}return super.shouldUpdate(_changedProperties);@@ -337,11 +346,11 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {</div>`, () => when(isChart, () => html`- ${when(this._loading, () => html`+ ${when((this._loading && !this._data), () => html`<or-loading-indicator style="position: absolute; top: 50%; left: 50%;"></or-loading-indicator>`)}- <div id="chart-container" style="${this._loading ? 'opacity: 0.2' : undefined}">- <canvas id="chart"></canvas>+ <div id="chart-container" style="${this._loading ? 'opacity: 0.7' : undefined}">+ <div id="chart"></div></div>`, () => html`@@ -368,7 +377,8 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {const isChart = this._type && (this._type.jsonType === "number" || this._type.jsonType === "boolean");if (isChart) {- const data = this._data as ScatterDataPoint[];++ const data = this._data.map(point => [point.x, point.y]);if (!this._chart) {let bgColor = this._style.getPropertyValue("--internal-or-attribute-history-graph-fill-color").trim();@@ -381,90 +391,137 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {}}- const options = {- type: "line",- data: {- datasets: [- {- data: data,- backgroundColor: bgColor,- borderColor: this._style.getPropertyValue("--internal-or-attribute-history-graph-line-color"),- pointBorderColor: this._style.getPropertyValue("--internal-or-attribute-history-graph-point-border-color"),- pointBackgroundColor: this._style.getPropertyValue("--internal-or-attribute-history-graph-point-color"),- pointRadius: Number(this._style.getPropertyValue("--internal-or-attribute-history-graph-point-radius")),- pointBorderWidth: Number(this._style.getPropertyValue("--internal-or-attribute-history-graph-point-border-width")),- pointHoverBackgroundColor: this._style.getPropertyValue("--internal-or-attribute-history-graph-point-hover-color"),- pointHoverBorderColor: this._style.getPropertyValue("--internal-or-attribute-history-graph-point-hover-border-color"),- pointHoverRadius: Number(this._style.getPropertyValue("--internal-or-attribute-history-graph-point-hover-radius")),- pointHoverBorderWidth: Number(this._style.getPropertyValue("--internal-or-attribute-history-graph-point-hover-border-width")),- pointHitRadius: Number(this._style.getPropertyValue("--internal-or-attribute-history-graph-point-hit-radius")),- fill: false+ this._chartOptions = {+ animation: false,+ grid: {+ show: true,+ backgroundColor: this._style.getPropertyValue("--internal-or-asset-viewer-panel-color"),+ borderColor: this._style.getPropertyValue("--internal-or-attribute-history-text-color"),+ left: 4,+ right: 4,+ containLabel: true+ },+ backgroundColor: this._style.getPropertyValue("--internal-or-asset-viewer-panel-color"),+ tooltip: {+ trigger: 'axis',+ confine: true,+ axisPointer: { type: 'cross'},+ formatter: (params: any) => {+ if (Array.isArray(params) && params.length > 0) {+ const yValue = params[0].value[1];+ return yValue !== undefined ? yValue.toString() : '';+ }+ return ''}- ]},- options: {- responsive: true,- maintainAspectRatio: false,- onResize:() => this.dispatchEvent(new OrAttributeHistoryEvent('resize')),- plugins: {- legend: {- display: false+ toolbox: {+ right: '2%',+ top: '5%',+ feature: {+ dataView: {readOnly: true},+ saveAsImage: {+ name: ['History', this.assetId, this.attribute?.name, `${moment(this._startOfPeriod).format("DD-MM-YYYY HH:mm")} - ${moment(this._endOfPeriod).format("DD-MM-YYYY HH:mm")}`]+ .filter(Boolean)+ .join(' ')},- tooltip: {- displayColors: false,- xPadding: 10,- yPadding: 10,- titleMarginBottom: 10+ }+ },+ xAxis: {+ type: 'time',+ axisLine: { onZero: false, lineStyle: {color: this._style.getPropertyValue("--internal-or-attribute-history-text-color")}},+ splitLine: {show:true},+ min: this._startOfPeriod,+ max: this._endOfPeriod,+ axisLabel: {+ hideOverlap: true,+ fontSize: 10,+ formatter: {+ year: '{yyyy}-{MMM}',+ month: '{yy}-{MMM}',+ day: '{d}-{MMM}',+ hour: '{HH}:{mm}',+ minute: '{HH}:{mm}',+ second: '{HH}:{mm}:{ss}',+ millisecond: '{d}-{MMM} {HH}:{mm}',+ // @ts-ignore+ none: '{MMM}-{dd} {HH}:{mm}'}+ }+ },+ yAxis:+ {+ type: 'value',+ axisLine: { lineStyle: {color: this._style.getPropertyValue("--internal-or-attribute-history-text-color")}},+ boundaryGap: ['10%', '10%'],+ scale: true+ },+ dataZoom: [+ {+ type: 'inside',+ start: 0,+ end: 100},- scales: {- y: {- beginAtZero: true,- grid: {- color: "#cccccc"+ {+ start: 0,+ end: 100,+ backgroundColor: bgColor,+ fillerColor: bgColor,+ dataBackground: {+ areaStyle: {+ color: this._style.getPropertyValue("--internal-or-attribute-history-graph-fill-color")}},- x: {- type: "time",- min: this._startOfPeriod,- max: this._endOfPeriod,- time: {- tooltipFormat: 'MMM D, YYYY, HH:mm:ss',- displayFormats: {- millisecond: 'HH:mm:ss.SSS',- second: 'HH:mm:ss',- minute: "HH:mm",- hour: "HH:mm",- week: "w"- },- unit: this._timeUnits,- stepSize: this._stepSize- },- ticks: {- color: "#000",- font: {- family: "'Open Sans', Helvetica, Arial, Lucida, sans-serif",- size: 9,- style: "normal"- }+ selectedDataBackground: {+ areaStyle: {+ color: this._style.getPropertyValue("--internal-or-attribute-history-graph-fill-color"),+ }+ },+ moveHandleStyle: {+ color: this._style.getPropertyValue("--internal-or-attribute-history-graph-fill-color")+ },+ emphasis: {+ moveHandleStyle: {+ color: this._style.getPropertyValue("--internal-or-attribute-history-graph-fill-color")},- gridLines: {- color: "#cccccc"+ handleLabel: {+ show: true}+ },+ handleLabel: {+ show: false+ },+ showDetail: false+ }++ ],+ series: [+ {+ name: 'timestamp value',+ type: 'line',+ showSymbol: data.length <= 30,+ data: data,+ sampling: 'lttb',+ itemStyle: {+ color: this._style.getPropertyValue("--internal-or-attribute-history-graph-line-color")}}- }- } as ChartConfiguration<"line", ScatterDataPoint[]>;+ ]+ }+ // Initialize echarts instance+ this._chart = init(this._chartElem);+ // Set chart options to default+ this._chart.setOption(this._chartOptions);+ // Make chart size responsive+ window.addEventListener("resize", () => this._chart?.resize());+ const resizeObserver = new ResizeObserver(() => this._chart?.resize());+ resizeObserver.observe(this._chartElem);+ // Add event listener for zooming+ this._chart!.on('datazoom', debounce((params: any) => { this._onZoomChange(params); }, 750));- this._chart = new Chart<"line", ScatterDataPoint[]>(this._chartElem.getContext("2d")!, options);} else {if (changedProperties.has("_data")) {- this._chart.options.scales!.x!.min = this._startOfPeriod;- this._chart.options!.scales!.x!.max = this._endOfPeriod;- (this._chart.options!.scales!.x! as TimeScaleOptions).time!.unit = this._timeUnits!;- (this._chart.options!.scales!.x! as TimeScaleOptions).time!.stepSize = this._stepSize!;- this._chart.data.datasets![0].data = data;- this._chart.update();+ //Update chart to data from set period+ this._updateChartData();}}} else {@@ -488,7 +545,7 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {this._tableTemplate = undefined;if (this._chart) {- this._chart.destroy();+ this._chart.dispose();this._chart = undefined;}if (this._table) {@@ -660,8 +717,8 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {];}- protected async _loadData() {- if (this._data || !this.assetType || !this.assetId || (!this.attribute && !this.attributeRef) || !this.period || !this.toTimestamp) {+ protected async _loadData() {+ if ( (this._data && !this._zoomChanged) || !this.assetType || !this.assetId || (!this.attribute && !this.attributeRef) || !this.period || !this.toTimestamp) {return;}@@ -712,36 +769,34 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {let interval: DatapointInterval = DatapointInterval.HOUR;- let stepSize = 1;switch (this.period) {case "hour":interval = DatapointInterval.MINUTE;- stepSize = 5;break;case "day":interval = DatapointInterval.HOUR;- stepSize = 1;break;case "week":interval = DatapointInterval.HOUR;- stepSize = 6;break;case "month":interval = DatapointInterval.DAY;- stepSize = 1;break;case "year":interval = DatapointInterval.MONTH;- stepSize = 1;break;}const lowerCaseInterval = interval.toLowerCase();- this._startOfPeriod = moment(this.toTimestamp).subtract(1, this.period).startOf(lowerCaseInterval as moment.unitOfTime.StartOf).add(1, lowerCaseInterval as moment.unitOfTime.Base).toDate().getTime();- this._endOfPeriod = moment(this.toTimestamp).startOf(lowerCaseInterval as moment.unitOfTime.StartOf).add(1, lowerCaseInterval as moment.unitOfTime.Base).toDate().getTime();- this._timeUnits = lowerCaseInterval as TimeUnit;- this._stepSize = stepSize;++ if (!this._zoomChanged) {+ // Set start and end of period based on the selected period+ this._startOfPeriod = moment(this.toTimestamp).subtract(1, this.period).startOf(lowerCaseInterval as moment.unitOfTime.StartOf).add(1, lowerCaseInterval as moment.unitOfTime.Base).toDate().getTime();+ this._endOfPeriod = moment(this.toTimestamp).startOf(lowerCaseInterval as moment.unitOfTime.StartOf).add(1, lowerCaseInterval as moment.unitOfTime.Base).toDate().getTime();+ this._queryStartOfPeriod = this._startOfPeriod;+ this._queryEndOfPeriod = this._endOfPeriod;+ }const isChart = this._type && (this._type.jsonType === "number" || this._type.jsonType === "boolean");let response;@@ -751,8 +806,8 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {attributeName,{type: "lttb",- fromTimestamp: this._startOfPeriod,- toTimestamp: this._endOfPeriod,+ fromTimestamp: this._queryStartOfPeriod,+ toTimestamp: this._queryEndOfPeriod,amountOfPoints: 100},{ signal: this._dataAbortController.signal }@@ -769,12 +824,13 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {{ signal: this._dataAbortController.signal });}-this._loading = false;+ this._zoomChanged = false;if (response.status === 200) {- this._data = response.data.filter(value => value.y !== null && value.y !== undefined) as ScatterDataPoint[];- this._dataFirstLoaded = true;+ this._data = response.data+ .filter(value => value.y !== null && value.y !== undefined)+ .map(point => ({ x: point.x, y: point.y } as ValueDatapoint<any>));}} catch (ex) {@@ -812,6 +868,35 @@ export class OrAttributeHistory extends translate(i18next)(LitElement) {this.toTimestamp = newMoment.toDate()}, timeout);}-++ protected _onZoomChange(params: any) {+ if (!this._zoomReset) {+ this._zoomChanged = true;+ const {start: zoomStartPercentage, end: zoomEndPercentage} = params.batch?.[0] ?? params; // Events triggered by scroll and zoombar return different structures+ //Define the start and end of the period based on the zoomed area+ this._queryStartOfPeriod = this._startOfPeriod! + ((this._endOfPeriod! - this._startOfPeriod!) * zoomStartPercentage / 100);+ this._queryEndOfPeriod = this._startOfPeriod! + ((this._endOfPeriod! - this._startOfPeriod!) * zoomEndPercentage / 100);++ this._loadData().then(() => {+ this._updateChartData()+ });+ }+ this._zoomReset = false;+ }++ protected _updateChartData(){+ const data = this._data!.map(point => [point.x, point.y]);++ this._chart!.setOption({+ xAxis: {+ min: this._startOfPeriod,+ max: this._endOfPeriod+ },+ series: [{+ data: data,+ showSymbol: data.length <= 30+ }]+ });+ }}diff --git a/yarn.lock b/yarn.lockindex a7846713c..2577c3f57 100644--- a/yarn.lock+++ b/yarn.lock@@ -2556,7 +2556,7 @@ __metadata:"@openremote/or-mwc-components": "workspace:*""@openremote/or-translate": "workspace:*""@openremote/util": "workspace:*"- "@types/chart.js": "npm:^2.9.34"+ echarts: "npm:^5.6.0"jsonpath-plus: "npm:^6.0.1"lit: "npm:^2.0.2"languageName: unknown@@ -4994,6 +4994,16 @@ __metadata:languageName: nodelinkType: hard+"echarts@npm:^5.6.0":+ version: 5.6.0+ resolution: "echarts@npm:5.6.0"+ dependencies:+ tslib: "npm:2.3.0"+ zrender: "npm:5.6.1"+ checksum: 10c0/6d6a2ee88534d1ff0433e935c542237b9896de1c94959f47ebc7e0e9da26f59bf11c91ed6fc135b62ad2786c779ee12bc536fa481e60532dad5b6a2f5167e9ea+ languageName: node+ linkType: hard+"ee-first@npm:1.1.1":version: 1.1.1resolution: "ee-first@npm:1.1.1"@@ -9604,6 +9614,13 @@ __metadata:languageName: nodelinkType: hard+"tslib@npm:2.3.0":+ version: 2.3.0+ resolution: "tslib@npm:2.3.0"+ checksum: 10c0/a845aed84e7e7dbb4c774582da60d7030ea39d67307250442d35c4c5dd77e4b44007098c37dd079e100029c76055f2a362734b8442ba828f8cc934f15ed9be61+ languageName: node+ linkType: hard+"tslib@npm:^1.10.0, tslib@npm:^1.8.1, tslib@npm:^1.9.3":version: 1.14.1resolution: "tslib@npm:1.14.1"@@ -10301,3 +10318,12 @@ __metadata:checksum: 10c0/dceb44c28578b31641e13695d200d34ec4ab3966a5729814d5445b194933c096b7ced71494ce53a0e8820685d1d010df8b2422e5bf2cdea7e469d97ffbea306flanguageName: nodelinkType: hard++"zrender@npm:5.6.1":+ version: 5.6.1+ resolution: "zrender@npm:5.6.1"+ dependencies:+ tslib: "npm:2.3.0"+ checksum: 10c0/dc1cc570054640cbd8fbb7b92e6252f225319522bfe3e8dc8bf02cc02d414e00a4c8d0a6f89bfc9d96e5e9511fdca94dd3d06bf53690df2b2f12b0fc560ac307+ languageName: node+ linkType: hard